AWS Native v0.63.0, May 25 23

aws-native.rds.getDBInstance

Explore with Pulumi AI

The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance.

Using getDBInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDBInstance(args: GetDBInstanceArgs, opts?: InvokeOptions): Promise<GetDBInstanceResult>
function getDBInstanceOutput(args: GetDBInstanceOutputArgs, opts?: InvokeOptions): Output<GetDBInstanceResult>

def get_db_instance(d_b_instance_identifier: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDBInstanceResult
def get_db_instance_output(d_b_instance_identifier: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDBInstanceResult]

func LookupDBInstance(ctx *Context, args *LookupDBInstanceArgs, opts ...InvokeOption) (*LookupDBInstanceResult, error)
func LookupDBInstanceOutput(ctx *Context, args *LookupDBInstanceOutputArgs, opts ...InvokeOption) LookupDBInstanceResultOutput

> Note: This function is named LookupDBInstance in the Go SDK.

public static class GetDBInstance 
{
    public static Task<GetDBInstanceResult> InvokeAsync(GetDBInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetDBInstanceResult> Invoke(GetDBInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDBInstanceResult> getDBInstance(GetDBInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:rds:getDBInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

DBInstanceIdentifier string: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

DBInstanceIdentifier string: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

dBInstanceIdentifier String: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

dBInstanceIdentifier string: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

d_b_instance_identifier str: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

dBInstanceIdentifier String: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.

getDBInstance Result

The following output properties are available:

AllocatedStorage string

The amount of storage (in gigabytes) to be initially allocated for the database instance.

AssociatedRoles List<Pulumi.AwsNative.RDS.Outputs.DBInstanceRole>

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

AutoMinorVersionUpgrade bool

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

AvailabilityZone string

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

BackupRetentionPeriod int

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

CACertificateIdentifier string

The identifier of the CA certificate for this DB instance.

CertificateDetails Pulumi.AwsNative.RDS.Outputs.DBInstanceCertificateDetails

Returns the details of the DB instance's server certificate.

CopyTagsToSnapshot bool

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBClusterSnapshotIdentifier string

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

DBInstanceArn string

The Amazon Resource Name (ARN) for the DB instance.

DBInstanceClass string

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

DBParameterGroupName string

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

DBSecurityGroups List<string>

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.

DBSystemId string

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

DbiResourceId string

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.

DeletionProtection bool

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Domain string

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

DomainIAMRoleName string

Specify the name of the IAM role to be used when making API calls to the Directory Service.

EnableCloudwatchLogsExports List<string>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

EnableIAMDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

EnablePerformanceInsights bool

A value that indicates whether to enable Performance Insights for the DB instance.

Endpoint Pulumi.AwsNative.RDS.Outputs.DBInstanceEndpoint

Specifies the connection endpoint.

Engine string

The name of the database engine that you want to use for this DB instance.

EngineVersion string

The version number of the database engine to use.

Iops int

The number of I/O operations per second (IOPS) that the database provisions.

LicenseModel string

License model information for this DB instance.

ManageMasterUserPassword bool

A value that indicates whether to manage the master user password with AWS Secrets Manager.

MasterUserSecret Pulumi.AwsNative.RDS.Outputs.DBInstanceMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

MaxAllocatedStorage int

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

MonitoringInterval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

MonitoringRoleArn string

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

MultiAZ bool

Specifies whether the database instance is a multiple Availability Zone deployment.

NetworkType string

The network type of the DB cluster.

OptionGroupName string

Indicates that the DB instance should be associated with the specified option group.

PerformanceInsightsKMSKeyId string

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

PerformanceInsightsRetentionPeriod int

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

PreferredMaintenanceWindow string

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

ProcessorFeatures List<Pulumi.AwsNative.RDS.Outputs.DBInstanceProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

PromotionTier int

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

PubliclyAccessible bool

Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.

ReplicaMode string

The open mode of an Oracle read replica. The default is open-read-only.

SourceDBClusterIdentifier string

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

StorageThroughput int

Specifies the storage throughput for the DB instance.

StorageType string

Specifies the storage type to be associated with the DB instance.

Tags List<Pulumi.AwsNative.RDS.Outputs.DBInstanceTag>

Tags to assign to the DB instance.

TdeCredentialArn string

The ARN from the key store with which to associate the instance for TDE encryption.

VPCSecurityGroups List<string>

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.

AllocatedStorage string

The amount of storage (in gigabytes) to be initially allocated for the database instance.

AssociatedRoles []DBInstanceRole

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

AutoMinorVersionUpgrade bool

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

AvailabilityZone string

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

BackupRetentionPeriod int

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

CACertificateIdentifier string

The identifier of the CA certificate for this DB instance.

CertificateDetails DBInstanceCertificateDetails

Returns the details of the DB instance's server certificate.

CopyTagsToSnapshot bool

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBClusterSnapshotIdentifier string

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

DBInstanceArn string

The Amazon Resource Name (ARN) for the DB instance.

DBInstanceClass string

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

DBParameterGroupName string

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

DBSecurityGroups []string

DBSystemId string

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

DbiResourceId string

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.

DeletionProtection bool

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Domain string

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

DomainIAMRoleName string

Specify the name of the IAM role to be used when making API calls to the Directory Service.

EnableCloudwatchLogsExports []string

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

EnableIAMDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

EnablePerformanceInsights bool

A value that indicates whether to enable Performance Insights for the DB instance.

Endpoint DBInstanceEndpoint

Specifies the connection endpoint.

Engine string

The name of the database engine that you want to use for this DB instance.

EngineVersion string

The version number of the database engine to use.

Iops int

The number of I/O operations per second (IOPS) that the database provisions.

LicenseModel string

License model information for this DB instance.

ManageMasterUserPassword bool

A value that indicates whether to manage the master user password with AWS Secrets Manager.

MasterUserSecret DBInstanceMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

MaxAllocatedStorage int

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

MonitoringInterval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

MonitoringRoleArn string

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

MultiAZ bool

Specifies whether the database instance is a multiple Availability Zone deployment.

NetworkType string

The network type of the DB cluster.

OptionGroupName string

Indicates that the DB instance should be associated with the specified option group.

PerformanceInsightsKMSKeyId string

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

PerformanceInsightsRetentionPeriod int

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

PreferredMaintenanceWindow string

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

ProcessorFeatures []DBInstanceProcessorFeature

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

PromotionTier int

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

PubliclyAccessible bool

ReplicaMode string

The open mode of an Oracle read replica. The default is open-read-only.

SourceDBClusterIdentifier string

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

StorageThroughput int

Specifies the storage throughput for the DB instance.

StorageType string

Specifies the storage type to be associated with the DB instance.

Tags []DBInstanceTag

Tags to assign to the DB instance.

TdeCredentialArn string

The ARN from the key store with which to associate the instance for TDE encryption.

VPCSecurityGroups []string

allocatedStorage String

The amount of storage (in gigabytes) to be initially allocated for the database instance.

associatedRoles List<DBInstanceRole>

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

autoMinorVersionUpgrade Boolean

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

availabilityZone String

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

backupRetentionPeriod Integer

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

cACertificateIdentifier String

The identifier of the CA certificate for this DB instance.

certificateDetails DBInstanceCertificateDetails

Returns the details of the DB instance's server certificate.

copyTagsToSnapshot Boolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

dBClusterSnapshotIdentifier String

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

dBInstanceArn String

The Amazon Resource Name (ARN) for the DB instance.

dBInstanceClass String

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

dBParameterGroupName String

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

dBSecurityGroups List<String>

dBSystemId String

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

dbiResourceId String

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.

deletionProtection Boolean

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain String

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

domainIAMRoleName String

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports List<String>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

enableIAMDatabaseAuthentication Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

enablePerformanceInsights Boolean

A value that indicates whether to enable Performance Insights for the DB instance.

endpoint DBInstanceEndpoint

Specifies the connection endpoint.

engine String

The name of the database engine that you want to use for this DB instance.

engineVersion String

The version number of the database engine to use.

iops Integer

The number of I/O operations per second (IOPS) that the database provisions.

licenseModel String

License model information for this DB instance.

manageMasterUserPassword Boolean

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUserSecret DBInstanceMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

maxAllocatedStorage Integer

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

monitoringInterval Integer

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn String

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

multiAZ Boolean

Specifies whether the database instance is a multiple Availability Zone deployment.

networkType String

The network type of the DB cluster.

optionGroupName String

Indicates that the DB instance should be associated with the specified option group.

performanceInsightsKMSKeyId String

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

performanceInsightsRetentionPeriod Integer

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

preferredBackupWindow String

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

preferredMaintenanceWindow String

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processorFeatures List<DBInstanceProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

promotionTier Integer

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

publiclyAccessible Boolean

replicaMode String

The open mode of an Oracle read replica. The default is open-read-only.

sourceDBClusterIdentifier String

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

storageThroughput Integer

Specifies the storage throughput for the DB instance.

storageType String

Specifies the storage type to be associated with the DB instance.

tags List<DBInstanceTag>

Tags to assign to the DB instance.

tdeCredentialArn String

The ARN from the key store with which to associate the instance for TDE encryption.

vPCSecurityGroups List<String>

allocatedStorage string

The amount of storage (in gigabytes) to be initially allocated for the database instance.

associatedRoles DBInstanceRole[]

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

autoMinorVersionUpgrade boolean

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

availabilityZone string

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

backupRetentionPeriod number

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

cACertificateIdentifier string

The identifier of the CA certificate for this DB instance.

certificateDetails DBInstanceCertificateDetails

Returns the details of the DB instance's server certificate.

copyTagsToSnapshot boolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

dBClusterSnapshotIdentifier string

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

dBInstanceArn string

The Amazon Resource Name (ARN) for the DB instance.

dBInstanceClass string

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

dBParameterGroupName string

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

dBSecurityGroups string[]

dBSystemId string

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

dbiResourceId string

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.

deletionProtection boolean

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain string

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

domainIAMRoleName string

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports string[]

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

enableIAMDatabaseAuthentication boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

enablePerformanceInsights boolean

A value that indicates whether to enable Performance Insights for the DB instance.

endpoint DBInstanceEndpoint

Specifies the connection endpoint.

engine string

The name of the database engine that you want to use for this DB instance.

engineVersion string

The version number of the database engine to use.

iops number

The number of I/O operations per second (IOPS) that the database provisions.

licenseModel string

License model information for this DB instance.

manageMasterUserPassword boolean

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUserSecret DBInstanceMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

maxAllocatedStorage number

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

monitoringInterval number

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn string

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

multiAZ boolean

Specifies whether the database instance is a multiple Availability Zone deployment.

networkType string

The network type of the DB cluster.

optionGroupName string

Indicates that the DB instance should be associated with the specified option group.

performanceInsightsKMSKeyId string

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

performanceInsightsRetentionPeriod number

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

preferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

preferredMaintenanceWindow string

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processorFeatures DBInstanceProcessorFeature[]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

promotionTier number

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

publiclyAccessible boolean

replicaMode string

The open mode of an Oracle read replica. The default is open-read-only.

sourceDBClusterIdentifier string

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

storageThroughput number

Specifies the storage throughput for the DB instance.

storageType string

Specifies the storage type to be associated with the DB instance.

tags DBInstanceTag[]

Tags to assign to the DB instance.

tdeCredentialArn string

The ARN from the key store with which to associate the instance for TDE encryption.

vPCSecurityGroups string[]

allocated_storage str

The amount of storage (in gigabytes) to be initially allocated for the database instance.

associated_roles Sequence[DBInstanceRole]

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

auto_minor_version_upgrade bool

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

availability_zone str

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

backup_retention_period int

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

c_a_certificate_identifier str

The identifier of the CA certificate for this DB instance.

certificate_details DBInstanceCertificateDetails

Returns the details of the DB instance's server certificate.

copy_tags_to_snapshot bool

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

d_b_cluster_snapshot_identifier str

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

d_b_instance_arn str

The Amazon Resource Name (ARN) for the DB instance.

d_b_instance_class str

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

d_b_parameter_group_name str

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

d_b_security_groups Sequence[str]

d_b_system_id str

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

dbi_resource_id str

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.

deletion_protection bool

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain str

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

domain_iam_role_name str

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enable_cloudwatch_logs_exports Sequence[str]

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

enable_iam_database_authentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

enable_performance_insights bool

A value that indicates whether to enable Performance Insights for the DB instance.

endpoint DBInstanceEndpoint

Specifies the connection endpoint.

engine str

The name of the database engine that you want to use for this DB instance.

engine_version str

The version number of the database engine to use.

iops int

The number of I/O operations per second (IOPS) that the database provisions.

license_model str

License model information for this DB instance.

manage_master_user_password bool

A value that indicates whether to manage the master user password with AWS Secrets Manager.

master_user_secret DBInstanceMasterUserSecret

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

max_allocated_storage int

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

monitoring_interval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoring_role_arn str

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

multi_az bool

Specifies whether the database instance is a multiple Availability Zone deployment.

network_type str

The network type of the DB cluster.

option_group_name str

Indicates that the DB instance should be associated with the specified option group.

performance_insights_kms_key_id str

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

performance_insights_retention_period int

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

preferred_backup_window str

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

preferred_maintenance_window str

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processor_features Sequence[DBInstanceProcessorFeature]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

promotion_tier int

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

publicly_accessible bool

replica_mode str

The open mode of an Oracle read replica. The default is open-read-only.

source_db_cluster_identifier str

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

storage_throughput int

Specifies the storage throughput for the DB instance.

storage_type str

Specifies the storage type to be associated with the DB instance.

tags Sequence[DBInstanceTag]

Tags to assign to the DB instance.

tde_credential_arn str

The ARN from the key store with which to associate the instance for TDE encryption.

v_pc_security_groups Sequence[str]

allocatedStorage String

The amount of storage (in gigabytes) to be initially allocated for the database instance.

associatedRoles List<Property Map>

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

autoMinorVersionUpgrade Boolean

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

availabilityZone String

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.

backupRetentionPeriod Number

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

cACertificateIdentifier String

The identifier of the CA certificate for this DB instance.

certificateDetails Property Map

Returns the details of the DB instance's server certificate.

copyTagsToSnapshot Boolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

dBClusterSnapshotIdentifier String

Constraints:

Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

dBInstanceArn String

The Amazon Resource Name (ARN) for the DB instance.

dBInstanceClass String

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.

dBParameterGroupName String

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

dBSecurityGroups List<String>

dBSystemId String

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.

dbiResourceId String

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.

deletionProtection Boolean

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

domain String

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

domainIAMRoleName String

Specify the name of the IAM role to be used when making API calls to the Directory Service.

enableCloudwatchLogsExports List<String>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

enableIAMDatabaseAuthentication Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

enablePerformanceInsights Boolean

A value that indicates whether to enable Performance Insights for the DB instance.

endpoint Property Map

Specifies the connection endpoint.

engine String

The name of the database engine that you want to use for this DB instance.

engineVersion String

The version number of the database engine to use.

iops Number

The number of I/O operations per second (IOPS) that the database provisions.

licenseModel String

License model information for this DB instance.

manageMasterUserPassword Boolean

A value that indicates whether to manage the master user password with AWS Secrets Manager.

masterUserSecret Property Map

Contains the secret managed by RDS in AWS Secrets Manager for the master user password.

maxAllocatedStorage Number

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

monitoringInterval Number

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn String

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

multiAZ Boolean

Specifies whether the database instance is a multiple Availability Zone deployment.

networkType String

The network type of the DB cluster.

optionGroupName String

Indicates that the DB instance should be associated with the specified option group.

performanceInsightsKMSKeyId String

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

performanceInsightsRetentionPeriod Number

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

preferredBackupWindow String

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

preferredMaintenanceWindow String

he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processorFeatures List<Property Map>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

promotionTier Number

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

publiclyAccessible Boolean

replicaMode String

The open mode of an Oracle read replica. The default is open-read-only.

sourceDBClusterIdentifier String

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

storageThroughput Number

Specifies the storage throughput for the DB instance.

storageType String

Specifies the storage type to be associated with the DB instance.

tags List<Property Map>

Tags to assign to the DB instance.

tdeCredentialArn String

The ARN from the key store with which to associate the instance for TDE encryption.

vPCSecurityGroups List<String>

Supporting Types

DBInstanceCertificateDetails

CAIdentifier string: The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill string: The expiration date of the DB instance’s server certificate.

CAIdentifier string: The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill string: The expiration date of the DB instance’s server certificate.

cAIdentifier String: The CA identifier of the CA certificate used for the DB instance's server certificate.
validTill String: The expiration date of the DB instance’s server certificate.

cAIdentifier string: The CA identifier of the CA certificate used for the DB instance's server certificate.
validTill string: The expiration date of the DB instance’s server certificate.

c_a_identifier str: The CA identifier of the CA certificate used for the DB instance's server certificate.
valid_till str: The expiration date of the DB instance’s server certificate.

cAIdentifier String: The CA identifier of the CA certificate used for the DB instance's server certificate.
validTill String: The expiration date of the DB instance’s server certificate.

DBInstanceEndpoint

Address string: Specifies the DNS address of the DB instance.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Port string: Specifies the port that the database engine is listening on.

Address string: Specifies the DNS address of the DB instance.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Port string: Specifies the port that the database engine is listening on.

address String: Specifies the DNS address of the DB instance.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port String: Specifies the port that the database engine is listening on.

address string: Specifies the DNS address of the DB instance.
hostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port string: Specifies the port that the database engine is listening on.

address str: Specifies the DNS address of the DB instance.
hosted_zone_id str: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port str: Specifies the port that the database engine is listening on.

address String: Specifies the DNS address of the DB instance.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port String: Specifies the port that the database engine is listening on.

DBInstanceMasterUserSecret

KmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string: The Amazon Resource Name (ARN) of the secret.

KmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string: The Amazon Resource Name (ARN) of the secret.

kmsKeyId String: The AWS KMS key identifier that is used to encrypt the secret.
secretArn String: The Amazon Resource Name (ARN) of the secret.

kmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
secretArn string: The Amazon Resource Name (ARN) of the secret.

kms_key_id str: The AWS KMS key identifier that is used to encrypt the secret.
secret_arn str: The Amazon Resource Name (ARN) of the secret.

kmsKeyId String: The AWS KMS key identifier that is used to encrypt the secret.
secretArn String: The Amazon Resource Name (ARN) of the secret.

DBInstanceProcessorFeature

Name Pulumi.AwsNative.RDS.DBInstanceProcessorFeatureName: The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value string: The value of a processor feature name.

Name DBInstanceProcessorFeatureName: The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value string: The value of a processor feature name.

name DBInstanceProcessorFeatureName: The name of the processor feature. Valid names are coreCount and threadsPerCore.
value String: The value of a processor feature name.

name DBInstanceProcessorFeatureName: The name of the processor feature. Valid names are coreCount and threadsPerCore.
value string: The value of a processor feature name.

name DBInstanceProcessorFeatureName: The name of the processor feature. Valid names are coreCount and threadsPerCore.
value str: The value of a processor feature name.

name "coreCount" | "threadsPerCore": The name of the processor feature. Valid names are coreCount and threadsPerCore.
value String: The value of a processor feature name.

DBInstanceProcessorFeatureName

DBInstanceRole

FeatureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.
RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

FeatureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.
RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

featureName String: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.
roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

featureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.
roleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

feature_name str: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.
role_arn str: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

featureName String: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.
roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

DBInstanceTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

aws-native.rds.getDBInstance

Using getDBInstance

getDBInstance Result

Supporting Types

DBInstanceCertificateDetails

DBInstanceEndpoint

DBInstanceMasterUserSecret

DBInstanceProcessorFeature

DBInstanceProcessorFeatureName

DBInstanceRole

DBInstanceTag

Package Details

On this page