Class: AWSCDK::DSQL::CfnCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSDSQL::IClusterRef
Defined in:
dsql/cfn_cluster.rb

Overview

The AWS::DSQL::Cluster resource specifies an cluster. You can use this resource to create, modify, and manage clusters.

This resource supports both single-Region clusters and multi-Region clusters through the MultiRegionProperties parameter.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters. > - The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

Required permissions

  • dsql:CreateCluster - Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

  • dsql:TagResource - Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

  • dsql:PutMultiRegionProperties - Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

  • dsql:AddPeerCluster - When specifying multiRegionProperties.clusters , permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:region:account-id:cluster/*
  • Each peer cluster: exact ARN of each specified peer cluster
  • dsql:PutWitnessRegion - When specifying multiRegionProperties.witnessRegion , permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnCluster

Create a new AWS::DSQL::Cluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::DSQL::CfnClusterProps, nil) (defaults to: nil) —

    Resource properties.



48
49
50
51
52
53
54
 
# File 'dsql/cfn_cluster.rb', line 48

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::DSQL::CfnClusterProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHNxbC5DZm5DbHVzdGVyUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


114
115
116
117
 
# File 'dsql/cfn_cluster.rb', line 114

def self.arn_for_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kc3FsLklDbHVzdGVyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dsql.CfnCluster", "arnForCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


234
235
236
 
# File 'dsql/cfn_cluster.rb', line 234

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

.from_identifier(scope, id, identifier) ⇒ AWSCDK::Interfaces::AWSDSQL::IClusterRef

Creates a new IClusterRef from a identifier.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • identifier (String)

Returns:



125
126
127
128
129
130
 
# File 'dsql/cfn_cluster.rb', line 125

def self.from_identifier(scope, id, identifier)
  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(identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identifier")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dsql.CfnCluster", "fromIdentifier", [scope, id, identifier])
end

.is_cfn_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


136
137
138
139
 
# File 'dsql/cfn_cluster.rb', line 136

def self.is_cfn_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dsql.CfnCluster", "isCfnCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'dsql/cfn_cluster.rb', line 56

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_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_encryption_details => { kind: :property, name: "attrEncryptionDetails", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_identifier => { kind: :property, name: "attrIdentifier", is_optional: false },
    :attr_policy_version => { kind: :property, name: "attrPolicyVersion", is_optional: false },
    :attr_resource_arn => { kind: :property, name: "attrResourceArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_vpc_endpoint => { kind: :property, name: "attrVpcEndpoint", is_optional: false },
    :attr_vpc_endpoint_service_name => { kind: :property, name: "attrVpcEndpointServiceName", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :deletion_protection_enabled => { kind: :property, name: "deletionProtectionEnabled", is_optional: true },
    :kms_encryption_key => { kind: :property, name: "kmsEncryptionKey", is_optional: true },
    :multi_region_properties => { kind: :property, name: "multiRegionProperties", is_optional: true },
    :policy_document => { kind: :property, name: "policyDocument", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



425
426
427
428
 
# File 'dsql/cfn_cluster.rb', line 425

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:



437
438
439
440
 
# File 'dsql/cfn_cluster.rb', line 437

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:



447
448
449
450
 
# File 'dsql/cfn_cluster.rb', line 447

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:



458
459
460
461
462
 
# File 'dsql/cfn_cluster.rb', line 458

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.


515
516
517
518
519
 
# File 'dsql/cfn_cluster.rb', line 515

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.



525
526
527
528
 
# File 'dsql/cfn_cluster.rb', line 525

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.



537
538
539
540
541
 
# File 'dsql/cfn_cluster.rb', line 537

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

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



550
551
552
553
 
# File 'dsql/cfn_cluster.rb', line 550

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:



572
573
574
575
576
577
 
# File 'dsql/cfn_cluster.rb', line 572

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_creation_time ⇒ String

The timestamp when the cluster was created, in ISO 8601 format.

Returns:

  • (String) 


241
242
243
 
# File 'dsql/cfn_cluster.rb', line 241

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_encryption_details ⇒ AWSCDK::IResolvable

The encryption configuration details for the cluster.

Returns:



248
249
250
 
# File 'dsql/cfn_cluster.rb', line 248

def attr_encryption_details()
  jsii_get_property("attrEncryptionDetails")
end

#attr_endpoint ⇒ String

The connection endpoint for the created cluster.

Returns:

  • (String) 


255
256
257
 
# File 'dsql/cfn_cluster.rb', line 255

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_identifier ⇒ String

The unique identifier assigned to the cluster upon creation.

Returns:

  • (String) 


262
263
264
 
# File 'dsql/cfn_cluster.rb', line 262

def attr_identifier()
  jsii_get_property("attrIdentifier")
end

#attr_policy_version ⇒ String

The version number of the cluster's resource based policy.

Returns:

  • (String) 


269
270
271
 
# File 'dsql/cfn_cluster.rb', line 269

def attr_policy_version()
  jsii_get_property("attrPolicyVersion")
end

#attr_resource_arn ⇒ String

The Amazon Resource Name (ARN) of the cluster.

Used for IAM permissions and resource identification.

Returns:

  • (String) 


278
279
280
 
# File 'dsql/cfn_cluster.rb', line 278

def attr_resource_arn()
  jsii_get_property("attrResourceArn")
end

#attr_status ⇒ String

The current status of the cluster. Possible values include: CREATING, ACTIVE, DELETING, FAILED.

The cluster can have two additional status values when working with multi-Region clusters:

PENDING_SETUP —Indicates the cluster is being configured

PENDING_DELETE —Indicates the cluster is being deleted

Note: These status values only appear for multi-Region cluster operations.

Returns:

  • (String) 


293
294
295
 
# File 'dsql/cfn_cluster.rb', line 293

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_vpc_endpoint ⇒ String

The DSQL cluster VPC endpoint.

Returns:

  • (String) 


300
301
302
 
# File 'dsql/cfn_cluster.rb', line 300

def attr_vpc_endpoint()
  jsii_get_property("attrVpcEndpoint")
end

#attr_vpc_endpoint_service_name ⇒ String

The VPC Endpoint Service name for the cluster.

This can be used to create a VPC endpoint to connect to the cluster from within a VPC.

Returns:

  • (String) 


309
310
311
 
# File 'dsql/cfn_cluster.rb', line 309

def attr_vpc_endpoint_service_name()
  jsii_get_property("attrVpcEndpointServiceName")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



316
317
318
 
# File 'dsql/cfn_cluster.rb', line 316

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



187
188
189
 
# File 'dsql/cfn_cluster.rb', line 187

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


192
193
194
 
# File 'dsql/cfn_cluster.rb', line 192

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


581
582
583
584
 
# File 'dsql/cfn_cluster.rb', line 581

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


197
198
199
 
# File 'dsql/cfn_cluster.rb', line 197

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


204
205
206
 
# File 'dsql/cfn_cluster.rb', line 204

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_ref ⇒ AWSCDK::Interfaces::AWSDSQL::ClusterReference

A reference to a Cluster resource.

Returns:



323
324
325
 
# File 'dsql/cfn_cluster.rb', line 323

def cluster_ref()
  jsii_get_property("clusterRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


149
150
151
 
# File 'dsql/cfn_cluster.rb', line 149

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection_enabled ⇒ Boolean, ...

Whether deletion protection is enabled on this cluster.

Returns:



330
331
332
 
# File 'dsql/cfn_cluster.rb', line 330

def deletion_protection_enabled()
  jsii_get_property("deletionProtectionEnabled")
end

#deletion_protection_enabled=(value) ⇒ Object 



334
335
336
337
 
# File 'dsql/cfn_cluster.rb', line 334

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



209
210
211
 
# File 'dsql/cfn_cluster.rb', line 209

def env()
  jsii_get_property("env")
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:



594
595
596
597
598
 
# File 'dsql/cfn_cluster.rb', line 594

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:



605
606
607
608
 
# File 'dsql/cfn_cluster.rb', line 605

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



675
676
677
678
 
# File 'dsql/cfn_cluster.rb', line 675

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

#kms_encryption_key ⇒ String?

The KMS key that encrypts data on the cluster.

Returns:

  • (String, nil) 


342
343
344
 
# File 'dsql/cfn_cluster.rb', line 342

def kms_encryption_key()
  jsii_get_property("kmsEncryptionKey")
end

#kms_encryption_key=(value) ⇒ Object 



346
347
348
349
 
# File 'dsql/cfn_cluster.rb', line 346

def kms_encryption_key=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsEncryptionKey") unless value.nil?
  jsii_set_property("kmsEncryptionKey", 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) 


161
162
163
 
# File 'dsql/cfn_cluster.rb', line 161

def logical_id()
  jsii_get_property("logicalId")
end

#multi_region_properties ⇒ AWSCDK::IResolvable, ...

Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

Returns:



354
355
356
 
# File 'dsql/cfn_cluster.rb', line 354

def multi_region_properties()
  jsii_get_property("multiRegionProperties")
end

#multi_region_properties=(value) ⇒ Object 



358
359
360
361
362
 
# File 'dsql/cfn_cluster.rb', line 358

def multi_region_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DSQL::CfnCluster::MultiRegionPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kc3FsLkNmbkNsdXN0ZXIuTXVsdGlSZWdpb25Qcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "multiRegionProperties") unless value.nil?
  jsii_set_property("multiRegionProperties", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


144
145
146
 
# File 'dsql/cfn_cluster.rb', line 144

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:



616
617
618
 
# File 'dsql/cfn_cluster.rb', line 616

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:



623
624
625
 
# File 'dsql/cfn_cluster.rb', line 623

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.



416
417
418
419
 
# File 'dsql/cfn_cluster.rb', line 416

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

#policy_document ⇒ String?

A resource-based policy document in JSON format.

Returns:

  • (String, nil) 


367
368
369
 
# File 'dsql/cfn_cluster.rb', line 367

def policy_document()
  jsii_get_property("policyDocument")
end

#policy_document=(value) ⇒ Object 



371
372
373
374
 
# File 'dsql/cfn_cluster.rb', line 371

def policy_document=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyDocument") unless value.nil?
  jsii_set_property("policyDocument", 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) 


180
181
182
 
# File 'dsql/cfn_cluster.rb', line 180

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:



634
635
636
637
 
# File 'dsql/cfn_cluster.rb', line 634

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


641
642
643
644
 
# File 'dsql/cfn_cluster.rb', line 641

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:



651
652
653
654
655
 
# File 'dsql/cfn_cluster.rb', line 651

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.



660
661
662
 
# File 'dsql/cfn_cluster.rb', line 660

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



170
171
172
 
# File 'dsql/cfn_cluster.rb', line 170

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A map of key and value pairs this cluster is tagged with.

Returns:



379
380
381
 
# File 'dsql/cfn_cluster.rb', line 379

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



383
384
385
386
387
 
# File 'dsql/cfn_cluster.rb', line 383

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



392
393
394
 
# File 'dsql/cfn_cluster.rb', line 392

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


217
218
219
 
# File 'dsql/cfn_cluster.rb', line 217

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


227
228
229
 
# File 'dsql/cfn_cluster.rb', line 227

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


666
667
668
669
 
# File 'dsql/cfn_cluster.rb', line 666

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) 


405
406
407
408
409
410
 
# File 'dsql/cfn_cluster.rb', line 405

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