Module: AWSCDK::RDS::IAuroraClusterInstance

Includes:
IResource, Interfaces::AWSRDS::IDBInstanceRef
Defined in:
rds/i_aurora_cluster_instance.rb

Overview

An Aurora Cluster Instance.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'rds/i_aurora_cluster_instance.rb', line 146

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :db_instance_ref => { kind: :property, name: "dbInstanceRef", is_optional: false },
    :db_instance_arn => { kind: :property, name: "dbInstanceArn", is_optional: false },
    :db_instance_endpoint_address => { kind: :property, name: "dbInstanceEndpointAddress", is_optional: false },
    :dbi_resource_id => { kind: :property, name: "dbiResourceId", is_optional: false },
    :instance_identifier => { kind: :property, name: "instanceIdentifier", is_optional: false },
    :tier => { kind: :property, name: "tier", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :instance_size => { kind: :property, name: "instanceSize", is_optional: true },
    :performance_insight_encryption_key => { kind: :property, name: "performanceInsightEncryptionKey", is_optional: true },
    :performance_insight_retention => { kind: :property, name: "performanceInsightRetention", is_optional: true },
    :performance_insights_enabled => { kind: :property, name: "performanceInsightsEnabled", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

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



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

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

#db_instance_arn ⇒ String

The instance ARN.

Returns:

  • (String) 


48
49
50
 
# File 'rds/i_aurora_cluster_instance.rb', line 48

def db_instance_arn()
  jsii_get_property("dbInstanceArn")
end

#db_instance_endpoint_address ⇒ String

The instance endpoint address.

Returns:

  • (String) 


55
56
57
 
# File 'rds/i_aurora_cluster_instance.rb', line 55

def db_instance_endpoint_address()
  jsii_get_property("dbInstanceEndpointAddress")
end

#db_instance_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBInstanceReference

A reference to a DBInstance resource.

Returns:



41
42
43
 
# File 'rds/i_aurora_cluster_instance.rb', line 41

def db_instance_ref()
  jsii_get_property("dbInstanceRef")
end

#dbi_resource_id ⇒ String

The instance resource ID.

Returns:

  • (String) 


62
63
64
 
# File 'rds/i_aurora_cluster_instance.rb', line 62

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



27
28
29
 
# File 'rds/i_aurora_cluster_instance.rb', line 27

def env()
  jsii_get_property("env")
end

#instance_identifier ⇒ String

The instance identifier.

Returns:

  • (String) 


69
70
71
 
# File 'rds/i_aurora_cluster_instance.rb', line 69

def instance_identifier()
  jsii_get_property("instanceIdentifier")
end

#instance_size ⇒ String?

The instance size if the instance is a provisioned type.

Returns:

  • (String, nil) 


90
91
92
 
# File 'rds/i_aurora_cluster_instance.rb', line 90

def instance_size()
  jsii_get_property("instanceSize")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'rds/i_aurora_cluster_instance.rb', line 12

def node()
  jsii_get_property("node")
end

#performance_insight_encryption_key ⇒ AWSCDK::KMS::IKey?

The AWS KMS key for encryption of Performance Insights data.

Returns:



97
98
99
 
# File 'rds/i_aurora_cluster_instance.rb', line 97

def performance_insight_encryption_key()
  jsii_get_property("performanceInsightEncryptionKey")
end

#performance_insight_retention ⇒ AWSCDK::RDS::PerformanceInsightRetention?

The amount of time, in days, to retain Performance Insights data.

Returns:



104
105
106
 
# File 'rds/i_aurora_cluster_instance.rb', line 104

def performance_insight_retention()
  jsii_get_property("performanceInsightRetention")
end

#performance_insights_enabled ⇒ Boolean?

Whether Performance Insights is enabled.

Returns:

  • (Boolean, nil) 


111
112
113
 
# File 'rds/i_aurora_cluster_instance.rb', line 111

def performance_insights_enabled()
  jsii_get_property("performanceInsightsEnabled")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'rds/i_aurora_cluster_instance.rb', line 34

def stack()
  jsii_get_property("stack")
end

#tier ⇒ Numeric

The promotion tier the instance was created in.

Returns:

  • (Numeric) 


76
77
78
 
# File 'rds/i_aurora_cluster_instance.rb', line 76

def tier()
  jsii_get_property("tier")
end

#type ⇒ AWSCDK::RDS::InstanceType

The instance type (provisioned vs serverless v2).

Returns:



83
84
85
 
# File 'rds/i_aurora_cluster_instance.rb', line 83

def type()
  jsii_get_property("type")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



122
123
124
125
126
127
 
# File 'rds/i_aurora_cluster_instance.rb', line 122

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