CfnNamespace
- class aws_cdk.aws_redshiftserverless.CfnNamespace(scope, id, *, namespace_name, 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, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::RedshiftServerless::Namespace.A collection of database objects and users.
- CloudformationResource:
AWS::RedshiftServerless::Namespace
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_redshiftserverless as redshiftserverless cfn_namespace = redshiftserverless.CfnNamespace(self, "MyCfnNamespace", namespace_name="namespaceName", # the properties below are optional 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"], tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::RedshiftServerless::Namespace.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
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_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 areuserlog,connectionlog, anduseractivitylog.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_depends_on(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_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
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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 intermdediate 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).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Return type:
- 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
- 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
- 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_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_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, andUser 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.
Available export types are
userlog,connectionlog, anduseractivitylog.
- 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.
- 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.
- node
The construct tree node associated with this construct.
- 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 }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The map of the key-value pairs used to tag the namespace.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
NamespaceProperty
- class CfnNamespace.NamespaceProperty(*, 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:
objectA collection of database objects and users.
- Parameters:
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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_redshiftserverless as redshiftserverless namespace_property = redshiftserverless.CfnNamespace.NamespaceProperty( 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_username
The username of the administrator for the first database created in the namespace.
- creation_date
The date of when the namespace was created.
- db_name
The name of the first 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.
- 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.
Available export types are User log, Connection log, and User activity log.
- namespace_arn
The Amazon Resource Name (ARN) associated with a namespace.
- namespace_id
The unique identifier of a 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.