Class: AWSCDK::RDS::ServerlessClusterFromSnapshot

Inherits:
AWSCDK::Resource
  • Object
show all
Includes:
IServerlessCluster
Defined in:
rds/serverless_cluster_from_snapshot.rb

Overview

A Aurora Serverless v1 Cluster restored from a snapshot.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ ServerlessClusterFromSnapshot

Returns a new instance of ServerlessClusterFromSnapshot.

Parameters:



12
13
14
15
16
17
18
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::RDS::ServerlessClusterFromSnapshotProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlNlcnZlcmxlc3NDbHVzdGVyRnJvbVNuYXBzaG90UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :cluster_arn => { kind: :property, name: "clusterArn", is_optional: false },
    :cluster_endpoint => { kind: :property, name: "clusterEndpoint", is_optional: false },
    :cluster_identifier => { kind: :property, name: "clusterIdentifier", is_optional: false },
    :cluster_read_endpoint => { kind: :property, name: "clusterReadEndpoint", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :db_cluster_ref => { kind: :property, name: "dbClusterRef", is_optional: false },
    :new_cfn_props => { kind: :property, name: "newCfnProps", is_optional: false },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: false },
    :secret => { kind: :property, name: "secret", is_optional: true },
    :enable_data_api => { kind: :property, name: "enableDataApi", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :as_secret_attachment_target => { kind: :method, name: "asSecretAttachmentTarget", is_optional: false },
    :grant_data_api_access => { kind: :method, name: "grantDataApiAccess", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


94
95
96
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 94

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rds.ServerlessClusterFromSnapshot", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



200
201
202
203
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 200

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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:



217
218
219
220
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 217

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#as_secret_attachment_target ⇒ AWSCDK::SecretsManager::SecretAttachmentTargetProps

Renders the secret attachment target specifications.

Returns:



260
261
262
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 260

def as_secret_attachment_target()
  jsii_call_method("asSecretAttachmentTarget", [])
end

#cluster_arn ⇒ String

The ARN of the cluster.

Returns:

  • (String) 


101
102
103
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 101

def cluster_arn()
  jsii_get_property("clusterArn")
end

#cluster_endpoint ⇒ AWSCDK::RDS::Endpoint

The endpoint to use for read/write operations.

Returns:



108
109
110
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 108

def cluster_endpoint()
  jsii_get_property("clusterEndpoint")
end

#cluster_identifier ⇒ String

Identifier of the cluster.

Returns:

  • (String) 


115
116
117
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 115

def cluster_identifier()
  jsii_get_property("clusterIdentifier")
end

#cluster_read_endpoint ⇒ AWSCDK::RDS::Endpoint

The endpoint to use for read/write operations.

Returns:



122
123
124
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 122

def cluster_read_endpoint()
  jsii_get_property("clusterReadEndpoint")
end

#connections ⇒ AWSCDK::EC2::Connections

Access to the network connections.

Returns:



129
130
131
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 129

def connections()
  jsii_get_property("connections")
end

#db_cluster_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBClusterReference

A reference to this serverless cluster.

Returns:



136
137
138
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 136

def db_cluster_ref()
  jsii_get_property("dbClusterRef")
end

#enable_data_api ⇒ Boolean?

Returns:

  • (Boolean, nil) 


158
159
160
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 158

def enable_data_api()
  jsii_get_property("enableDataApi")
end

#enable_data_api=(value) ⇒ Object 



162
163
164
165
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 162

def enable_data_api=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enableDataApi") unless value.nil?
  jsii_set_property("enableDataApi", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



66
67
68
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 66

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


223
224
225
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 223

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


237
238
239
240
241
242
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 237

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


252
253
254
255
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 252

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_data_api_access(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present.

[disable-awslint:no-grants]

Parameters:

Returns:



270
271
272
273
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 270

def grant_data_api_access(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantDataApiAccess", [grantee])
end

#new_cfn_props ⇒ AWSCDK::RDS::CfnDBClusterProps

Returns:



141
142
143
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 141

def new_cfn_props()
  jsii_get_property("newCfnProps")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


51
52
53
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 51

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


80
81
82
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 80

def physical_name()
  jsii_get_property("physicalName")
end

#secret ⇒ AWSCDK::SecretsManager::ISecret?

The secret attached to this cluster.

Returns:



153
154
155
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 153

def secret()
  jsii_get_property("secret")
end

#security_groups ⇒ Array<AWSCDK::EC2::ISecurityGroup>

Returns:



146
147
148
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 146

def security_groups()
  jsii_get_property("securityGroups")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



87
88
89
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 87

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


170
171
172
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 170

def to_string()
  jsii_call_method("toString", [])
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) 


183
184
185
186
187
188
 
# File 'rds/serverless_cluster_from_snapshot.rb', line 183

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