CfnNamespace

class aws_cdk.aws_redshiftserverless.CfnNamespace(scope, id, *, namespace_name, admin_password_secret_kms_key_id=None, admin_username=None, admin_user_password=None, db_name=None, default_iam_role_arn=None, final_snapshot_name=None, final_snapshot_retention_period=None, iam_roles=None, kms_key_id=None, log_exports=None, manage_admin_password=None, namespace_resource_policy=None, redshift_idc_application_arn=None, snapshot_copy_configurations=None, tags=None)

Bases: CfnResource

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
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 import aws_redshiftserverless as redshiftserverless

# namespace_resource_policy: Any

cfn_namespace = redshiftserverless.CfnNamespace(self, "MyCfnNamespace",
    namespace_name="namespaceName",

    # the properties below are optional
    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_resource_policy=namespace_resource_policy,
    redshift_idc_application_arn="redshiftIdcApplicationArn",
    snapshot_copy_configurations=[redshiftserverless.CfnNamespace.SnapshotCopyConfigurationProperty(
        destination_region="destinationRegion",

        # the properties below are optional
        destination_kms_key_id="destinationKmsKeyId",
        snapshot_retention_period=123
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
namespace_name (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.
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. You can only use this parameter if ManageAdminPassword is true .
admin_username (Optional[str]) – The username of the administrator for the primary database created in the namespace.
admin_user_password (Optional[str]) – The password of the administrator for the primary database created in the namespace.
db_name (Optional[str]) – The name of the primary 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.
final_snapshot_name (Optional[str]) – The name of the snapshot to be created before the namespace is deleted.
final_snapshot_retention_period (Union[int, float, None]) – How long to retain the final snapshot.
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 userlog , connectionlog , and useractivitylog .
manage_admin_password (Union[bool, IResolvable, None]) – If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace’s admin credentials. You can’t use AdminUserPassword if ManageAdminPassword is true. If ManageAdminPassword is false or not set, Amazon Redshift uses AdminUserPassword for the admin user account’s password.
namespace_resource_policy (Any) – The resource policy that will be attached to the namespace.
redshift_idc_application_arn (Optional[str]) – The ARN for the Redshift application that integrates with IAM Identity Center.
snapshot_copy_configurations (Union[IResolvable, Sequence[Union[IResolvable, SnapshotCopyConfigurationProperty, Dict[str, Any]]], None]) – The snapshot copy configurations for the namespace.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The map of the key-value pairs used to tag the namespace.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::RedshiftServerless::Namespace'

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.

admin_user_password: The password of the administrator for the primary database created in the namespace.

admin_username: The username of the administrator for the primary database created in the namespace.

attr_namespace

Namespace

Type:: cloudformationAttribute

attr_namespace_admin_username

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

CloudformationAttribute:: Namespace.AdminUsername

attr_namespace_creation_date

The date of when the namespace was created.

CloudformationAttribute:: Namespace.CreationDate

attr_namespace_db_name

The name of the first database created in the namespace.

CloudformationAttribute:: Namespace.DbName

attr_namespace_default_iam_role_arn

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

CloudformationAttribute:: Namespace.DefaultIamRoleArn

attr_namespace_iam_roles

A list of IAM roles to associate with the namespace.

CloudformationAttribute:: Namespace.IamRoles

attr_namespace_kms_key_id

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

CloudformationAttribute:: Namespace.KmsKeyId

attr_namespace_log_exports

The types of logs the namespace can export.

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

CloudformationAttribute:: Namespace.LogExports

attr_namespace_namespace_arn

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

CloudformationAttribute:: Namespace.NamespaceArn

attr_namespace_namespace_id

The unique identifier of a namespace.

CloudformationAttribute:: Namespace.NamespaceId

attr_namespace_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.

CloudformationAttribute:: Namespace.NamespaceName

attr_namespace_status

The status of the namespace.

CloudformationAttribute:: Namespace.Status

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

db_name: The name of the primary database created in the namespace.

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

final_snapshot_name: The name of the snapshot to be created before the namespace is deleted.

final_snapshot_retention_period: How long to retain the final snapshot.

iam_roles: A list of IAM roles to associate with the namespace.

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

log_exports: The types of logs the namespace can export.

logical_id

The logical ID for this CloudFormation stack element.

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).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

manage_admin_password: If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace’s admin credentials.

namespace_name: The name of the namespace.

namespace_resource_policy: The resource policy that will be attached to the namespace.

node: The tree node.

redshift_idc_application_arn: The ARN for the Redshift application that integrates with IAM Identity Center.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

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 }).

snapshot_copy_configurations: The snapshot copy configurations for the namespace.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The map of the key-value pairs used to tag the namespace.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

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:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

NamespaceProperty

class CfnNamespace.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 import aws_redshiftserverless as redshiftserverless

namespace_property = redshiftserverless.CfnNamespace.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 CfnNamespace.SnapshotCopyConfigurationProperty(*, destination_region, destination_kms_key_id=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_region (str) – The destination AWS Region to copy snapshots to.
destination_kms_key_id (Optional[str]) – The ID of the KMS key to use to encrypt your snapshots in the destination AWS Region .
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 import aws_redshiftserverless as redshiftserverless

snapshot_copy_configuration_property = redshiftserverless.CfnNamespace.SnapshotCopyConfigurationProperty(
    destination_region="destinationRegion",

    # the properties below are optional
    destination_kms_key_id="destinationKmsKeyId",
    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