CfnSnapshotPropsMixin
- class aws_cdk.mixins_preview.aws_redshiftserverless.mixins.CfnSnapshotPropsMixin(props, *, strategy=None)
Bases:
MixinA snapshot object that contains databases.
- See:
- CloudformationResource:
AWS::RedshiftServerless::Snapshot
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins cfn_snapshot_props_mixin = redshiftserverless_mixins.CfnSnapshotPropsMixin(redshiftserverless_mixins.CfnSnapshotMixinProps( namespace_name="namespaceName", retention_period=123, snapshot_name="snapshotName", tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::RedshiftServerless::Snapshot.- Parameters:
props (
Union[CfnSnapshotMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['namespaceName', 'retentionPeriod', 'snapshotName', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
SnapshotProperty
- class CfnSnapshotPropsMixin.SnapshotProperty(*, admin_username=None, kms_key_id=None, namespace_arn=None, namespace_name=None, owner_account=None, retention_period=None, snapshot_arn=None, snapshot_create_time=None, snapshot_name=None, status=None)
Bases:
objectA snapshot object that contains databases.
- Parameters:
admin_username (
Optional[str]) – The username of the database within a snapshot.kms_key_id (
Optional[str]) – The unique identifier of the KMS key used to encrypt the snapshot.namespace_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the namespace the snapshot was created from.namespace_name (
Optional[str]) – The name of the namepsace.owner_account (
Optional[str]) – The owner AWS ; account of the snapshot.retention_period (
Union[int,float,None]) – The retention period of the snapshot created by the scheduled action.snapshot_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the snapshot.snapshot_create_time (
Optional[str]) – The timestamp of when the snapshot was created.snapshot_name (
Optional[str]) – The name of the snapshot.status (
Optional[str]) – The status of the snapshot.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins snapshot_property = redshiftserverless_mixins.CfnSnapshotPropsMixin.SnapshotProperty( admin_username="adminUsername", kms_key_id="kmsKeyId", namespace_arn="namespaceArn", namespace_name="namespaceName", owner_account="ownerAccount", retention_period=123, snapshot_arn="snapshotArn", snapshot_create_time="snapshotCreateTime", snapshot_name="snapshotName", status="status" )
Attributes
- admin_username
The username of the database within a snapshot.
- kms_key_id
The unique identifier of the KMS key used to encrypt the snapshot.
- namespace_arn
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
- namespace_name
The name of the namepsace.
- owner_account
The owner AWS ;
account of the snapshot.
- retention_period
The retention period of the snapshot created by the scheduled action.
- snapshot_arn
The Amazon Resource Name (ARN) of the snapshot.
- snapshot_create_time
The timestamp of when the snapshot was created.
- snapshot_name
The name of the snapshot.