software.amazon.awscdk.services.macie

Class CfnSession

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.macie.CfnSession

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.747Z")
 @Stability(value=Stable)
public class CfnSession
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Macie::Session`.

The AWS::Macie::Session resource represents the Amazon Macie service and configuration settings for an account. A Session is created for each AWS Region in which you enable Macie .

You must create a Session for an account before you can create an AWS::Macie::FindingsFilter or AWS::Macie::CustomDataIdentifier resource. Use a DependsOn attribute to ensure that the Session is created before the other resources. 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSession.Builder A fluent builder for CfnSession.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSession(software.constructs.Construct scope, String id) Create a new `AWS::Macie::Session`.
	CfnSession(software.constructs.Construct scope, String id, CfnSessionProps props) Create a new `AWS::Macie::Session`.
protected	CfnSession(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSession(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAwsAccountId() The account ID for the AWS account in which the `Session` is created.
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.
protected Map<String,Object>	getCfnProperties()
String	getFindingPublishingFrequency() The frequency with which Amazon Macie publishes updates to policy findings for an account.
String	getStatus() The `MacieStatus` of the `Session` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFindingPublishingFrequency(String value) The frequency with which Amazon Macie publishes updates to policy findings for an account.
void	setStatus(String value) The `MacieStatus` of the `Session` .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSession

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

CfnSession

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

CfnSession

@Stability(value=Stable)
public CfnSession(@NotNull
                                           software.constructs.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(value=Stable)
public CfnSession(@NotNull
                                           software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrAwsAccountId()

The account ID for the AWS account in which the `Session` is created.

getAttrServiceRole

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFindingPublishingFrequency

@Stability(value=Stable)
 @Nullable
public String getFindingPublishingFrequency()

The frequency with which Amazon Macie publishes updates to policy findings for an account.

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

• FIFTEEN_MINUTES
• ONE_HOUR
• SIX_HOURS

setFindingPublishingFrequency

@Stability(value=Stable)
public void setFindingPublishingFrequency(@Nullable
                                                                   String value)

The frequency with which Amazon Macie publishes updates to policy findings for an account.

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

• FIFTEEN_MINUTES
• ONE_HOUR
• SIX_HOURS

getStatus

@Stability(value=Stable)
 @Nullable
public String getStatus()

The `MacieStatus` of the `Session` .

Valid values include ENABLED and PAUSED .

setStatus

@Stability(value=Stable)
public void setStatus(@Nullable
                                               String value)

The `MacieStatus` of the `Session` .

Valid values include ENABLED and PAUSED .