interface IAuroraClusterInstance
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.IAuroraClusterInstance |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#IAuroraClusterInstance |
![]() | software.amazon.awscdk.services.rds.IAuroraClusterInstance |
![]() | aws_cdk.aws_rds.IAuroraClusterInstance |
![]() | aws-cdk-lib » aws_rds » IAuroraClusterInstance |
Obtainable from
Cluster
.bind()
An Aurora Cluster Instance.
Properties
Name | Type | Description |
---|---|---|
db | string | The instance ARN. |
db | string | The instance endpoint address. |
dbi | string | The instance resource ID. |
env | Resource | The environment this resource belongs to. |
instance | string | The instance identifier. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
tier | number | The promotion tier the instance was created in. |
type | Instance | The instance type (provisioned vs serverless v2). |
instance | string | The instance size if the instance is a provisioned type. |
performance | IKey | The AWS KMS key for encryption of Performance Insights data. |
performance | Performance | The amount of time, in days, to retain Performance Insights data. |
performance | boolean | Whether Performance Insights is enabled. |
dbInstanceArn
Type:
string
The instance ARN.
dbInstanceEndpointAddress
Type:
string
The instance endpoint address.
dbiResourceId
Type:
string
The instance resource ID.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
instanceIdentifier
Type:
string
The instance identifier.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
tier
Type:
number
The promotion tier the instance was created in.
type
Type:
Instance
The instance type (provisioned vs serverless v2).
instanceSize?
Type:
string
(optional)
The instance size if the instance is a provisioned type.
performanceInsightEncryptionKey?
Type:
IKey
(optional)
The AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention?
Type:
Performance
(optional)
The amount of time, in days, to retain Performance Insights data.
performanceInsightsEnabled?
Type:
boolean
(optional)
Whether Performance Insights is enabled.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).