Class ServerlessClusterFromSnapshot

A Aurora Serverless v1 Cluster restored from a snapshot.

Inheritance
object
Resource
ServerlessClusterFromSnapshot
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ServerlessClusterFromSnapshot : Resource, IServerlessCluster, IResource, IConnectable, ISecretAttachmentTarget, IDBClusterRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class ServerlessClusterFromSnapshot Inherits Resource Implements IServerlessCluster, IResource, IConnectable, ISecretAttachmentTarget, IDBClusterRef, IConstruct, IDependable, IEnvironmentAware
Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Examples
Vpc vpc;

             new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 SnapshotIdentifier = "mySnapshot"
             });

Synopsis

Constructors

ServerlessClusterFromSnapshot(Construct, string, IServerlessClusterFromSnapshotProps)

A Aurora Serverless v1 Cluster restored from a snapshot.

Properties

ClusterArn

The ARN of the cluster.
ClusterEndpoint

The endpoint to use for read/write operations.
ClusterIdentifier

Identifier of the cluster.
ClusterReadEndpoint

The endpoint to use for read/write operations.
Connections

Access to the network connections.
DbClusterRef

A reference to this serverless cluster.
EnableDataApi

A Aurora Serverless v1 Cluster restored from a snapshot.
NewCfnProps

A Aurora Serverless v1 Cluster restored from a snapshot.
PROPERTY_INJECTION_ID

Uniquely identifies this class.
Secret

The secret attached to this cluster.
SecurityGroups

A Aurora Serverless v1 Cluster restored from a snapshot.

Methods

AsSecretAttachmentTarget()

Renders the secret attachment target specifications.
GrantDataApiAccess(IGrantable)

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

Constructors

ServerlessClusterFromSnapshot(Construct, string, IServerlessClusterFromSnapshotProps)

A Aurora Serverless v1 Cluster restored from a snapshot.

public ServerlessClusterFromSnapshot(Construct scope, string id, IServerlessClusterFromSnapshotProps props)
Parameters
scope Construct
id string
props IServerlessClusterFromSnapshotProps
Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Examples
Vpc vpc;

             new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 SnapshotIdentifier = "mySnapshot"
             });

Properties

ClusterArn

The ARN of the cluster.

public virtual string ClusterArn { get; }
Property Value

string

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

ClusterEndpoint

The endpoint to use for read/write operations.

public virtual Endpoint ClusterEndpoint { get; }
Property Value

Endpoint

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

ClusterIdentifier

Identifier of the cluster.

public virtual string ClusterIdentifier { get; }
Property Value

string

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

ClusterReadEndpoint

The endpoint to use for read/write operations.

public virtual Endpoint ClusterReadEndpoint { get; }
Property Value

Endpoint

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Connections

Access to the network connections.

public virtual Connections_ Connections { get; }
Property Value

Connections_

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

DbClusterRef

A reference to this serverless cluster.

public virtual IDBClusterReference DbClusterRef { get; }
Property Value

IDBClusterReference

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

EnableDataApi

A Aurora Serverless v1 Cluster restored from a snapshot.

protected virtual bool? EnableDataApi { get; set; }
Property Value

bool?

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Examples
Vpc vpc;

             new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 SnapshotIdentifier = "mySnapshot"
             });

NewCfnProps

A Aurora Serverless v1 Cluster restored from a snapshot.

protected virtual ICfnDBClusterProps NewCfnProps { get; }
Property Value

ICfnDBClusterProps

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Examples
Vpc vpc;

             new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 SnapshotIdentifier = "mySnapshot"
             });

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Secret

The secret attached to this cluster.

public virtual ISecret? Secret { get; }
Property Value

ISecret

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

SecurityGroups

A Aurora Serverless v1 Cluster restored from a snapshot.

protected virtual ISecurityGroup[] SecurityGroups { get; }
Property Value

ISecurityGroup[]

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

Examples
Vpc vpc;

             new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 SnapshotIdentifier = "mySnapshot"
             });

Methods

AsSecretAttachmentTarget()

Renders the secret attachment target specifications.

public virtual ISecretAttachmentTargetProps AsSecretAttachmentTarget()
Returns

ISecretAttachmentTargetProps

Remarks

Resource: AWS::RDS::DBCluster

ExampleMetadata: infused

GrantDataApiAccess(IGrantable)

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

public virtual Grant GrantDataApiAccess(IGrantable grantee)
Parameters
grantee IGrantable

The principal to grant access to.

Returns

Grant

Remarks

[disable-awslint:no-grants]

Implements

Constructs.IConstruct
Constructs.IDependable