< Back
Add-CfnRDS_DBClusterResource
Post
NAME Add-CfnRDS_DBClusterResource
SYNOPSIS
The AWS::RDS::DBCluster resource creates a cluster, such as an Aurora for Amazon RDS (Amazon Aurora) DB cluster.
Amazon Aurora is a fully managed, MySQL-compatible, relational database engine.
SYNTAX
Add-CfnRDS_DBClusterResource [-ResourceName] <String> [-AvailabilityZones <String>] [-BackupRetentionPeriod
<Int32>] [-DatabaseName <String>] [-DBClusterParameterGroupName <String>] [-DBSubnetGroupName <String>] [-Engine
<String>] [-EngineVersion <String>] [-KmsKeyId <String>] [-MasterUsername <String>] [-MasterUserPassword <String>]
[-Port <Int32>] [-PreferredBackupWindow <String>] [-PreferredMaintenanceWindow <String>] [-SnapshotIdentifier
<String>] [-StorageEncrypted <Boolean>] [-Tags <IDictionary>] [-VpcSecurityGroupIds <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
-AvailabilityZones <String>
A list of Availability Zones (AZs) in which DB instances in the cluster can be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BackupRetentionPeriod <Int32>
The number of days for which automatic backups are retained.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DatabaseName <String>
The name of your database.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with this DB cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSubnetGroupName <String>
A DB subnet group that you want to associate with this DB cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the database engine that you want to use for this DB cluster.
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
-KmsKeyId <String>
The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the
database instances in the DB cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUsername <String>
The name of master user for the client DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUserPassword <String>
The name of master user for the client DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The port number on which the database accepts connections.
Required? false
Position? named
Default value 0
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, using the
BackupRetentionPeriod parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotIdentifier <String>
The identifier for the DB cluster snapshot from which you want to restore.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StorageEncrypted <Boolean>
Indicates whether the DB instances in the cluster are encrypted.
Required? false
Position? named
Default value False
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
-VpcSecurityGroupIds <String[]>
A list of EC2 VPC security groups to associate with this DB 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 ... :DBCluster
SYNOPSIS
The AWS::RDS::DBCluster resource creates a cluster, such as an Aurora for Amazon RDS (Amazon Aurora) DB cluster.
Amazon Aurora is a fully managed, MySQL-compatible, relational database engine.
SYNTAX
Add-CfnRDS_DBClusterResource [-ResourceName] <String> [-AvailabilityZones <String>] [-BackupRetentionPeriod
<Int32>] [-DatabaseName <String>] [-DBClusterParameterGroupName <String>] [-DBSubnetGroupName <String>] [-Engine
<String>] [-EngineVersion <String>] [-KmsKeyId <String>] [-MasterUsername <String>] [-MasterUserPassword <String>]
[-Port <Int32>] [-PreferredBackupWindow <String>] [-PreferredMaintenanceWindow <String>] [-SnapshotIdentifier
<String>] [-StorageEncrypted <Boolean>] [-Tags <IDictionary>] [-VpcSecurityGroupIds <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
-AvailabilityZones <String>
A list of Availability Zones (AZs) in which DB instances in the cluster can be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BackupRetentionPeriod <Int32>
The number of days for which automatic backups are retained.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DatabaseName <String>
The name of your database.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBClusterParameterGroupName <String>
The name of the DB cluster parameter group to associate with this DB cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DBSubnetGroupName <String>
A DB subnet group that you want to associate with this DB cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the database engine that you want to use for this DB cluster.
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
-KmsKeyId <String>
The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the
database instances in the DB cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUsername <String>
The name of master user for the client DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MasterUserPassword <String>
The name of master user for the client DB instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The port number on which the database accepts connections.
Required? false
Position? named
Default value 0
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, using the
BackupRetentionPeriod parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotIdentifier <String>
The identifier for the DB cluster snapshot from which you want to restore.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StorageEncrypted <Boolean>
Indicates whether the DB instances in the cluster are encrypted.
Required? false
Position? named
Default value False
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
-VpcSecurityGroupIds <String[]>
A list of EC2 VPC security groups to associate with this DB 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 ... :DBCluster