Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The ec2Volumes resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Volumes resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/ec2Volumes@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
autoEnableIO: bool
availabilityZone: 'string'
encrypted: bool
iops: int
kmsKeyId: 'string'
multiAttachEnabled: bool
outpostArn: 'string'
size: int
snapshotId: 'string'
tags: [
{
key: 'string'
value: 'string'
}
]
throughput: int
volumeId: 'string'
volumeType: 'string'
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/ec2Volumes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2VolumeProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AwsEc2VolumeProperties
| Name | Description | Value |
|---|---|---|
| autoEnableIO | Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. | bool |
| availabilityZone | The ID of the Availability Zone in which to create the volume. For example, us-east-1a. |
string |
| encrypted | Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. |
bool |
| iops | The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + gp3: 3,000 - 16,000 IOPS + io1: 100 - 64,000 IOPS + io2: 100 - 256,000 IOPS For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes. |
int |
| kmsKeyId | The identifier of the kms-key-long to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. |
string |
| multiAttachEnabled | Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. | bool |
| outpostArn | The Amazon Resource Name (ARN) of the Outpost. | string |
| size | The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + gp2 and gp3: 1 - 16,384 GiB + io1: 4 - 16,384 GiB + io2: 4 - 65,536 GiB + st1 and sc1: 125 - 16,384 GiB + standard: 1 - 1024 GiB |
int |
| snapshotId | The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. | string |
| tags | The tags to apply to the volume during creation. | TagAutoGenerated21[] |
| throughput | The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for gp3 volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000. |
int |
| volumeId | Property volumeId | string |
| volumeType | The volume type. This parameter can be one of the following values: + General Purpose SSD: gp2 | gp3 + Provisioned IOPS SSD: io1 | io2 + Throughput Optimized HDD: st1 + Cold HDD: sc1 + Magnetic: standard For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. Default: gp2 |
string |
Ec2VolumeProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2VolumeProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2VolumePropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2VolumePropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated21
| Name | Description | Value |
|---|---|---|
| key | The tag key. | string |
| value | The tag value. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The ec2Volumes resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Volumes resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/ec2Volumes",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"autoEnableIO": "bool",
"availabilityZone": "string",
"encrypted": "bool",
"iops": "int",
"kmsKeyId": "string",
"multiAttachEnabled": "bool",
"outpostArn": "string",
"size": "int",
"snapshotId": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"throughput": "int",
"volumeId": "string",
"volumeType": "string"
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/ec2Volumes
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2VolumeProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AwsConnector/ec2Volumes' |
AwsEc2VolumeProperties
| Name | Description | Value |
|---|---|---|
| autoEnableIO | Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. | bool |
| availabilityZone | The ID of the Availability Zone in which to create the volume. For example, us-east-1a. |
string |
| encrypted | Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. |
bool |
| iops | The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + gp3: 3,000 - 16,000 IOPS + io1: 100 - 64,000 IOPS + io2: 100 - 256,000 IOPS For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes. |
int |
| kmsKeyId | The identifier of the kms-key-long to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. |
string |
| multiAttachEnabled | Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. | bool |
| outpostArn | The Amazon Resource Name (ARN) of the Outpost. | string |
| size | The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + gp2 and gp3: 1 - 16,384 GiB + io1: 4 - 16,384 GiB + io2: 4 - 65,536 GiB + st1 and sc1: 125 - 16,384 GiB + standard: 1 - 1024 GiB |
int |
| snapshotId | The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. | string |
| tags | The tags to apply to the volume during creation. | TagAutoGenerated21[] |
| throughput | The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for gp3 volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000. |
int |
| volumeId | Property volumeId | string |
| volumeType | The volume type. This parameter can be one of the following values: + General Purpose SSD: gp2 | gp3 + Provisioned IOPS SSD: io1 | io2 + Throughput Optimized HDD: st1 + Cold HDD: sc1 + Magnetic: standard For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. Default: gp2 |
string |
Ec2VolumeProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2VolumeProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2VolumePropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2VolumePropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated21
| Name | Description | Value |
|---|---|---|
| key | The tag key. | string |
| value | The tag value. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The ec2Volumes resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Volumes resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/ec2Volumes@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
autoEnableIO = bool
availabilityZone = "string"
encrypted = bool
iops = int
kmsKeyId = "string"
multiAttachEnabled = bool
outpostArn = "string"
size = int
snapshotId = "string"
tags = [
{
key = "string"
value = "string"
}
]
throughput = int
volumeId = "string"
volumeType = "string"
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/ec2Volumes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2VolumeProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AwsConnector/ec2Volumes@2024-12-01" |
AwsEc2VolumeProperties
| Name | Description | Value |
|---|---|---|
| autoEnableIO | Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. | bool |
| availabilityZone | The ID of the Availability Zone in which to create the volume. For example, us-east-1a. |
string |
| encrypted | Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. |
bool |
| iops | The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + gp3: 3,000 - 16,000 IOPS + io1: 100 - 64,000 IOPS + io2: 100 - 256,000 IOPS For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes. |
int |
| kmsKeyId | The identifier of the kms-key-long to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with alias/. For example, for a key with the alias my_cmk, use alias/my_cmk. Or to specify the aws-managed-key, use alias/aws/ebs. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. |
string |
| multiAttachEnabled | Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. | bool |
| outpostArn | The Amazon Resource Name (ARN) of the Outpost. | string |
| size | The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + gp2 and gp3: 1 - 16,384 GiB + io1: 4 - 16,384 GiB + io2: 4 - 65,536 GiB + st1 and sc1: 125 - 16,384 GiB + standard: 1 - 1024 GiB |
int |
| snapshotId | The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. | string |
| tags | The tags to apply to the volume during creation. | TagAutoGenerated21[] |
| throughput | The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for gp3 volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000. |
int |
| volumeId | Property volumeId | string |
| volumeType | The volume type. This parameter can be one of the following values: + General Purpose SSD: gp2 | gp3 + Provisioned IOPS SSD: io1 | io2 + Throughput Optimized HDD: st1 + Cold HDD: sc1 + Magnetic: standard For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. Default: gp2 |
string |
Ec2VolumeProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2VolumeProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2VolumePropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2VolumePropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated21
| Name | Description | Value |
|---|---|---|
| key | The tag key. | string |
| value | The tag value. | string |
TrackedResourceTags
| Name | Description | Value |
|---|