CfnNamespacePropsMixin

class aws_cdk.mixins_preview.aws_redshiftserverless.mixins.CfnNamespacePropsMixin(props, *, strategy=None)

Bases: Mixin

A collection of database objects and users.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html
CloudformationResource:: AWS::RedshiftServerless::Namespace
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

# namespace_resource_policy: Any

cfn_namespace_props_mixin = redshiftserverless_mixins.CfnNamespacePropsMixin(redshiftserverless_mixins.CfnNamespaceMixinProps(
    admin_password_secret_kms_key_id="adminPasswordSecretKmsKeyId",
    admin_username="adminUsername",
    admin_user_password="adminUserPassword",
    db_name="dbName",
    default_iam_role_arn="defaultIamRoleArn",
    final_snapshot_name="finalSnapshotName",
    final_snapshot_retention_period=123,
    iam_roles=["iamRoles"],
    kms_key_id="kmsKeyId",
    log_exports=["logExports"],
    manage_admin_password=False,
    namespace_name="namespaceName",
    namespace_resource_policy=namespace_resource_policy,
    redshift_idc_application_arn="redshiftIdcApplicationArn",
    snapshot_copy_configurations=[redshiftserverless_mixins.CfnNamespacePropsMixin.SnapshotCopyConfigurationProperty(
        destination_kms_key_id="destinationKmsKeyId",
        destination_region="destinationRegion",
        snapshot_retention_period=123
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::RedshiftServerless::Namespace.

Parameters:

props (Union[CfnNamespaceMixinProps, 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:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['adminPasswordSecretKmsKeyId', 'adminUsername', 'adminUserPassword', 'dbName', 'defaultIamRoleArn', 'finalSnapshotName', 'finalSnapshotRetentionPeriod', 'iamRoles', 'kmsKeyId', 'logExports', 'manageAdminPassword', 'namespaceName', 'namespaceResourcePolicy', 'redshiftIdcApplicationArn', 'snapshotCopyConfigurations', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

NamespaceProperty

class CfnNamespacePropsMixin.NamespaceProperty(*, admin_password_secret_arn=None, admin_password_secret_kms_key_id=None, admin_username=None, creation_date=None, db_name=None, default_iam_role_arn=None, iam_roles=None, kms_key_id=None, log_exports=None, namespace_arn=None, namespace_id=None, namespace_name=None, status=None)

Bases: object

A collection of database objects and users.

Parameters:

admin_password_secret_arn (Optional[str]) – The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.
admin_password_secret_kms_key_id (Optional[str]) – The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.
admin_username (Optional[str]) – The username of the administrator for the first database created in the namespace.
creation_date (Optional[str]) – The date of when the namespace was created.
db_name (Optional[str]) – The name of the first database created in the namespace.
default_iam_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iam_roles (Optional[Sequence[str]]) – A list of IAM roles to associate with the namespace.
kms_key_id (Optional[str]) – The ID of the AWS Key Management Service key used to encrypt your data.
log_exports (Optional[Sequence[str]]) – The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespace_arn (Optional[str]) – The Amazon Resource Name (ARN) associated with a namespace.
namespace_id (Optional[str]) – The unique identifier of a namespace.
namespace_name (Optional[str]) – The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
status (Optional[str]) – The status of the namespace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html

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

namespace_property = redshiftserverless_mixins.CfnNamespacePropsMixin.NamespaceProperty(
    admin_password_secret_arn="adminPasswordSecretArn",
    admin_password_secret_kms_key_id="adminPasswordSecretKmsKeyId",
    admin_username="adminUsername",
    creation_date="creationDate",
    db_name="dbName",
    default_iam_role_arn="defaultIamRoleArn",
    iam_roles=["iamRoles"],
    kms_key_id="kmsKeyId",
    log_exports=["logExports"],
    namespace_arn="namespaceArn",
    namespace_id="namespaceId",
    namespace_name="namespaceName",
    status="status"
)

Attributes

admin_password_secret_arn

The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn

admin_password_secret_kms_key_id

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid

admin_username

The username of the administrator for the first database created in the namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminusername

creation_date

The date of when the namespace was created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-creationdate

db_name

The name of the first database created in the namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-dbname

default_iam_role_arn

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-defaultiamrolearn

iam_roles

A list of IAM roles to associate with the namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-iamroles

kms_key_id

The ID of the AWS Key Management Service key used to encrypt your data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-kmskeyid

log_exports

The types of logs the namespace can export.

Available export types are User log, Connection log, and User activity log.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-logexports

namespace_arn

The Amazon Resource Name (ARN) associated with a namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacearn

namespace_id

The unique identifier of a namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespaceid

namespace_name

The name of the namespace.

Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacename

status

The status of the namespace.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-status

SnapshotCopyConfigurationProperty

class CfnNamespacePropsMixin.SnapshotCopyConfigurationProperty(*, destination_kms_key_id=None, destination_region=None, snapshot_retention_period=None)

Bases: object

The object that you configure to copy snapshots from one namespace to a namespace in another AWS Region .

Parameters:

destination_kms_key_id (Optional[str]) – The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
destination_region (Optional[str]) – The destination AWS Region to copy snapshots to.
snapshot_retention_period (Union[int, float, None]) – The retention period of snapshots that are copied to the destination AWS Region .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html

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_copy_configuration_property = redshiftserverless_mixins.CfnNamespacePropsMixin.SnapshotCopyConfigurationProperty(
    destination_kms_key_id="destinationKmsKeyId",
    destination_region="destinationRegion",
    snapshot_retention_period=123
)

Attributes

destination_kms_key_id

The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationkmskeyid

destination_region

The destination AWS Region to copy snapshots to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-destinationregion

snapshot_retention_period

The retention period of snapshots that are copied to the destination AWS Region .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-snapshotcopyconfiguration.html#cfn-redshiftserverless-namespace-snapshotcopyconfiguration-snapshotretentionperiod