software.amazon.awscdk.services.rds

Class ServerlessClusterFromSnapshot

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.ServerlessClusterFromSnapshot

All Implemented Interfaces:

IResource, IConnectable, IServerlessCluster, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.505Z")
 @Stability(value=Stable)
public class ServerlessClusterFromSnapshot
extends Resource
implements IServerlessCluster

A Aurora Serverless Cluster restored from a snapshot.

Example:

 Vpc vpc;
 ServerlessClusterFromSnapshot.Builder.create(this, "Cluster")
         .engine(DatabaseClusterEngine.AURORA_MYSQL)
         .vpc(vpc)
         .snapshotIdentifier("mySnapshot")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerlessClusterFromSnapshot.Builder A fluent builder for ServerlessClusterFromSnapshot.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IServerlessCluster

IServerlessCluster.Jsii$Default, IServerlessCluster.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ServerlessClusterFromSnapshot(software.constructs.Construct scope, String id, ServerlessClusterFromSnapshotProps props)
protected	ServerlessClusterFromSnapshot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ServerlessClusterFromSnapshot(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the secret attachment target specifications.
String	getClusterArn() The ARN of the cluster.
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
String	getClusterIdentifier() Identifier of the cluster.
Endpoint	getClusterReadEndpoint() The endpoint to use for read/write operations.
Connections	getConnections() Access to the network connections.
protected Boolean	getEnableDataApi()
protected CfnDBClusterProps	getNewCfnProps()
ISecret	getSecret() The secret attached to this cluster.
protected List<ISecurityGroup>	getSecurityGroups()
Grant	grantDataApiAccess(IGrantable grantee) Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present.
protected void	setEnableDataApi(Boolean value)

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ServerlessClusterFromSnapshot

protected ServerlessClusterFromSnapshot(software.amazon.jsii.JsiiObjectRef objRef)

ServerlessClusterFromSnapshot

protected ServerlessClusterFromSnapshot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ServerlessClusterFromSnapshot

@Stability(value=Stable)
public ServerlessClusterFromSnapshot(@NotNull
                                                              software.constructs.Construct scope,
                                                              @NotNull
                                                              String id,
                                                              @NotNull
                                                              ServerlessClusterFromSnapshotProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

asSecretAttachmentTarget

@Stability(value=Stable)
 @NotNull
public SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

grantDataApiAccess

@Stability(value=Stable)
 @NotNull
public Grant grantDataApiAccess(@NotNull
                                                                   IGrantable grantee)

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

Specified by:

grantDataApiAccess in interface IServerlessCluster

Parameters:

grantee - The principal to grant access to. This parameter is required.

getClusterArn

@Stability(value=Stable)
 @NotNull
public String getClusterArn()

The ARN of the cluster.

Specified by:

getClusterArn in interface IServerlessCluster

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
public Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IServerlessCluster

getClusterIdentifier

@Stability(value=Stable)
 @NotNull
public String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IServerlessCluster

getClusterReadEndpoint

@Stability(value=Stable)
 @NotNull
public Endpoint getClusterReadEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterReadEndpoint in interface IServerlessCluster

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Access to the network connections.

Specified by:

getConnections in interface IConnectable

getNewCfnProps

@Stability(value=Stable)
 @NotNull
protected CfnDBClusterProps getNewCfnProps()

getSecurityGroups

@Stability(value=Stable)
 @NotNull
protected List<ISecurityGroup> getSecurityGroups()

getSecret

@Stability(value=Stable)
 @Nullable
public ISecret getSecret()

The secret attached to this cluster.

getEnableDataApi

@Stability(value=Stable)
 @Nullable
protected Boolean getEnableDataApi()

setEnableDataApi

@Stability(value=Stable)
protected void setEnableDataApi(@Nullable
                                                         Boolean value)