< Back
Add-CfnEC2_VolumeResource
Post
NAME Add-CfnEC2_VolumeResource
SYNOPSIS
The AWS::EC2::Volume type creates a new Elastic Block Store volume. You can set a deletion policy for your volume
to control how AWS CloudFormation handles the volume when the stack is deleted. For Elastic Block Store volumes,
you can choose to retain the volume, to delete the volume, or to create a snapshot of the volume.
SYNTAX
Add-CfnEC2_VolumeResource [-ResourceName] <String> [-AutoEnableIO <Boolean>] [-AvailabilityZone <String>]
[-Encrypted <Boolean>] [-Iops <Int32>] [-KmsKeyId <String>] [-Size <String>] [-SnapshotId <String>] [-Tags
<IDictionary>] [-VolumeType <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
-AutoEnableIO <Boolean>
Indicates whether the volume is auto-enabled for I/O operations.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AvailabilityZone <String>
The Availability Zone in which to create the new volume.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Encrypted <Boolean>
Indicates whether the volume is encrypted. Encrypted Amazon EBS volumes can only be attached to instance types
that support Amazon EBS encryption.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Iops <Int32>
The number of I/O operations per second (IOPS) that the volume supports. This can be any value from 1-1000.
Required: Conditional. Required when the volume type is "io1"; not used with standard volumes.
Required? false
Position? named
Default value 0
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 create the
encrypted volume.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Size <String>
The size of the volume, in gibibytes (GiBs). This can be any value from 1??????1024. Required: Conditional.
Required if you are not creating a volume from a snapshot. If you specify Size, do not specify SnapshotId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotId <String>
The snapshot from which to create the new volume. Required: Conditional. Required if you are creating a volume
from a snapshot. If you do not specify a value for SnapshotId, you should specify a value for Size.
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
-VolumeType <String>
The volume type. This can be either "standard" or "io1". If no value is specified, "standard" will be used.
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 ... C2::Volume
SYNOPSIS
The AWS::EC2::Volume type creates a new Elastic Block Store volume. You can set a deletion policy for your volume
to control how AWS CloudFormation handles the volume when the stack is deleted. For Elastic Block Store volumes,
you can choose to retain the volume, to delete the volume, or to create a snapshot of the volume.
SYNTAX
Add-CfnEC2_VolumeResource [-ResourceName] <String> [-AutoEnableIO <Boolean>] [-AvailabilityZone <String>]
[-Encrypted <Boolean>] [-Iops <Int32>] [-KmsKeyId <String>] [-Size <String>] [-SnapshotId <String>] [-Tags
<IDictionary>] [-VolumeType <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
-AutoEnableIO <Boolean>
Indicates whether the volume is auto-enabled for I/O operations.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AvailabilityZone <String>
The Availability Zone in which to create the new volume.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Encrypted <Boolean>
Indicates whether the volume is encrypted. Encrypted Amazon EBS volumes can only be attached to instance types
that support Amazon EBS encryption.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Iops <Int32>
The number of I/O operations per second (IOPS) that the volume supports. This can be any value from 1-1000.
Required: Conditional. Required when the volume type is "io1"; not used with standard volumes.
Required? false
Position? named
Default value 0
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 create the
encrypted volume.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Size <String>
The size of the volume, in gibibytes (GiBs). This can be any value from 1??????1024. Required: Conditional.
Required if you are not creating a volume from a snapshot. If you specify Size, do not specify SnapshotId.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotId <String>
The snapshot from which to create the new volume. Required: Conditional. Required if you are creating a volume
from a snapshot. If you do not specify a value for SnapshotId, you should specify a value for Size.
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
-VolumeType <String>
The volume type. This can be either "standard" or "io1". If no value is specified, "standard" will be used.
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 ... C2::Volume