Class: AWSCDK::RedshiftServerless::CfnNamespace

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSRedshiftserverless::INamespaceRef
Defined in:
redshift_serverless/cfn_namespace.rb

Overview

A collection of database objects and users.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnNamespace

Create a new AWS::RedshiftServerless::Namespace.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::RedshiftServerless::CfnNamespaceProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'redshift_serverless/cfn_namespace.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::RedshiftServerless::CfnNamespaceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVkc2hpZnRzZXJ2ZXJsZXNzLkNmbk5hbWVzcGFjZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


198
199
200
 
# File 'redshift_serverless/cfn_namespace.rb', line 198

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_redshiftserverless.CfnNamespace", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_namespace(x) ⇒ Boolean

Checks whether the given object is a CfnNamespace.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


100
101
102
103
 
# File 'redshift_serverless/cfn_namespace.rb', line 100

def self.is_cfn_namespace(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_redshiftserverless.CfnNamespace", "isCfnNamespace", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'redshift_serverless/cfn_namespace.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_namespace => { kind: :property, name: "attrNamespace", is_optional: false },
    :attr_namespace_admin_username => { kind: :property, name: "attrNamespaceAdminUsername", is_optional: false },
    :attr_namespace_creation_date => { kind: :property, name: "attrNamespaceCreationDate", is_optional: false },
    :attr_namespace_db_name => { kind: :property, name: "attrNamespaceDbName", is_optional: false },
    :attr_namespace_default_iam_role_arn => { kind: :property, name: "attrNamespaceDefaultIamRoleArn", is_optional: false },
    :attr_namespace_iam_roles => { kind: :property, name: "attrNamespaceIamRoles", is_optional: false },
    :attr_namespace_kms_key_id => { kind: :property, name: "attrNamespaceKmsKeyId", is_optional: false },
    :attr_namespace_log_exports => { kind: :property, name: "attrNamespaceLogExports", is_optional: false },
    :attr_namespace_namespace_arn => { kind: :property, name: "attrNamespaceNamespaceArn", is_optional: false },
    :attr_namespace_namespace_id => { kind: :property, name: "attrNamespaceNamespaceId", is_optional: false },
    :attr_namespace_namespace_name => { kind: :property, name: "attrNamespaceNamespaceName", is_optional: false },
    :attr_namespace_status => { kind: :property, name: "attrNamespaceStatus", is_optional: false },
    :namespace_ref => { kind: :property, name: "namespaceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :namespace_name => { kind: :property, name: "namespaceName", is_optional: false },
    :namespace_resource_policy => { kind: :property, name: "namespaceResourcePolicy", is_optional: false },
    :admin_password_secret_kms_key_id => { kind: :property, name: "adminPasswordSecretKmsKeyId", is_optional: true },
    :admin_username => { kind: :property, name: "adminUsername", is_optional: true },
    :admin_user_password => { kind: :property, name: "adminUserPassword", is_optional: true },
    :db_name => { kind: :property, name: "dbName", is_optional: true },
    :default_iam_role_arn => { kind: :property, name: "defaultIamRoleArn", is_optional: true },
    :final_snapshot_name => { kind: :property, name: "finalSnapshotName", is_optional: true },
    :final_snapshot_retention_period => { kind: :property, name: "finalSnapshotRetentionPeriod", is_optional: true },
    :iam_roles => { kind: :property, name: "iamRoles", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :log_exports => { kind: :property, name: "logExports", is_optional: true },
    :manage_admin_password => { kind: :property, name: "manageAdminPassword", is_optional: true },
    :redshift_idc_application_arn => { kind: :property, name: "redshiftIdcApplicationArn", is_optional: true },
    :snapshot_copy_configurations => { kind: :property, name: "snapshotCopyConfigurations", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



531
532
533
534
 
# File 'redshift_serverless/cfn_namespace.rb', line 531

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



543
544
545
546
 
# File 'redshift_serverless/cfn_namespace.rb', line 543

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

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

Parameters:



553
554
555
556
 
# File 'redshift_serverless/cfn_namespace.rb', line 553

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



564
565
566
567
568
 
# File 'redshift_serverless/cfn_namespace.rb', line 564

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


621
622
623
624
625
 
# File 'redshift_serverless/cfn_namespace.rb', line 621

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

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

Parameters:

  • property_path (String) —

    The path to the property.



631
632
633
634
 
# File 'redshift_serverless/cfn_namespace.rb', line 631

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

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

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



643
644
645
646
647
 
# File 'redshift_serverless/cfn_namespace.rb', line 643

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#admin_password_secret_kms_key_id ⇒ String?

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

Returns:

  • (String, nil) 


329
330
331
 
# File 'redshift_serverless/cfn_namespace.rb', line 329

def admin_password_secret_kms_key_id()
  jsii_get_property("adminPasswordSecretKmsKeyId")
end

#admin_password_secret_kms_key_id=(value) ⇒ Object 



333
334
335
336
 
# File 'redshift_serverless/cfn_namespace.rb', line 333

def admin_password_secret_kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adminPasswordSecretKmsKeyId") unless value.nil?
  jsii_set_property("adminPasswordSecretKmsKeyId", value)
end

#admin_user_password ⇒ String?

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

Returns:

  • (String, nil) 


353
354
355
 
# File 'redshift_serverless/cfn_namespace.rb', line 353

def admin_user_password()
  jsii_get_property("adminUserPassword")
end

#admin_user_password=(value) ⇒ Object 



357
358
359
360
 
# File 'redshift_serverless/cfn_namespace.rb', line 357

def admin_user_password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adminUserPassword") unless value.nil?
  jsii_set_property("adminUserPassword", value)
end

#admin_username ⇒ String?

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

Returns:

  • (String, nil) 


341
342
343
 
# File 'redshift_serverless/cfn_namespace.rb', line 341

def admin_username()
  jsii_get_property("adminUsername")
end

#admin_username=(value) ⇒ Object 



345
346
347
348
 
# File 'redshift_serverless/cfn_namespace.rb', line 345

def admin_username=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "adminUsername") unless value.nil?
  jsii_set_property("adminUsername", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

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.

Parameters:



656
657
658
659
 
# File 'redshift_serverless/cfn_namespace.rb', line 656

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

See Also:



678
679
680
681
682
683
 
# File 'redshift_serverless/cfn_namespace.rb', line 678

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_namespace ⇒ AWSCDK::IResolvable

Returns:



203
204
205
 
# File 'redshift_serverless/cfn_namespace.rb', line 203

def attr_namespace()
  jsii_get_property("attrNamespace")
end

#attr_namespace_admin_username ⇒ String

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

Returns:

  • (String) 


210
211
212
 
# File 'redshift_serverless/cfn_namespace.rb', line 210

def attr_namespace_admin_username()
  jsii_get_property("attrNamespaceAdminUsername")
end

#attr_namespace_creation_date ⇒ String

The date of when the namespace was created.

Returns:

  • (String) 


217
218
219
 
# File 'redshift_serverless/cfn_namespace.rb', line 217

def attr_namespace_creation_date()
  jsii_get_property("attrNamespaceCreationDate")
end

#attr_namespace_db_name ⇒ String

The name of the first database created in the namespace.

Returns:

  • (String) 


224
225
226
 
# File 'redshift_serverless/cfn_namespace.rb', line 224

def attr_namespace_db_name()
  jsii_get_property("attrNamespaceDbName")
end

#attr_namespace_default_iam_role_arn ⇒ String

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

Returns:

  • (String) 


231
232
233
 
# File 'redshift_serverless/cfn_namespace.rb', line 231

def attr_namespace_default_iam_role_arn()
  jsii_get_property("attrNamespaceDefaultIamRoleArn")
end

#attr_namespace_iam_roles ⇒ Array<String>

A list of IAM roles to associate with the namespace.

Returns:

  • (Array<String>) 


238
239
240
 
# File 'redshift_serverless/cfn_namespace.rb', line 238

def attr_namespace_iam_roles()
  jsii_get_property("attrNamespaceIamRoles")
end

#attr_namespace_kms_key_id ⇒ String

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

Returns:

  • (String) 


245
246
247
 
# File 'redshift_serverless/cfn_namespace.rb', line 245

def attr_namespace_kms_key_id()
  jsii_get_property("attrNamespaceKmsKeyId")
end

#attr_namespace_log_exports ⇒ Array<String>

The types of logs the namespace can export.

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

Returns:

  • (Array<String>) 


254
255
256
 
# File 'redshift_serverless/cfn_namespace.rb', line 254

def attr_namespace_log_exports()
  jsii_get_property("attrNamespaceLogExports")
end

#attr_namespace_namespace_arn ⇒ String

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

Returns:

  • (String) 


261
262
263
 
# File 'redshift_serverless/cfn_namespace.rb', line 261

def attr_namespace_namespace_arn()
  jsii_get_property("attrNamespaceNamespaceArn")
end

#attr_namespace_namespace_id ⇒ String

The unique identifier of a namespace.

Returns:

  • (String) 


268
269
270
 
# File 'redshift_serverless/cfn_namespace.rb', line 268

def attr_namespace_namespace_id()
  jsii_get_property("attrNamespaceNamespaceId")
end

#attr_namespace_namespace_name ⇒ String

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.

Returns:

  • (String) 


277
278
279
 
# File 'redshift_serverless/cfn_namespace.rb', line 277

def attr_namespace_namespace_name()
  jsii_get_property("attrNamespaceNamespaceName")
end

#attr_namespace_status ⇒ String

The status of the namespace.

Returns:

  • (String) 


284
285
286
 
# File 'redshift_serverless/cfn_namespace.rb', line 284

def attr_namespace_status()
  jsii_get_property("attrNamespaceStatus")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



151
152
153
 
# File 'redshift_serverless/cfn_namespace.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


156
157
158
 
# File 'redshift_serverless/cfn_namespace.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


687
688
689
690
 
# File 'redshift_serverless/cfn_namespace.rb', line 687

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


161
162
163
 
# File 'redshift_serverless/cfn_namespace.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


168
169
170
 
# File 'redshift_serverless/cfn_namespace.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


113
114
115
 
# File 'redshift_serverless/cfn_namespace.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#db_name ⇒ String?

The name of the primary database created in the namespace.

Returns:

  • (String, nil) 


365
366
367
 
# File 'redshift_serverless/cfn_namespace.rb', line 365

def db_name()
  jsii_get_property("dbName")
end

#db_name=(value) ⇒ Object 



369
370
371
372
 
# File 'redshift_serverless/cfn_namespace.rb', line 369

def db_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbName") unless value.nil?
  jsii_set_property("dbName", value)
end

#default_iam_role_arn ⇒ String?

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

Returns:

  • (String, nil) 


377
378
379
 
# File 'redshift_serverless/cfn_namespace.rb', line 377

def default_iam_role_arn()
  jsii_get_property("defaultIamRoleArn")
end

#default_iam_role_arn=(value) ⇒ Object 



381
382
383
384
 
# File 'redshift_serverless/cfn_namespace.rb', line 381

def default_iam_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultIamRoleArn") unless value.nil?
  jsii_set_property("defaultIamRoleArn", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



173
174
175
 
# File 'redshift_serverless/cfn_namespace.rb', line 173

def env()
  jsii_get_property("env")
end

#final_snapshot_name ⇒ String?

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

Returns:

  • (String, nil) 


389
390
391
 
# File 'redshift_serverless/cfn_namespace.rb', line 389

def final_snapshot_name()
  jsii_get_property("finalSnapshotName")
end

#final_snapshot_name=(value) ⇒ Object 



393
394
395
396
 
# File 'redshift_serverless/cfn_namespace.rb', line 393

def final_snapshot_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "finalSnapshotName") unless value.nil?
  jsii_set_property("finalSnapshotName", value)
end

#final_snapshot_retention_period ⇒ Numeric?

How long to retain the final snapshot.

Returns:

  • (Numeric, nil) 


401
402
403
 
# File 'redshift_serverless/cfn_namespace.rb', line 401

def final_snapshot_retention_period()
  jsii_get_property("finalSnapshotRetentionPeriod")
end

#final_snapshot_retention_period=(value) ⇒ Object 



405
406
407
408
 
# File 'redshift_serverless/cfn_namespace.rb', line 405

def final_snapshot_retention_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "finalSnapshotRetentionPeriod") unless value.nil?
  jsii_set_property("finalSnapshotRetentionPeriod", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



700
701
702
703
704
 
# File 'redshift_serverless/cfn_namespace.rb', line 700

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



711
712
713
714
 
# File 'redshift_serverless/cfn_namespace.rb', line 711

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#iam_roles ⇒ Array<String>?

A list of IAM roles to associate with the namespace.

Returns:

  • (Array<String>, nil) 


413
414
415
 
# File 'redshift_serverless/cfn_namespace.rb', line 413

def iam_roles()
  jsii_get_property("iamRoles")
end

#iam_roles=(value) ⇒ Object 



417
418
419
420
 
# File 'redshift_serverless/cfn_namespace.rb', line 417

def iam_roles=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "iamRoles") unless value.nil?
  jsii_set_property("iamRoles", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



781
782
783
784
 
# File 'redshift_serverless/cfn_namespace.rb', line 781

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_id ⇒ String?

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

Returns:

  • (String, nil) 


425
426
427
 
# File 'redshift_serverless/cfn_namespace.rb', line 425

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



429
430
431
432
 
# File 'redshift_serverless/cfn_namespace.rb', line 429

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#log_exports ⇒ Array<String>?

The types of logs the namespace can export.

Returns:

  • (Array<String>, nil) 


437
438
439
 
# File 'redshift_serverless/cfn_namespace.rb', line 437

def log_exports()
  jsii_get_property("logExports")
end

#log_exports=(value) ⇒ Object 



441
442
443
444
 
# File 'redshift_serverless/cfn_namespace.rb', line 441

def log_exports=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "logExports") unless value.nil?
  jsii_set_property("logExports", value)
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


125
126
127
 
# File 'redshift_serverless/cfn_namespace.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#manage_admin_password ⇒ Boolean, ...

If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.

Returns:



449
450
451
 
# File 'redshift_serverless/cfn_namespace.rb', line 449

def manage_admin_password()
  jsii_get_property("manageAdminPassword")
end

#manage_admin_password=(value) ⇒ Object 



453
454
455
456
 
# File 'redshift_serverless/cfn_namespace.rb', line 453

def manage_admin_password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "manageAdminPassword") unless value.nil?
  jsii_set_property("manageAdminPassword", value)
end

#namespace_name ⇒ String

The name of the namespace.

Returns:

  • (String) 


305
306
307
 
# File 'redshift_serverless/cfn_namespace.rb', line 305

def namespace_name()
  jsii_get_property("namespaceName")
end

#namespace_name=(value) ⇒ Object 



309
310
311
312
 
# File 'redshift_serverless/cfn_namespace.rb', line 309

def namespace_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespaceName")
  jsii_set_property("namespaceName", value)
end

#namespace_ref ⇒ AWSCDK::Interfaces::AWSRedshiftserverless::NamespaceReference

A reference to a Namespace resource.

Returns:



291
292
293
 
# File 'redshift_serverless/cfn_namespace.rb', line 291

def namespace_ref()
  jsii_get_property("namespaceRef")
end

#namespace_resource_policy ⇒ Object

The resource policy that will be attached to the namespace.

Returns:

  • (Object) 


317
318
319
 
# File 'redshift_serverless/cfn_namespace.rb', line 317

def namespace_resource_policy()
  jsii_get_property("namespaceResourcePolicy")
end

#namespace_resource_policy=(value) ⇒ Object 



321
322
323
324
 
# File 'redshift_serverless/cfn_namespace.rb', line 321

def namespace_resource_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "namespaceResourcePolicy")
  jsii_set_property("namespaceResourcePolicy", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


108
109
110
 
# File 'redshift_serverless/cfn_namespace.rb', line 108

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

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

Returns:



722
723
724
 
# File 'redshift_serverless/cfn_namespace.rb', line 722

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



729
730
731
 
# File 'redshift_serverless/cfn_namespace.rb', line 729

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



522
523
524
525
 
# File 'redshift_serverless/cfn_namespace.rb', line 522

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#redshift_idc_application_arn ⇒ String?

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

Returns:

  • (String, nil) 


461
462
463
 
# File 'redshift_serverless/cfn_namespace.rb', line 461

def redshift_idc_application_arn()
  jsii_get_property("redshiftIdcApplicationArn")
end

#redshift_idc_application_arn=(value) ⇒ Object 



465
466
467
468
 
# File 'redshift_serverless/cfn_namespace.rb', line 465

def redshift_idc_application_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "redshiftIdcApplicationArn") unless value.nil?
  jsii_set_property("redshiftIdcApplicationArn", value)
end

#ref ⇒ String

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

Returns:

  • (String) 


144
145
146
 
# File 'redshift_serverless/cfn_namespace.rb', line 144

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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:



740
741
742
743
 
# File 'redshift_serverless/cfn_namespace.rb', line 740

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


747
748
749
750
 
# File 'redshift_serverless/cfn_namespace.rb', line 747

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



757
758
759
760
761
 
# File 'redshift_serverless/cfn_namespace.rb', line 757

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



766
767
768
 
# File 'redshift_serverless/cfn_namespace.rb', line 766

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#snapshot_copy_configurations ⇒ AWSCDK::IResolvable, ...

The snapshot copy configurations for the namespace.

Returns:



473
474
475
 
# File 'redshift_serverless/cfn_namespace.rb', line 473

def snapshot_copy_configurations()
  jsii_get_property("snapshotCopyConfigurations")
end

#snapshot_copy_configurations=(value) ⇒ Object 



477
478
479
480
 
# File 'redshift_serverless/cfn_namespace.rb', line 477

def snapshot_copy_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVkc2hpZnRzZXJ2ZXJsZXNzLkNmbk5hbWVzcGFjZS5TbmFwc2hvdENvcHlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "snapshotCopyConfigurations") unless value.nil?
  jsii_set_property("snapshotCopyConfigurations", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



134
135
136
 
# File 'redshift_serverless/cfn_namespace.rb', line 134

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



298
299
300
 
# File 'redshift_serverless/cfn_namespace.rb', line 298

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



485
486
487
 
# File 'redshift_serverless/cfn_namespace.rb', line 485

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



489
490
491
492
493
 
# File 'redshift_serverless/cfn_namespace.rb', line 489

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



498
499
500
 
# File 'redshift_serverless/cfn_namespace.rb', line 498

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'redshift_serverless/cfn_namespace.rb', line 181

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'redshift_serverless/cfn_namespace.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


772
773
774
775
 
# File 'redshift_serverless/cfn_namespace.rb', line 772

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


511
512
513
514
515
516
 
# File 'redshift_serverless/cfn_namespace.rb', line 511

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end