Docs Packages
  1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. rds
  5. DBInstance
aws-native logo
AWS Native v0.64.0, Jun 2 23

aws-native.rds.DBInstance

Explore with Pulumi AI

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

Create DBInstance Resource

new DBInstance(name: string, args?: DBInstanceArgs, opts?: CustomResourceOptions);
@overload
def DBInstance(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allocated_storage: Optional[str] = None,
               allow_major_version_upgrade: Optional[bool] = None,
               associated_roles: Optional[Sequence[DBInstanceRoleArgs]] = None,
               auto_minor_version_upgrade: Optional[bool] = None,
               availability_zone: Optional[str] = None,
               backup_retention_period: Optional[int] = None,
               c_a_certificate_identifier: Optional[str] = None,
               certificate_details: Optional[DBInstanceCertificateDetailsArgs] = None,
               certificate_rotation_restart: Optional[bool] = None,
               character_set_name: Optional[str] = None,
               copy_tags_to_snapshot: Optional[bool] = None,
               custom_iam_instance_profile: Optional[str] = None,
               d_b_cluster_identifier: Optional[str] = None,
               d_b_cluster_snapshot_identifier: Optional[str] = None,
               d_b_instance_class: Optional[str] = None,
               d_b_instance_identifier: Optional[str] = None,
               d_b_name: Optional[str] = None,
               d_b_parameter_group_name: Optional[str] = None,
               d_b_security_groups: Optional[Sequence[str]] = None,
               d_b_snapshot_identifier: Optional[str] = None,
               d_b_subnet_group_name: Optional[str] = None,
               delete_automated_backups: Optional[bool] = None,
               deletion_protection: Optional[bool] = None,
               domain: Optional[str] = None,
               domain_iam_role_name: Optional[str] = None,
               enable_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
               enable_iam_database_authentication: Optional[bool] = None,
               enable_performance_insights: Optional[bool] = None,
               endpoint: Optional[DBInstanceEndpointArgs] = None,
               engine: Optional[str] = None,
               engine_version: Optional[str] = None,
               iops: Optional[int] = None,
               kms_key_id: Optional[str] = None,
               license_model: Optional[str] = None,
               manage_master_user_password: Optional[bool] = None,
               master_user_password: Optional[str] = None,
               master_user_secret: Optional[DBInstanceMasterUserSecretArgs] = None,
               master_username: Optional[str] = None,
               max_allocated_storage: Optional[int] = None,
               monitoring_interval: Optional[int] = None,
               monitoring_role_arn: Optional[str] = None,
               multi_az: Optional[bool] = None,
               nchar_character_set_name: Optional[str] = None,
               network_type: Optional[str] = None,
               option_group_name: Optional[str] = None,
               performance_insights_kms_key_id: Optional[str] = None,
               performance_insights_retention_period: Optional[int] = None,
               port: Optional[str] = None,
               preferred_backup_window: Optional[str] = None,
               preferred_maintenance_window: Optional[str] = None,
               processor_features: Optional[Sequence[DBInstanceProcessorFeatureArgs]] = None,
               promotion_tier: Optional[int] = None,
               publicly_accessible: Optional[bool] = None,
               replica_mode: Optional[str] = None,
               restore_time: Optional[str] = None,
               source_db_cluster_identifier: Optional[str] = None,
               source_db_instance_automated_backups_arn: Optional[str] = None,
               source_db_instance_identifier: Optional[str] = None,
               source_dbi_resource_id: Optional[str] = None,
               source_region: Optional[str] = None,
               storage_encrypted: Optional[bool] = None,
               storage_throughput: Optional[int] = None,
               storage_type: Optional[str] = None,
               tags: Optional[Sequence[DBInstanceTagArgs]] = None,
               tde_credential_arn: Optional[str] = None,
               tde_credential_password: Optional[str] = None,
               timezone: Optional[str] = None,
               use_default_processor_features: Optional[bool] = None,
               use_latest_restorable_time: Optional[bool] = None,
               v_pc_security_groups: Optional[Sequence[str]] = None)
