Package software.amazon.awscdk.services.rds

Interface DatabaseInstanceAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseInstanceAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:43.513Z")
@Stability(Stable)
public interface DatabaseInstanceAttributes
extends software.amazon.jsii.JsiiSerializable

Properties that describe an existing instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 IInstanceEngine instanceEngine;
 SecurityGroup securityGroup;
 DatabaseInstanceAttributes databaseInstanceAttributes = DatabaseInstanceAttributes.builder()
         .instanceEndpointAddress("instanceEndpointAddress")
         .instanceIdentifier("instanceIdentifier")
         .port(123)
         .securityGroups(List.of(securityGroup))
         // the properties below are optional
         .engine(instanceEngine)
         .instanceResourceId("instanceResourceId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatabaseInstanceAttributes.Builder	A builder for DatabaseInstanceAttributes
static final class	DatabaseInstanceAttributes.Jsii$Proxy	An implementation for DatabaseInstanceAttributes

Method Summary

Modifier and Type	Method	Description
static DatabaseInstanceAttributes.Builder	builder()
default IInstanceEngine	getEngine()	The engine of the existing database Instance.
String	getInstanceEndpointAddress()	The endpoint address.
String	getInstanceIdentifier()	The instance identifier.
default String	getInstanceResourceId()	The AWS Region-unique, immutable identifier for the DB instance.
Number	getPort()	The database port.
List<ISecurityGroup>	getSecurityGroups()	The security groups of the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceEndpointAddress

@Stability(Stable)
@NotNull
String getInstanceEndpointAddress()

The endpoint address.

getInstanceIdentifier

@Stability(Stable)
@NotNull
String getInstanceIdentifier()

The instance identifier.

getPort

@Stability(Stable)
@NotNull
Number getPort()

The database port.

getSecurityGroups

@Stability(Stable)
@NotNull
List<ISecurityGroup> getSecurityGroups()

The security groups of the instance.

getEngine

@Stability(Stable)
@Nullable
default IInstanceEngine getEngine()

The engine of the existing database Instance.

Default: - the imported Instance's engine is unknown

getInstanceResourceId

@Stability(Stable)
@Nullable
default String getInstanceResourceId()

The AWS Region-unique, immutable identifier for the DB instance.

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values

builder

@Stability(Stable)
static DatabaseInstanceAttributes.Builder builder()

Returns:

a DatabaseInstanceAttributes.Builder of DatabaseInstanceAttributes