< Back
Add-CfnRDS_DBInstanceResource
Post
NAME Add-CfnRDS_DBInstanceResource
SYNOPSIS
The AWS::RDS::DBInstance type creates an Amazon RDS database instance.
SYNTAX
Add-CfnRDS_DBInstanceResource [-ResourceName] <String> [-AllocatedStorage <String>] [-AllowMajorVersionUpgrade
<Boolean>] [-AutoMinorVersionUpgrade <Boolean>] [-AvailabilityZone <String>] [-BackupRetentionPeriod <String>]
[-CharacterSetName <String>] [-DBClusterIdentifier <String>] [-DBInstanceClass <String>] [-DBInstanceIdentifier
<String>] [-DBName <String>] [-DBParameterGroupName <String>] [-DBSecurityGroups <String[]>]
[-DBSnapshotIdentifier <String>] [-DBSubnetGroupName <String>] [-Engine <String>] [-EngineVersion <String>] [-Iops
<String>] [-KmsKeyId <String>] [-LicenseModel <String>] [-MasterUsername <String>] [-MasterUserPassword <String>]
[-MultiAZ <Boolean>] [-OptionGroupName <String>] [-Port <String>] [-PreferredBackupWindow <String>]
[-PreferredMaintenanceWindow <String>] [-PubliclyAccessible <Boolean>] [-SourceDBInstanceIdentifier <String>]
[-StorageEncrypted <Boolean>] [-StorageType <String>] [-Tags <IDictionary>] [-VPCSecurityGroups <String[]>]
[-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>]
[-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllocatedStorage <String>
The allocated storage size specified in gigabytes (GB). If any value is used in the Iops parameter,
AllocatedStorage must be at least 100 GB, which corresponds to the minimum Iops value of 1000. If Iops is
increased (in 1000 IOPS increments), then AllocatedStorage must also be increased (in 100 GB increments)
correspondingly.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllowMajorVersionUpgrade <Boolean>
Indicates whether major version upgrades are allowed. Changing this parameter does not result in an outage,
and the change is applied asynchronously as soon as possible.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AutoMinorVersionUpgrade <Boolean>
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance
window. The default value is true.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AvailabilityZone <String>
The name of the Availability Zone where the DB instance is. You cannot set the AvailabilityZone parameter if
the MultiAZ parameter is set to true.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BackupRetentionPeriod <String>
The number of days for which automatic DB snapshots are retained.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CharacterSetName <String>
For supported engines, specifies the character set to associate with the database instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBClusterIdentifier <String>
The identifier of an existing DB cluster that this instance will be associated with.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBInstanceClass <String>
The name of the compute and memory capacity class of the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBInstanceIdentifier <String>
A name for the DB instance. If you don't specify a name, AWS CloudFormation generates a unique physical ID and
uses that ID for the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBName <String>
The name of the initial database of this instance that was provided at create time, if one was specified when
the DB instance was created. This same name is returned for the life of the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBParameterGroupName <String>
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in
the template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSecurityGroups <String[]>
A list containing the DB security groups to assign to the Amazon RDS instance. The list can contain both the
name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the
template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSnapshotIdentifier <String>
The identifier for the DB snapshot to restore from.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSubnetGroupName <String>
A DB Subnet Group to associate with this DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the database engine to be used for this DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EngineVersion <String>
The version number of the database engine to use.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Iops <String>
The number of I/O operations per second (IOPS) that the database should provision. This can be any value from
1000??????10,000, in 1000 IOPS increments.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-KmsKeyId <String>
The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the
database instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LicenseModel <String>
The license model information for this DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUsername <String>
The master username for the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUserPassword <String>
The master password for the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MultiAZ <Boolean>
Specifies if the DB instance is a multiple availability-zone deployment. You cannot set the AvailabilityZone
parameter if the MultiAZ parameter is set to true.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-OptionGroupName <String>
An option group that this database instance is associated with.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <String>
The port for the instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredBackupWindow <String>
The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range (in UTC) during which system maintenance can occur.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PubliclyAccessible <Boolean>
Indicates whether the database instance is an Internet-facing instance. If you specify true, an instance is
created with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, an
internal instance is created with a DNS name that resolves to a private IP address.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SourceDBInstanceIdentifier <String>
If you want to create a read replica DB instance, specify the ID of the source DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StorageEncrypted <Boolean>
Indicates whether the database instance is encrypted.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-StorageType <String>
The storage type associated with this database instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VPCSecurityGroups <String[]>
A list of the VPC security groups to assign to the Amazon RDS instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... DBInstance
SYNOPSIS
The AWS::RDS::DBInstance type creates an Amazon RDS database instance.
SYNTAX
Add-CfnRDS_DBInstanceResource [-ResourceName] <String> [-AllocatedStorage <String>] [-AllowMajorVersionUpgrade
<Boolean>] [-AutoMinorVersionUpgrade <Boolean>] [-AvailabilityZone <String>] [-BackupRetentionPeriod <String>]
[-CharacterSetName <String>] [-DBClusterIdentifier <String>] [-DBInstanceClass <String>] [-DBInstanceIdentifier
<String>] [-DBName <String>] [-DBParameterGroupName <String>] [-DBSecurityGroups <String[]>]
[-DBSnapshotIdentifier <String>] [-DBSubnetGroupName <String>] [-Engine <String>] [-EngineVersion <String>] [-Iops
<String>] [-KmsKeyId <String>] [-LicenseModel <String>] [-MasterUsername <String>] [-MasterUserPassword <String>]
[-MultiAZ <Boolean>] [-OptionGroupName <String>] [-Port <String>] [-PreferredBackupWindow <String>]
[-PreferredMaintenanceWindow <String>] [-PubliclyAccessible <Boolean>] [-SourceDBInstanceIdentifier <String>]
[-StorageEncrypted <Boolean>] [-StorageType <String>] [-Tags <IDictionary>] [-VPCSecurityGroups <String[]>]
[-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>]
[-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllocatedStorage <String>
The allocated storage size specified in gigabytes (GB). If any value is used in the Iops parameter,
AllocatedStorage must be at least 100 GB, which corresponds to the minimum Iops value of 1000. If Iops is
increased (in 1000 IOPS increments), then AllocatedStorage must also be increased (in 100 GB increments)
correspondingly.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllowMajorVersionUpgrade <Boolean>
Indicates whether major version upgrades are allowed. Changing this parameter does not result in an outage,
and the change is applied asynchronously as soon as possible.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AutoMinorVersionUpgrade <Boolean>
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance
window. The default value is true.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AvailabilityZone <String>
The name of the Availability Zone where the DB instance is. You cannot set the AvailabilityZone parameter if
the MultiAZ parameter is set to true.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BackupRetentionPeriod <String>
The number of days for which automatic DB snapshots are retained.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CharacterSetName <String>
For supported engines, specifies the character set to associate with the database instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBClusterIdentifier <String>
The identifier of an existing DB cluster that this instance will be associated with.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBInstanceClass <String>
The name of the compute and memory capacity class of the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBInstanceIdentifier <String>
A name for the DB instance. If you don't specify a name, AWS CloudFormation generates a unique physical ID and
uses that ID for the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBName <String>
The name of the initial database of this instance that was provided at create time, if one was specified when
the DB instance was created. This same name is returned for the life of the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBParameterGroupName <String>
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in
the template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSecurityGroups <String[]>
A list containing the DB security groups to assign to the Amazon RDS instance. The list can contain both the
name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the
template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSnapshotIdentifier <String>
The identifier for the DB snapshot to restore from.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSubnetGroupName <String>
A DB Subnet Group to associate with this DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the database engine to be used for this DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EngineVersion <String>
The version number of the database engine to use.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Iops <String>
The number of I/O operations per second (IOPS) that the database should provision. This can be any value from
1000??????10,000, in 1000 IOPS increments.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-KmsKeyId <String>
The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the
database instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LicenseModel <String>
The license model information for this DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUsername <String>
The master username for the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUserPassword <String>
The master password for the DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MultiAZ <Boolean>
Specifies if the DB instance is a multiple availability-zone deployment. You cannot set the AvailabilityZone
parameter if the MultiAZ parameter is set to true.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-OptionGroupName <String>
An option group that this database instance is associated with.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <String>
The port for the instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredBackupWindow <String>
The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range (in UTC) during which system maintenance can occur.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PubliclyAccessible <Boolean>
Indicates whether the database instance is an Internet-facing instance. If you specify true, an instance is
created with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, an
internal instance is created with a DNS name that resolves to a private IP address.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-SourceDBInstanceIdentifier <String>
If you want to create a read replica DB instance, specify the ID of the source DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StorageEncrypted <Boolean>
Indicates whether the database instance is encrypted.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-StorageType <String>
The storage type associated with this database instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VPCSecurityGroups <String[]>
A list of the VPC security groups to assign to the Amazon RDS instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... DBInstance