Package software.amazon.awscdk.services.macie

Class CfnSession

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.macie.CfnSession
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.851Z") @Stability(Stable) public class CfnSession extends CfnResource implements IInspectable
A CloudFormation AWS::Macie::Session.

The AWS::Macie::Session resource represents the Amazon Macie service and certain configuration settings for an Amazon Macie account in a specific AWS Region . It enables Macie to become operational for a specific account in a specific Region. An account can have only one session in each Region.

You must create an AWS::Macie::Session resource for an account before you can create other types of resources for the account. Use a DependsOn attribute to ensure that an AWS::Macie::Session resource is created before other Macie resources are created for an account. For example, "DependsOn": "Session" .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.macie.*;
 CfnSession cfnSession = CfnSession.Builder.create(this, "MyCfnSession")
         .findingPublishingFrequency("findingPublishingFrequency")
         .status("status")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSession

      protected CfnSession(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSession

      protected CfnSession(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSession

      @Stability(Stable) public CfnSession(@NotNull Construct scope, @NotNull String id, @Nullable CfnSessionProps props)
      Create a new AWS::Macie::Session.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnSession

      @Stability(Stable) public CfnSession(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Macie::Session.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAwsAccountId

      @Stability(Stable) @NotNull public String getAttrAwsAccountId()
      The account ID for the AWS account in which the Amazon Macie session is created.

    • getAttrServiceRole

      @Stability(Stable) @NotNull public String getAttrServiceRole()
      The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in AWS resources for the account.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFindingPublishingFrequency

      @Stability(Stable) @Nullable public String getFindingPublishingFrequency()
      Specifies how often Amazon Macie publishes updates to policy findings for the account.

      This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events ). Valid values are:

      • FIFTEEN_MINUTES
      • ONE_HOUR
      • SIX_HOURS

    • setFindingPublishingFrequency

      @Stability(Stable) public void setFindingPublishingFrequency(@Nullable String value)
      Specifies how often Amazon Macie publishes updates to policy findings for the account.

      This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events ). Valid values are:

      • FIFTEEN_MINUTES
      • ONE_HOUR
      • SIX_HOURS

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of Amazon Macie for the account.

      Valid values are: ENABLED , start or resume all Macie activities for the account; and, PAUSED , suspend all Macie activities for the account.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of Amazon Macie for the account.

      Valid values are: ENABLED , start or resume all Macie activities for the account; and, PAUSED , suspend all Macie activities for the account.