software.amazon.awscdk.services.rds

Class ServerlessClusterFromSnapshot

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.rds.ServerlessClusterFromSnapshot

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IServerlessCluster, ISecretAttachmentTarget

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.329Z")
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 interface software.amazon.awscdk.services.rds.IServerlessCluster

IServerlessCluster.Jsii$Default, IServerlessCluster.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the secret attachment target specifications.
java.lang.String	getClusterArn() The ARN of the cluster.
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
java.lang.String	getClusterIdentifier() Identifier of the cluster.
Endpoint	getClusterReadEndpoint() The endpoint to use for read/write operations.
Connections	getConnections() Access to the network connections.
protected java.lang.Boolean	getEnableDataApi()
protected CfnDBClusterProps	getNewCfnProps()
ISecret	getSecret() The secret attached to this cluster.
protected java.util.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(java.lang.Boolean value)

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

ServerlessClusterFromSnapshot

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

ServerlessClusterFromSnapshot

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

ServerlessClusterFromSnapshot

public ServerlessClusterFromSnapshot(software.constructs.Construct scope,
                                     java.lang.String id,
                                     ServerlessClusterFromSnapshotProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

asSecretAttachmentTarget

public SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

grantDataApiAccess

public 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.

Specified by:

grantDataApiAccess in interface IServerlessCluster

Parameters:

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

getClusterArn

public java.lang.String getClusterArn()

The ARN of the cluster.

Specified by:

getClusterArn in interface IServerlessCluster

getClusterEndpoint

public Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IServerlessCluster

getClusterIdentifier

public java.lang.String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IServerlessCluster

getClusterReadEndpoint

public Endpoint getClusterReadEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterReadEndpoint in interface IServerlessCluster

getConnections

public Connections getConnections()

Access to the network connections.

Specified by:

getConnections in interface IConnectable

getNewCfnProps

protected CfnDBClusterProps getNewCfnProps()

getSecurityGroups

protected java.util.List<ISecurityGroup> getSecurityGroups()

getSecret

public ISecret getSecret()

The secret attached to this cluster.

getEnableDataApi

protected java.lang.Boolean getEnableDataApi()

setEnableDataApi

protected void setEnableDataApi(java.lang.Boolean value)