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
,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$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.neptune.alpha.IDatabaseCluster
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
applyRemovalPolicy
(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 Connections
The network connections associated with this resource.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default software.constructs.Node
getNode()
The tree node.default Stack
getStack()
The stack in which this resource is defined.default Grant
grant
(IGrantable grantee, @NotNull String... actions) (experimental) Grant the given identity the specified actions.default Grant
grantConnect
(IGrantable grantee) (experimental) Grant the given identity connection access to the database.default Metric
metric
(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
metric
Methods 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:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
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.
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in interfaceIConnectable.Jsii$Default
-
getClusterEndpoint
(experimental) The endpoint to use for read/write operations.- Specified by:
getClusterEndpoint
in interfaceIDatabaseCluster
-
getClusterIdentifier
(experimental) Identifier of the cluster.- Specified by:
getClusterIdentifier
in interfaceIDatabaseCluster
-
getClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpoint
in interfaceIDatabaseCluster
-
getClusterResourceIdentifier
(experimental) Resource identifier of the cluster.- Specified by:
getClusterResourceIdentifier
in 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:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grant
@Stability(Experimental) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) (experimental) Grant the given identity the specified actions.- Specified by:
grant
in 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:
grantConnect
in 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:
metric
in interfaceIDatabaseCluster
- Parameters:
metricName
- This parameter is required.props
-- See Also:
-