@overload
def DBInstance(resource_name: str,
               args: Optional[DBInstanceArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewDBInstance(ctx *Context, name string, args *DBInstanceArgs, opts ...ResourceOption) (*DBInstance, error)
public DBInstance(string name, DBInstanceArgs? args = null, CustomResourceOptions? opts = null)
public DBInstance(String name, DBInstanceArgs args)
public DBInstance(String name, DBInstanceArgs args, CustomResourceOptions options)

type: aws-native:rds:DBInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DBInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DBInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DBInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DBInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DBInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DBInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DBInstance resource accepts the following input properties:

AllocatedStorage string

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

AllowMajorVersionUpgrade bool

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

AssociatedRoles List<Pulumi.AwsNative.RDS.Inputs.DBInstanceRoleArgs>

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.Inputs.DBInstanceCertificateDetailsArgs

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

CertificateRotationRestart bool

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

CharacterSetName string

For supported engines, indicates that the DB instance should be associated with the specified character set.

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.

CustomIAMInstanceProfile string

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

This setting is required for RDS Custom.

DBClusterIdentifier string

The identifier of the DB cluster that the instance will belong to.

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

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.

DBName string

The meaning of this parameter differs according to the database engine you use.

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.

DBSnapshotIdentifier string

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

DBSubnetGroupName string

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

DeleteAutomatedBackups bool

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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.Inputs.DBInstanceEndpointArgs

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.

KmsKeyId string

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

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.

MasterUserPassword string

The password for the master user.

MasterUserSecret Pulumi.AwsNative.RDS.Inputs.DBInstanceMasterUserSecretArgs

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

MasterUsername string

The master user name for the DB instance.

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.

NcharCharacterSetName string

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

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

Port string

The port number on which the database accepts connections.

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.Inputs.DBInstanceProcessorFeatureArgs>

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.

RestoreTime string

The date and time to restore from.

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.

SourceDBInstanceAutomatedBackupsArn string

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

SourceDBInstanceIdentifier string

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

SourceDbiResourceId string

The resource ID of the source DB instance from which to restore.

SourceRegion string

The ID of the region that contains the source DB instance for the Read Replica.

StorageEncrypted bool

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

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.Inputs.DBInstanceTagArgs>

Tags to assign to the DB instance.

TdeCredentialArn string

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

TdeCredentialPassword string

The password for the given ARN from the key store in order to access the device.

Timezone string

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

UseDefaultProcessorFeatures bool

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

UseLatestRestorableTime bool

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

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.

AllowMajorVersionUpgrade bool

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

AssociatedRoles []DBInstanceRoleArgs

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 DBInstanceCertificateDetailsArgs

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

CertificateRotationRestart bool

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

CharacterSetName string

For supported engines, indicates that the DB instance should be associated with the specified character set.

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.

CustomIAMInstanceProfile string

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

This setting is required for RDS Custom.

DBClusterIdentifier string

The identifier of the DB cluster that the instance will belong to.

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

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.

DBName string

The meaning of this parameter differs according to the database engine you use.

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

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.

DBSnapshotIdentifier string

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

DBSubnetGroupName string

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

DeleteAutomatedBackups bool

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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 DBInstanceEndpointArgs

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.

KmsKeyId string

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

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.

MasterUserPassword string

The password for the master user.

MasterUserSecret DBInstanceMasterUserSecretArgs

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

MasterUsername string

The master user name for the DB instance.

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.

NcharCharacterSetName string

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

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

Port string

The port number on which the database accepts connections.

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 []DBInstanceProcessorFeatureArgs

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.

RestoreTime string

The date and time to restore from.

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.

SourceDBInstanceAutomatedBackupsArn string

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

SourceDBInstanceIdentifier string

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

SourceDbiResourceId string

The resource ID of the source DB instance from which to restore.

SourceRegion string

The ID of the region that contains the source DB instance for the Read Replica.

StorageEncrypted bool

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

StorageThroughput int

Specifies the storage throughput for the DB instance.

StorageType string

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

Tags []DBInstanceTagArgs

Tags to assign to the DB instance.

TdeCredentialArn string

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

TdeCredentialPassword string

The password for the given ARN from the key store in order to access the device.

Timezone string

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

UseDefaultProcessorFeatures bool

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

UseLatestRestorableTime bool

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

VPCSecurityGroups []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.

allowMajorVersionUpgrade Boolean

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

associatedRoles List<DBInstanceRoleArgs>

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 DBInstanceCertificateDetailsArgs

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

certificateRotationRestart Boolean

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

characterSetName String

For supported engines, indicates that the DB instance should be associated with the specified character set.

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.

customIAMInstanceProfile String

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

This setting is required for RDS Custom.

dBClusterIdentifier String

The identifier of the DB cluster that the instance will belong to.

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

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.

dBName String

The meaning of this parameter differs according to the database engine you use.

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.

dBSnapshotIdentifier String

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

dBSubnetGroupName String

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

deleteAutomatedBackups Boolean

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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 DBInstanceEndpointArgs

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.

kmsKeyId String

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

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.

masterUserPassword String

The password for the master user.

masterUserSecret DBInstanceMasterUserSecretArgs

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

masterUsername String

The master user name for the DB instance.

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.

ncharCharacterSetName String

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

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

port String

The port number on which the database accepts connections.

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<DBInstanceProcessorFeatureArgs>

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

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.

restoreTime String

The date and time to restore from.

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.

sourceDBInstanceAutomatedBackupsArn String

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

sourceDBInstanceIdentifier String

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

sourceDbiResourceId String

The resource ID of the source DB instance from which to restore.

sourceRegion String

The ID of the region that contains the source DB instance for the Read Replica.

storageEncrypted Boolean

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

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<DBInstanceTagArgs>

Tags to assign to the DB instance.

tdeCredentialArn String

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

tdeCredentialPassword String

The password for the given ARN from the key store in order to access the device.

timezone String

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

useDefaultProcessorFeatures Boolean

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

useLatestRestorableTime Boolean

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

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.

allowMajorVersionUpgrade boolean

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

associatedRoles DBInstanceRoleArgs[]

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 DBInstanceCertificateDetailsArgs

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

certificateRotationRestart boolean

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

characterSetName string

For supported engines, indicates that the DB instance should be associated with the specified character set.

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.

customIAMInstanceProfile string

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

This setting is required for RDS Custom.

dBClusterIdentifier string

The identifier of the DB cluster that the instance will belong to.

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

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.

dBName string

The meaning of this parameter differs according to the database engine you use.

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[]

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.

dBSnapshotIdentifier string

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

dBSubnetGroupName string

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

deleteAutomatedBackups boolean

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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 DBInstanceEndpointArgs

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.

kmsKeyId string

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

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.

masterUserPassword string

The password for the master user.

masterUserSecret DBInstanceMasterUserSecretArgs

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

masterUsername string

The master user name for the DB instance.

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.

ncharCharacterSetName string

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

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

port string

The port number on which the database accepts connections.

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 DBInstanceProcessorFeatureArgs[]

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

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.

restoreTime string

The date and time to restore from.

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.

sourceDBInstanceAutomatedBackupsArn string

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

sourceDBInstanceIdentifier string

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

sourceDbiResourceId string

The resource ID of the source DB instance from which to restore.

sourceRegion string

The ID of the region that contains the source DB instance for the Read Replica.

storageEncrypted boolean

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

storageThroughput number

Specifies the storage throughput for the DB instance.

storageType string

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

tags DBInstanceTagArgs[]

Tags to assign to the DB instance.

tdeCredentialArn string

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

tdeCredentialPassword string

The password for the given ARN from the key store in order to access the device.

timezone string

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

useDefaultProcessorFeatures boolean

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

useLatestRestorableTime boolean

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

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

allocated_storage str

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

allow_major_version_upgrade bool

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

associated_roles Sequence[DBInstanceRoleArgs]

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 DBInstanceCertificateDetailsArgs

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

certificate_rotation_restart bool

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

character_set_name str

For supported engines, indicates that the DB instance should be associated with the specified character set.

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.

custom_iam_instance_profile str

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

This setting is required for RDS Custom.

d_b_cluster_identifier str

The identifier of the DB cluster that the instance will belong to.

d_b_cluster_snapshot_identifier str

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

d_b_name str

The meaning of this parameter differs according to the database engine you use.

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]

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.

d_b_snapshot_identifier str

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

d_b_subnet_group_name str

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

delete_automated_backups bool

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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 DBInstanceEndpointArgs

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.

kms_key_id str

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

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_password str

The password for the master user.

master_user_secret DBInstanceMasterUserSecretArgs

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

master_username str

The master user name for the DB instance.

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.

nchar_character_set_name str

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

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

port str

The port number on which the database accepts connections.

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[DBInstanceProcessorFeatureArgs]

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

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.

replica_mode str

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

restore_time str

The date and time to restore from.

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.

source_db_instance_automated_backups_arn str

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

source_db_instance_identifier str

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

source_dbi_resource_id str

The resource ID of the source DB instance from which to restore.

source_region str

The ID of the region that contains the source DB instance for the Read Replica.

storage_encrypted bool

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

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[DBInstanceTagArgs]

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.

tde_credential_password str

The password for the given ARN from the key store in order to access the device.

timezone str

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

use_default_processor_features bool

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

use_latest_restorable_time bool

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

v_pc_security_groups Sequence[str]

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.

allowMajorVersionUpgrade Boolean

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

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.

certificateRotationRestart Boolean

A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate This setting doesn't apply to RDS Custom.

characterSetName String

For supported engines, indicates that the DB instance should be associated with the specified character set.

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.

customIAMInstanceProfile String

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

This setting is required for RDS Custom.

dBClusterIdentifier String

The identifier of the DB cluster that the instance will belong to.

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

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.

dBName String

The meaning of this parameter differs according to the database engine you use.

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.

dBSnapshotIdentifier String

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

dBSubnetGroupName String

A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.

deleteAutomatedBackups Boolean

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

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.

kmsKeyId String

The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.

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.

masterUserPassword String

The password for the master user.

masterUserSecret Property Map

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

masterUsername String

The master user name for the DB instance.

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.

ncharCharacterSetName String

The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.

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

port String

The port number on which the database accepts connections.

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

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.

restoreTime String

The date and time to restore from.

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.

sourceDBInstanceAutomatedBackupsArn String

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.

sourceDBInstanceIdentifier String

If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.

sourceDbiResourceId String

The resource ID of the source DB instance from which to restore.

sourceRegion String

The ID of the region that contains the source DB instance for the Read Replica.

storageEncrypted Boolean

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

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.

tdeCredentialPassword String

The password for the given ARN from the key store in order to access the device.

timezone String

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

useDefaultProcessorFeatures Boolean

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

useLatestRestorableTime Boolean

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the DBInstance resource produces the following output properties:

DBInstanceArn string

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

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.

Id string

The provider-assigned unique ID for this managed resource.

DBInstanceArn string

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

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.

Id string

The provider-assigned unique ID for this managed resource.

dBInstanceArn String

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

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.

id String

The provider-assigned unique ID for this managed resource.

dBInstanceArn string

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

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.

id string

The provider-assigned unique ID for this managed resource.

d_b_instance_arn str

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

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.

id str

The provider-assigned unique ID for this managed resource.

dBInstanceArn String

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

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.

id String

The provider-assigned unique ID for this managed resource.

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

CoreCount
coreCount
ThreadsPerCore
threadsPerCore
DBInstanceProcessorFeatureNameCoreCount
coreCount
DBInstanceProcessorFeatureNameThreadsPerCore
threadsPerCore
CoreCount
coreCount
ThreadsPerCore
threadsPerCore
CoreCount
coreCount
ThreadsPerCore
threadsPerCore
CORE_COUNT
coreCount
THREADS_PER_CORE
threadsPerCore
"coreCount"
coreCount
"threadsPerCore"
threadsPerCore

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