CfnTrail L1 construct
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudtrail as cloudtrail } from 'aws-cdk-lib';
const cfnTrail = new cloudtrail.CfnTrail(this, 'MyCfnTrail', {
isLogging: false,
s3BucketName: 's3BucketName',
// the properties below are optional
advancedEventSelectors: [{
fieldSelectors: [{
field: 'field',
// the properties below are optional
endsWith: ['endsWith'],
equalTo: ['equalTo'],
notEndsWith: ['notEndsWith'],
notEquals: ['notEquals'],
notStartsWith: ['notStartsWith'],
startsWith: ['startsWith'],
}],
// the properties below are optional
name: 'name',
}],
aggregationConfigurations: [{
eventCategory: 'eventCategory',
templates: ['templates'],
}],
cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
enableLogFileValidation: false,
eventSelectors: [{
dataResources: [{
type: 'type',
// the properties below are optional
values: ['values'],
}],
excludeManagementEventSources: ['excludeManagementEventSources'],
includeManagementEvents: false,
readWriteType: 'readWriteType',
}],
includeGlobalServiceEvents: false,
insightSelectors: [{
eventCategories: ['eventCategories'],
insightType: 'insightType',
}],
isMultiRegionTrail: false,
isOrganizationTrail: false,
kmsKeyId: 'kmsKeyId',
s3KeyPrefix: 's3KeyPrefix',
snsTopicName: 'snsTopicName',
tags: [{
key: 'key',
value: 'value',
}],
trailName: 'trailName',
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudtrail as cloudtrail
cfn_trail = cloudtrail.CfnTrail(self, "MyCfnTrail",
is_logging=False,
s3_bucket_name="s3BucketName",
# the properties below are optional
advanced_event_selectors=[cloudtrail.CfnTrail.AdvancedEventSelectorProperty(
field_selectors=[cloudtrail.CfnTrail.AdvancedFieldSelectorProperty(
field="field",
# the properties below are optional
ends_with=["endsWith"],
equal_to=["equalTo"],
not_ends_with=["notEndsWith"],
not_equals=["notEquals"],
not_starts_with=["notStartsWith"],
starts_with=["startsWith"]
)],
# the properties below are optional
name="name"
)],
aggregation_configurations=[cloudtrail.CfnTrail.AggregationConfigurationProperty(
event_category="eventCategory",
templates=["templates"]
)],
cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
enable_log_file_validation=False,
event_selectors=[cloudtrail.CfnTrail.EventSelectorProperty(
data_resources=[cloudtrail.CfnTrail.DataResourceProperty(
type="type",
# the properties below are optional
values=["values"]
)],
exclude_management_event_sources=["excludeManagementEventSources"],
include_management_events=False,
read_write_type="readWriteType"
)],
include_global_service_events=False,
insight_selectors=[cloudtrail.CfnTrail.InsightSelectorProperty(
event_categories=["eventCategories"],
insight_type="insightType"
)],
is_multi_region_trail=False,
is_organization_trail=False,
kms_key_id="kmsKeyId",
s3_key_prefix="s3KeyPrefix",
sns_topic_name="snsTopicName",
tags=[CfnTag(
key="key",
value="value"
)],
trail_name="trailName"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudtrail.*;
CfnTrail cfnTrail = CfnTrail.Builder.create(this, "MyCfnTrail")
.isLogging(false)
.s3BucketName("s3BucketName")
// the properties below are optional
.advancedEventSelectors(List.of(AdvancedEventSelectorProperty.builder()
.fieldSelectors(List.of(AdvancedFieldSelectorProperty.builder()
.field("field")
// the properties below are optional
.endsWith(List.of("endsWith"))
.equalTo(List.of("equalTo"))
.notEndsWith(List.of("notEndsWith"))
.notEquals(List.of("notEquals"))
.notStartsWith(List.of("notStartsWith"))
.startsWith(List.of("startsWith"))
.build()))
// the properties below are optional
.name("name")
.build()))
.aggregationConfigurations(List.of(AggregationConfigurationProperty.builder()
.eventCategory("eventCategory")
.templates(List.of("templates"))
.build()))
.cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
.cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
.enableLogFileValidation(false)
.eventSelectors(List.of(EventSelectorProperty.builder()
.dataResources(List.of(DataResourceProperty.builder()
.type("type")
// the properties below are optional
.values(List.of("values"))
.build()))
.excludeManagementEventSources(List.of("excludeManagementEventSources"))
.includeManagementEvents(false)
.readWriteType("readWriteType")
.build()))
.includeGlobalServiceEvents(false)
.insightSelectors(List.of(InsightSelectorProperty.builder()
.eventCategories(List.of("eventCategories"))
.insightType("insightType")
.build()))
.isMultiRegionTrail(false)
.isOrganizationTrail(false)
.kmsKeyId("kmsKeyId")
.s3KeyPrefix("s3KeyPrefix")
.snsTopicName("snsTopicName")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.trailName("trailName")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudTrail;
var cfnTrail = new CfnTrail(this, "MyCfnTrail", new CfnTrailProps {
IsLogging = false,
S3BucketName = "s3BucketName",
// the properties below are optional
AdvancedEventSelectors = new [] { new AdvancedEventSelectorProperty {
FieldSelectors = new [] { new AdvancedFieldSelectorProperty {
Field = "field",
// the properties below are optional
EndsWith = new [] { "endsWith" },
EqualTo = new [] { "equalTo" },
NotEndsWith = new [] { "notEndsWith" },
NotEquals = new [] { "notEquals" },
NotStartsWith = new [] { "notStartsWith" },
StartsWith = new [] { "startsWith" }
} },
// the properties below are optional
Name = "name"
} },
AggregationConfigurations = new [] { new AggregationConfigurationProperty {
EventCategory = "eventCategory",
Templates = new [] { "templates" }
} },
CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
EnableLogFileValidation = false,
EventSelectors = new [] { new EventSelectorProperty {
DataResources = new [] { new DataResourceProperty {
Type = "type",
// the properties below are optional
Values = new [] { "values" }
} },
ExcludeManagementEventSources = new [] { "excludeManagementEventSources" },
IncludeManagementEvents = false,
ReadWriteType = "readWriteType"
} },
IncludeGlobalServiceEvents = false,
InsightSelectors = new [] { new InsightSelectorProperty {
EventCategories = new [] { "eventCategories" },
InsightType = "insightType"
} },
IsMultiRegionTrail = false,
IsOrganizationTrail = false,
KmsKeyId = "kmsKeyId",
S3KeyPrefix = "s3KeyPrefix",
SnsTopicName = "snsTopicName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TrailName = "trailName"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnTrail := awscdk.Aws_cloudtrail.NewCfnTrail(this, jsii.String("MyCfnTrail"), &CfnTrailProps{
IsLogging: jsii.Boolean(false),
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
AdvancedEventSelectors: []interface{}{
&AdvancedEventSelectorProperty{
FieldSelectors: []interface{}{
&AdvancedFieldSelectorProperty{
Field: jsii.String("field"),
// the properties below are optional
EndsWith: []*string{
jsii.String("endsWith"),
},
EqualTo: []*string{
jsii.String("equalTo"),
},
NotEndsWith: []*string{
jsii.String("notEndsWith"),
},
NotEquals: []*string{
jsii.String("notEquals"),
},
NotStartsWith: []*string{
jsii.String("notStartsWith"),
},
StartsWith: []*string{
jsii.String("startsWith"),
},
},
},
// the properties below are optional
Name: jsii.String("name"),
},
},
AggregationConfigurations: []interface{}{
&AggregationConfigurationProperty{
EventCategory: jsii.String("eventCategory"),
Templates: []*string{
jsii.String("templates"),
},
},
},
CloudWatchLogsLogGroupArn: jsii.String("cloudWatchLogsLogGroupArn"),
CloudWatchLogsRoleArn: jsii.String("cloudWatchLogsRoleArn"),
EnableLogFileValidation: jsii.Boolean(false),
EventSelectors: []interface{}{
&EventSelectorProperty{
DataResources: []interface{}{
&DataResourceProperty{
Type: jsii.String("type"),
// the properties below are optional
Values: []*string{
jsii.String("values"),
},
},
},
ExcludeManagementEventSources: []*string{
jsii.String("excludeManagementEventSources"),
},
IncludeManagementEvents: jsii.Boolean(false),
ReadWriteType: jsii.String("readWriteType"),
},
},
IncludeGlobalServiceEvents: jsii.Boolean(false),
InsightSelectors: []interface{}{
&InsightSelectorProperty{
EventCategories: []*string{
jsii.String("eventCategories"),
},
InsightType: jsii.String("insightType"),
},
},
IsMultiRegionTrail: jsii.Boolean(false),
IsOrganizationTrail: jsii.Boolean(false),
KmsKeyId: jsii.String("kmsKeyId"),
S3KeyPrefix: jsii.String("s3KeyPrefix"),
SnsTopicName: jsii.String("snsTopicName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TrailName: jsii.String("trailName"),
})
Initializer
new CfnTrail(scope: Construct, id: string, props: CfnTrailProps)
CfnTrail(scope: Construct, id: str, props: CfnTrailProps)
new CfnTrail(Construct scope, String id, CfnTrailProps props)
new CfnTrail(Construct scope, string id, CfnTrailProps props)
NewCfnTrail(Scope Construct, Id *string, Props CfnTrailProps)
Construct Props
advancedEventSelectorsoptionalIResolvable | IResolvable | CfnTrail.AdvancedEventSelectorProperty[]advanced_event_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdvancedEventSelectorProperty]]]advancedEventSelectorsoptionalIResolvableAdvancedEventSelectorsoptionalIResolvableAdvancedEventSelectorsoptionalinterface{}#notes
You can use advanced event selectors to log management events, data events for all resource types, and network activity events.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity events in the AWS CloudTrail User Guide .
aggregationConfigurationsoptionalIResolvable | IResolvable | CfnTrail.AggregationConfigurationProperty[]aggregation_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AggregationConfigurationProperty]]]aggregationConfigurationsoptionalIResolvableAggregationConfigurationsoptionalIResolvableAggregationConfigurationsoptionalinterface{}#A maximum of 1 aggregation configuration is allowed.
cloudWatchLogsLogGroupArnoptionalstring | ILogGroupRefcloud_watch_logs_log_group_arnoptionaltyping.Union[str, ILogGroupRef]cloudWatchLogsLogGroupArnoptionalStringCloudWatchLogsLogGroupArnoptionalstringCloudWatchLogsLogGroupArnoptionalinterface{}#notes
You must use a log group that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for CloudWatchLogsLogGroupArn and CloudWatchLogsRoleArn .
If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".
cloudWatchLogsRoleArnoptionalstring | IRoleRefcloud_watch_logs_role_arnoptionaltyping.Union[str, IRoleRef]cloudWatchLogsRoleArnoptionalStringCloudWatchLogsRoleArnoptionalstringCloudWatchLogsRoleArnoptionalinterface{}#notes
You must use a role that exists in your account.
To enable CloudWatch Logs delivery, you must provide values for CloudWatchLogsLogGroupArn and CloudWatchLogsRoleArn .
If you previously enabled CloudWatch Logs delivery and want to disable CloudWatch Logs delivery, you must set the values of the
CloudWatchLogsRoleArnandCloudWatchLogsLogGroupArnfields to"".
enableLogFileValidationoptionalboolean | IResolvableenable_log_file_validationoptionaltyping.Union[bool, IResolvable]enableLogFileValidationoptionalBooleanEnableLogFileValidationoptionalboolEnableLogFileValidationoptionalinterface{}#notes
When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
eventSelectorsoptionalIResolvable | IResolvable | CfnTrail.EventSelectorProperty[]event_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EventSelectorProperty]]]eventSelectorsoptionalIResolvableEventSelectorsoptionalIResolvableEventSelectorsoptionalinterface{}#notes
By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
You can configure up to five event selectors for a trail.
You cannot apply both event selectors and advanced event selectors to a trail.
includeGlobalServiceEventsoptionalboolean | IResolvableinclude_global_service_eventsoptionaltyping.Union[bool, IResolvable]includeGlobalServiceEventsoptionalBooleanIncludeGlobalServiceEventsoptionalboolIncludeGlobalServiceEventsoptionalinterface{}#insightSelectorsoptionalIResolvable | IResolvable | CfnTrail.InsightSelectorProperty[]insight_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InsightSelectorProperty]]]insightSelectorsoptionalIResolvableInsightSelectorsoptionalIResolvableInsightSelectorsoptionalinterface{}#notes
ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.
The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
isLoggingboolean | IResolvableis_loggingtyping.Union[bool, IResolvable]isLoggingBooleanIsLoggingboolIsLogginginterface{}required#isMultiRegionTrailoptionalboolean | IResolvableis_multi_region_trailoptionaltyping.Union[bool, IResolvable]isMultiRegionTrailoptionalBooleanIsMultiRegionTrailoptionalboolIsMultiRegionTrailoptionalinterface{}#notes
The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.
isOrganizationTrailoptionalboolean | IResolvableis_organization_trailoptionaltyping.Union[bool, IResolvable]isOrganizationTrailoptionalBooleanIsOrganizationTrailoptionalboolIsOrganizationTrailoptionalinterface{}#notes
The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations . If the trail is not an organization trail and this is set to true , the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false , the trail will remain in the current AWS account but be deleted from all member accounts in the organization.
Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.
kmsKeyIdoptionalstring | IAliasRef | IKeyRefkms_key_idoptionaltyping.Union[str, IAliasRef, IKeyRef]kmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptionalinterface{}#notes
The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
CloudTrail also supports AWS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .
Examples:
- alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
- arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
- 12345678-1234-1234-1234-123456789012
s3BucketNamestring | IBucketRefs3_bucket_nametyping.Union[str, IBucketRef]s3BucketNameStringS3BucketNamestringS3BucketNameinterface{}required#s3KeyPrefixoptionalstrings3_key_prefixoptionalstrs3KeyPrefixoptionalStringS3KeyPrefixoptionalstringS3KeyPrefixoptional*string#For more information, see Finding Your CloudTrail Log Files . The maximum length is 200 characters.
snsTopicNameoptionalstringsns_topic_nameoptionalstrsnsTopicNameoptionalStringSnsTopicNameoptionalstringSnsTopicNameoptional*string#The maximum length is 256 characters.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#trailNameoptionalstringtrail_nameoptionalstrtrailNameoptionalStringTrailNameoptionalstringTrailNameoptional*string#notes
- Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
- Start with a letter or number, and end with a letter or number
- Be between 3 and 128 characters
- Have no adjacent periods, underscores or dashes. Names like
my-_namespaceandmy--namespaceare not valid. - Not be in IP address format (for example, 192.168.5.4)
Properties
advancedEventSelectorsmay be undefinedIResolvable | IResolvable | CfnTrail.AdvancedEventSelectorProperty[]advanced_event_selectorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdvancedEventSelectorProperty]]]advancedEventSelectorsmay be undefinedIResolvableAdvancedEventSelectorsmay be undefinedIResolvableAdvancedEventSelectorsmay be undefinedinterface{}#aggregationConfigurationsmay be undefinedIResolvable | IResolvable | CfnTrail.AggregationConfigurationProperty[]aggregation_configurationsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AggregationConfigurationProperty]]]aggregationConfigurationsmay be undefinedIResolvableAggregationConfigurationsmay be undefinedIResolvableAggregationConfigurationsmay be undefinedinterface{}#attrSnsTopicArnstringattr_sns_topic_arnstrattrSnsTopicArnStringAttrSnsTopicArnstringAttrSnsTopicArn*string#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#cloudWatchLogsLogGroupArnmay be undefinedstringcloud_watch_logs_log_group_arnmay be undefinedstrcloudWatchLogsLogGroupArnmay be undefinedStringCloudWatchLogsLogGroupArnmay be undefinedstringCloudWatchLogsLogGroupArnmay be undefined*string#cloudWatchLogsRoleArnmay be undefinedstringcloud_watch_logs_role_arnmay be undefinedstrcloudWatchLogsRoleArnmay be undefinedStringCloudWatchLogsRoleArnmay be undefinedstringCloudWatchLogsRoleArnmay be undefined*string#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#enableLogFileValidationmay be undefinedboolean | IResolvableenable_log_file_validationmay be undefinedtyping.Union[bool, IResolvable]enableLogFileValidationmay be undefinedBooleanEnableLogFileValidationmay be undefinedboolEnableLogFileValidationmay be undefinedinterface{}#The default is false.
eventSelectorsmay be undefinedIResolvable | IResolvable | CfnTrail.EventSelectorProperty[]event_selectorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EventSelectorProperty]]]eventSelectorsmay be undefinedIResolvableEventSelectorsmay be undefinedIResolvableEventSelectorsmay be undefinedinterface{}#includeGlobalServiceEventsmay be undefinedboolean | IResolvableinclude_global_service_eventsmay be undefinedtyping.Union[bool, IResolvable]includeGlobalServiceEventsmay be undefinedBooleanIncludeGlobalServiceEventsmay be undefinedboolIncludeGlobalServiceEventsmay be undefinedinterface{}#insightSelectorsmay be undefinedIResolvable | IResolvable | CfnTrail.InsightSelectorProperty[]insight_selectorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InsightSelectorProperty]]]insightSelectorsmay be undefinedIResolvableInsightSelectorsmay be undefinedIResolvableInsightSelectorsmay be undefinedinterface{}#isLoggingboolean | IResolvableis_loggingtyping.Union[bool, IResolvable]isLoggingBooleanIsLoggingboolIsLogginginterface{}#isMultiRegionTrailmay be undefinedboolean | IResolvableis_multi_region_trailmay be undefinedtyping.Union[bool, IResolvable]isMultiRegionTrailmay be undefinedBooleanIsMultiRegionTrailmay be undefinedboolIsMultiRegionTrailmay be undefinedinterface{}#isOrganizationTrailmay be undefinedboolean | IResolvableis_organization_trailmay be undefinedtyping.Union[bool, IResolvable]isOrganizationTrailmay be undefinedBooleanIsOrganizationTrailmay be undefinedboolIsOrganizationTrailmay be undefinedinterface{}#kmsKeyIdmay be undefinedstringkms_key_idmay be undefinedstrkmsKeyIdmay be undefinedStringKmsKeyIdmay be undefinedstringKmsKeyIdmay be undefined*string#The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
s3KeyPrefixmay be undefinedstrings3_key_prefixmay be undefinedstrs3KeyPrefixmay be undefinedStringS3KeyPrefixmay be undefinedstringS3KeyPrefixmay be undefined*string#snsTopicNamemay be undefinedstringsns_topic_namemay be undefinedstrsnsTopicNamemay be undefinedStringSnsTopicNamemay be undefinedstringSnsTopicNamemay be undefined*string#CfnElements must be defined within a stack scope (directly or indirectly).
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#trailNamemay be undefinedstringtrail_namemay be undefinedstrtrailNamemay be undefinedStringTrailNamemay be undefinedstringTrailNamemay be undefined*string#The name must meet the following requirements:.
trailRefTrailReferencetrail_refTrailReferencetrailRefTrailReferenceTrailRefTrailReferenceTrailRefTrailReference#Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromTrailArn(scope: Construct, id: string, arn: string): ITrailRef@staticmethod def from_trail_arn(scope: Construct, id: str, arn: str) -> ITrailRefpublic static ITrailRef fromTrailArn(Construct scope, String id, String arn)public static ITrailRef FromTrailArn(Construct scope, string id, string arn)func FromTrailArn(Scope Construct, Id *string, Arn *string) ITrailRefstatic#fromTrailName(scope: Construct, id: string, trailName: string): ITrailRef@staticmethod def from_trail_name(scope: Construct, id: str, trail_name: str) -> ITrailRefpublic static ITrailRef fromTrailName(Construct scope, String id, String trailName)public static ITrailRef FromTrailName(Construct scope, string id, string trailName)func FromTrailName(Scope Construct, Id *string, TrailName *string) ITrailRefstatic#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isCfnTrail(x: any): boolean@staticmethod def is_cfn_trail(x: Any) -> boolpublic static Boolean isCfnTrail(Object x)public static bool IsCfnTrail(object x)func IsCfnTrail(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.