CfnEventDataStore L1 construct
Creates a new event data store.
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 cfnEventDataStore = new cloudtrail.CfnEventDataStore(this, 'MyCfnEventDataStore', /* all optional props */ {
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',
}],
billingMode: 'billingMode',
contextKeySelectors: [{
equalTo: ['equalTo'],
type: 'type',
}],
federationEnabled: false,
federationRoleArn: 'federationRoleArn',
ingestionEnabled: false,
insightsDestination: 'insightsDestination',
insightSelectors: [{
insightType: 'insightType',
}],
kmsKeyId: 'kmsKeyId',
maxEventSize: 'maxEventSize',
multiRegionEnabled: false,
name: 'name',
organizationEnabled: false,
retentionPeriod: 123,
tags: [{
key: 'key',
value: 'value',
}],
terminationProtectionEnabled: false,
});
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_event_data_store = cloudtrail.CfnEventDataStore(self, "MyCfnEventDataStore",
advanced_event_selectors=[cloudtrail.CfnEventDataStore.AdvancedEventSelectorProperty(
field_selectors=[cloudtrail.CfnEventDataStore.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"
)],
billing_mode="billingMode",
context_key_selectors=[cloudtrail.CfnEventDataStore.ContextKeySelectorProperty(
equal_to=["equalTo"],
type="type"
)],
federation_enabled=False,
federation_role_arn="federationRoleArn",
ingestion_enabled=False,
insights_destination="insightsDestination",
insight_selectors=[cloudtrail.CfnEventDataStore.InsightSelectorProperty(
insight_type="insightType"
)],
kms_key_id="kmsKeyId",
max_event_size="maxEventSize",
multi_region_enabled=False,
name="name",
organization_enabled=False,
retention_period=123,
tags=[CfnTag(
key="key",
value="value"
)],
termination_protection_enabled=False
)
// 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.*;
CfnEventDataStore cfnEventDataStore = CfnEventDataStore.Builder.create(this, "MyCfnEventDataStore")
.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()))
.billingMode("billingMode")
.contextKeySelectors(List.of(ContextKeySelectorProperty.builder()
.equalTo(List.of("equalTo"))
.type("type")
.build()))
.federationEnabled(false)
.federationRoleArn("federationRoleArn")
.ingestionEnabled(false)
.insightsDestination("insightsDestination")
.insightSelectors(List.of(InsightSelectorProperty.builder()
.insightType("insightType")
.build()))
.kmsKeyId("kmsKeyId")
.maxEventSize("maxEventSize")
.multiRegionEnabled(false)
.name("name")
.organizationEnabled(false)
.retentionPeriod(123)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.terminationProtectionEnabled(false)
.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 cfnEventDataStore = new CfnEventDataStore(this, "MyCfnEventDataStore", new CfnEventDataStoreProps {
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"
} },
BillingMode = "billingMode",
ContextKeySelectors = new [] { new ContextKeySelectorProperty {
EqualTo = new [] { "equalTo" },
Type = "type"
} },
FederationEnabled = false,
FederationRoleArn = "federationRoleArn",
IngestionEnabled = false,
InsightsDestination = "insightsDestination",
InsightSelectors = new [] { new InsightSelectorProperty {
InsightType = "insightType"
} },
KmsKeyId = "kmsKeyId",
MaxEventSize = "maxEventSize",
MultiRegionEnabled = false,
Name = "name",
OrganizationEnabled = false,
RetentionPeriod = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TerminationProtectionEnabled = false
});
// 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"
cfnEventDataStore := awscdk.Aws_cloudtrail.NewCfnEventDataStore(this, jsii.String("MyCfnEventDataStore"), &CfnEventDataStoreProps{
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"),
},
},
BillingMode: jsii.String("billingMode"),
ContextKeySelectors: []interface{}{
&ContextKeySelectorProperty{
EqualTo: []*string{
jsii.String("equalTo"),
},
Type: jsii.String("type"),
},
},
FederationEnabled: jsii.Boolean(false),
FederationRoleArn: jsii.String("federationRoleArn"),
IngestionEnabled: jsii.Boolean(false),
InsightsDestination: jsii.String("insightsDestination"),
InsightSelectors: []interface{}{
&InsightSelectorProperty{
InsightType: jsii.String("insightType"),
},
},
KmsKeyId: jsii.String("kmsKeyId"),
MaxEventSize: jsii.String("maxEventSize"),
MultiRegionEnabled: jsii.Boolean(false),
Name: jsii.String("name"),
OrganizationEnabled: jsii.Boolean(false),
RetentionPeriod: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TerminationProtectionEnabled: jsii.Boolean(false),
})
Initializer
new CfnEventDataStore(scope: Construct, id: string, props?: CfnEventDataStoreProps)
CfnEventDataStore(scope: Construct, id: str, props: typing.Optional[CfnEventDataStoreProps] = None)
new CfnEventDataStore(Construct scope, String id, CfnEventDataStoreProps props)
new CfnEventDataStore(Construct scope, string id, CfnEventDataStoreProps? props = null)
NewCfnEventDataStore(Scope Construct, Id *string, Props CfnEventDataStoreProps)
Construct Props
advancedEventSelectorsoptionalIResolvable | IResolvable | CfnEventDataStore.AdvancedEventSelectorProperty[]advanced_event_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdvancedEventSelectorProperty]]]advancedEventSelectorsoptionalIResolvableAdvancedEventSelectorsoptionalIResolvableAdvancedEventSelectorsoptionalinterface{}#notes
You can configure up to five advanced event selectors for each event data store.
For more information about how to use advanced event selectors to log CloudTrail events, see Log events by using advanced event selectors in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see Create an event data store for AWS Config configuration items in the CloudTrail User Guide.
For more information about how to use advanced event selectors to include events outside of AWS events in your event data store, see Create an integration to log events from outside AWS in the CloudTrail User Guide.
billingModeoptionalstringbilling_modeoptionalstrbillingModeoptionalStringBillingModeoptionalstringBillingModeoptional*string#notes
The following are the possible values:
EXTENDABLE_RETENTION_PRICING- This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.FIXED_RETENTION_PRICING- This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.
The default value is EXTENDABLE_RETENTION_PRICING .
For more information about CloudTrail pricing, see AWS CloudTrail Pricing and Managing CloudTrail Lake costs .
contextKeySelectorsoptionalIResolvable | IResolvable | CfnEventDataStore.ContextKeySelectorProperty[]context_key_selectorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ContextKeySelectorProperty]]]contextKeySelectorsoptionalIResolvableContextKeySelectorsoptionalIResolvableContextKeySelectorsoptionalinterface{}#federationEnabledoptionalboolean | IResolvablefederation_enabledoptionaltyping.Union[bool, IResolvable]federationEnabledoptionalBooleanFederationEnabledoptionalboolFederationEnabledoptionalinterface{}#federationRoleArnoptionalstringfederation_role_arnoptionalstrfederationRoleArnoptionalStringFederationRoleArnoptionalstringFederationRoleArnoptional*string#The federation role must exist in your account and provide the required minimum permissions .
ingestionEnabledoptionalboolean | IResolvableingestion_enabledoptionaltyping.Union[bool, IResolvable]ingestionEnabledoptionalBooleanIngestionEnabledoptionalboolIngestionEnabledoptionalinterface{}#The default is true.
insightsDestinationoptionalstringinsights_destinationoptionalstrinsightsDestinationoptionalStringInsightsDestinationoptionalstringInsightsDestinationoptional*string#For more information, see Create an event data store for CloudTrail Insights events .
insightSelectorsoptionalIResolvable | IResolvable | CfnEventDataStore.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.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#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.
Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.
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/MyAliasNamearn:aws:kms:us-east-2:123456789012:alias/MyAliasNamearn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-12345678901212345678-1234-1234-1234-123456789012
maxEventSizeoptionalstringmax_event_sizeoptionalstrmaxEventSizeoptionalStringMaxEventSizeoptionalstringMaxEventSizeoptional*string#If you are using context key selectors, MaxEventSize must be set to Large.
multiRegionEnabledoptionalboolean | IResolvablemulti_region_enabledoptionaltyping.Union[bool, IResolvable]multiRegionEnabledoptionalBooleanMultiRegionEnabledoptionalboolMultiRegionEnabledoptionalinterface{}#organizationEnabledoptionalboolean | IResolvableorganization_enabledoptionaltyping.Union[bool, IResolvable]organizationEnabledoptionalBooleanOrganizationEnabledoptionalboolOrganizationEnabledoptionalinterface{}#retentionPeriodoptionalnumberretention_periodoptionalint | floatretentionPeriodoptionalNumberRetentionPeriodoptionaldoubleRetentionPeriodoptional*float64#notes
If BillingMode is set to EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING , you can set a retention period of up to 2557 days, the equivalent of seven years.
CloudTrail Lake determines whether to retain an event by checking if the eventTime of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the eventTime is older than 90 days.
If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#terminationProtectionEnabledoptionalboolean | IResolvabletermination_protection_enabledoptionaltyping.Union[bool, IResolvable]terminationProtectionEnabledoptionalBooleanTerminationProtectionEnabledoptionalboolTerminationProtectionEnabledoptionalinterface{}#If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.
Properties
advancedEventSelectorsmay be undefinedIResolvable | IResolvable | CfnEventDataStore.AdvancedEventSelectorProperty[]advanced_event_selectorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdvancedEventSelectorProperty]]]advancedEventSelectorsmay be undefinedIResolvableAdvancedEventSelectorsmay be undefinedIResolvableAdvancedEventSelectorsmay be undefinedinterface{}#attrCreatedTimestampstringattr_created_timestampstrattrCreatedTimestampStringAttrCreatedTimestampstringAttrCreatedTimestamp*string#attrEventDataStoreArnstringattr_event_data_store_arnstrattrEventDataStoreArnStringAttrEventDataStoreArnstringAttrEventDataStoreArn*string#attrUpdatedTimestampstringattr_updated_timestampstrattrUpdatedTimestampStringAttrUpdatedTimestampstringAttrUpdatedTimestamp*string#billingModemay be undefinedstringbilling_modemay be undefinedstrbillingModemay be undefinedStringBillingModemay be undefinedstringBillingModemay be undefined*string#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#contextKeySelectorsmay be undefinedIResolvable | IResolvable | CfnEventDataStore.ContextKeySelectorProperty[]context_key_selectorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ContextKeySelectorProperty]]]contextKeySelectorsmay be undefinedIResolvableContextKeySelectorsmay be undefinedIResolvableContextKeySelectorsmay be undefinedinterface{}#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#eventDataStoreRefEventDataStoreReferenceevent_data_store_refEventDataStoreReferenceeventDataStoreRefEventDataStoreReferenceEventDataStoreRefEventDataStoreReferenceEventDataStoreRefEventDataStoreReference#federationEnabledmay be undefinedboolean | IResolvablefederation_enabledmay be undefinedtyping.Union[bool, IResolvable]federationEnabledmay be undefinedBooleanFederationEnabledmay be undefinedboolFederationEnabledmay be undefinedinterface{}#federationRoleArnmay be undefinedstringfederation_role_arnmay be undefinedstrfederationRoleArnmay be undefinedStringFederationRoleArnmay be undefinedstringFederationRoleArnmay be undefined*string#ingestionEnabledmay be undefinedboolean | IResolvableingestion_enabledmay be undefinedtyping.Union[bool, IResolvable]ingestionEnabledmay be undefinedBooleanIngestionEnabledmay be undefinedboolIngestionEnabledmay be undefinedinterface{}#insightsDestinationmay be undefinedstringinsights_destinationmay be undefinedstrinsightsDestinationmay be undefinedStringInsightsDestinationmay be undefinedstringInsightsDestinationmay be undefined*string#insightSelectorsmay be undefinedIResolvable | IResolvable | CfnEventDataStore.InsightSelectorProperty[]insight_selectorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InsightSelectorProperty]]]insightSelectorsmay be undefinedIResolvableInsightSelectorsmay be undefinedIResolvableInsightSelectorsmay 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).
maxEventSizemay be undefinedstringmax_event_sizemay be undefinedstrmaxEventSizemay be undefinedStringMaxEventSizemay be undefinedstringMaxEventSizemay be undefined*string#multiRegionEnabledmay be undefinedboolean | IResolvablemulti_region_enabledmay be undefinedtyping.Union[bool, IResolvable]multiRegionEnabledmay be undefinedBooleanMultiRegionEnabledmay be undefinedboolMultiRegionEnabledmay be undefinedinterface{}#namemay be undefinedstringnamemay be undefinedstrnamemay be undefinedStringNamemay be undefinedstringNamemay be undefined*string#organizationEnabledmay be undefinedboolean | IResolvableorganization_enabledmay be undefinedtyping.Union[bool, IResolvable]organizationEnabledmay be undefinedBooleanOrganizationEnabledmay be undefinedboolOrganizationEnabledmay be undefinedinterface{}#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 }).
retentionPeriodmay be undefinednumberretention_periodmay be undefinedint | floatretentionPeriodmay be undefinedNumberRetentionPeriodmay be undefineddoubleRetentionPeriodmay be undefined*float64#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#terminationProtectionEnabledmay be undefinedboolean | IResolvabletermination_protection_enabledmay be undefinedtyping.Union[bool, IResolvable]terminationProtectionEnabledmay be undefinedBooleanTerminationProtectionEnabledmay be undefinedboolTerminationProtectionEnabledmay be undefinedinterface{}#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:
arnForEventDataStore(resource: IEventDataStoreRef): string@staticmethod def arn_for_event_data_store(resource: IEventDataStoreRef) -> strpublic static String arnForEventDataStore(IEventDataStoreRef resource)public static string ArnForEventDataStore(IEventDataStoreRef resource)func ArnForEventDataStore(Resource IEventDataStoreRef) *stringstatic#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#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.
isCfnEventDataStore(x: any): boolean@staticmethod def is_cfn_event_data_store(x: Any) -> boolpublic static Boolean isCfnEventDataStore(Object x)public static bool IsCfnEventDataStore(object x)func IsCfnEventDataStore(X interface{}) *boolstatic#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#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.