Interface IDatabaseCluster.Jsii$Default
- All Superinterfaces:
IConnectable,IConnectable.Jsii$Default,software.constructs.IConstruct,software.constructs.IConstruct.Jsii$Default,IDatabaseCluster,software.constructs.IDependable,software.constructs.IDependable.Jsii$Default,IEnvironmentAware,IEnvironmentAware.Jsii$Default,IResource,IResource.Jsii$Default,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IDatabaseCluster.Jsii$Proxy
- Enclosing interface:
IDatabaseCluster
IDatabaseCluster.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.neptune.alpha.IDatabaseCluster
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy -
Method Summary
Modifier and TypeMethodDescriptiondefault voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.default Endpoint(experimental) The endpoint to use for read/write operations.default String(experimental) Identifier of the cluster.default Endpoint(experimental) Endpoint to use for load-balanced read-only operations.default String(experimental) Resource identifier of the cluster.default ConnectionsThe network connections associated with this resource.default ResourceEnvironmentgetEnv()The environment this resource belongs to.default software.constructs.NodegetNode()The tree node.default StackgetStack()The stack in which this resource is defined.default Grantgrant(IGrantable grantee, String... actions) (experimental) Grant the given identity the specified actions.default GrantgrantConnect(IGrantable grantee) (experimental) Grant the given identity connection access to the database.default Metricmetric(String metricName, MetricOptions props) (experimental) Return the given named metric associated with this DatabaseCluster instance.Methods inherited from interface software.amazon.awscdk.services.neptune.alpha.IDatabaseCluster
metricMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNodein interfacesoftware.constructs.IConstruct- Specified by:
getNodein interfacesoftware.constructs.IConstruct.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default
-
getEnv
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.- Specified by:
getEnvin interfaceIEnvironmentAware- Specified by:
getEnvin interfaceIEnvironmentAware.Jsii$Default- Specified by:
getEnvin interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnectionsin interfaceIConnectable- Specified by:
getConnectionsin interfaceIConnectable.Jsii$Default
-
getClusterEndpoint
(experimental) The endpoint to use for read/write operations.- Specified by:
getClusterEndpointin interfaceIDatabaseCluster
-
getClusterIdentifier
(experimental) Identifier of the cluster.- Specified by:
getClusterIdentifierin interfaceIDatabaseCluster
-
getClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpointin interfaceIDatabaseCluster
-
getClusterResourceIdentifier
(experimental) Resource identifier of the cluster.- Specified by:
getClusterResourceIdentifierin interfaceIDatabaseCluster
-
applyRemovalPolicy
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).- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Parameters:
policy- This parameter is required.
-
grant
@Stability(Experimental) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions) (experimental) Grant the given identity the specified actions.- Specified by:
grantin interfaceIDatabaseCluster- Parameters:
grantee- the identity to be granted the actions. This parameter is required.actions- the data-access actions. This parameter is required.- See Also:
-
grantConnect
(experimental) Grant the given identity connection access to the database.- Specified by:
grantConnectin interfaceIDatabaseCluster- Parameters:
grantee- This parameter is required.
-
metric
@Stability(Experimental) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric associated with this DatabaseCluster instance.- Specified by:
metricin interfaceIDatabaseCluster- Parameters:
metricName- This parameter is required.props-- See Also:
-