Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. awsconnector
  5. getEc2Volume
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.awsconnector.getEc2Volume

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a Ec2Volume

Uses Azure REST API version 2024-12-01.

Using getEc2Volume

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEc2Volume(args: GetEc2VolumeArgs, opts?: InvokeOptions): Promise<GetEc2VolumeResult>
function getEc2VolumeOutput(args: GetEc2VolumeOutputArgs, opts?: InvokeOptions): Output<GetEc2VolumeResult>
Copy
def get_ec2_volume(name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetEc2VolumeResult
def get_ec2_volume_output(name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetEc2VolumeResult]
Copy
func LookupEc2Volume(ctx *Context, args *LookupEc2VolumeArgs, opts ...InvokeOption) (*LookupEc2VolumeResult, error)
func LookupEc2VolumeOutput(ctx *Context, args *LookupEc2VolumeOutputArgs, opts ...InvokeOption) LookupEc2VolumeResultOutput
Copy

> Note: This function is named LookupEc2Volume in the Go SDK.

public static class GetEc2Volume 
{
    public static Task<GetEc2VolumeResult> InvokeAsync(GetEc2VolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetEc2VolumeResult> Invoke(GetEc2VolumeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEc2VolumeResult> getEc2Volume(GetEc2VolumeArgs args, InvokeOptions options)
public static Output<GetEc2VolumeResult> getEc2Volume(GetEc2VolumeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:awsconnector:getEc2Volume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of Ec2Volume
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of Ec2Volume
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of Ec2Volume
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of Ec2Volume
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of Ec2Volume
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of Ec2Volume
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getEc2Volume Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.AwsConnector.Outputs.Ec2VolumePropertiesResponse
The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.AwsConnector.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Ec2VolumePropertiesResponse
The resource-specific properties for this resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Ec2VolumePropertiesResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
properties Ec2VolumePropertiesResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
properties Ec2VolumePropertiesResponse
The resource-specific properties for this resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
The resource-specific properties for this resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

AwsEc2VolumePropertiesResponse

AutoEnableIO bool
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.
AvailabilityZone string
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
Encrypted bool
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.
Iops int
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.
KmsKeyId string
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.
MultiAttachEnabled bool
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.
OutpostArn string
The Amazon Resource Name (ARN) of the Outpost.
Size int
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
SnapshotId string
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
Tags List<Pulumi.AzureNative.AwsConnector.Inputs.TagResponse>
The tags to apply to the volume during creation.
Throughput int
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.
VolumeId string
Property volumeId
VolumeType string
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
AutoEnableIO bool
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.
AvailabilityZone string
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
Encrypted bool
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.
Iops int
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.
KmsKeyId string
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.
MultiAttachEnabled bool
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.
OutpostArn string
The Amazon Resource Name (ARN) of the Outpost.
Size int
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
SnapshotId string
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
Tags []TagResponse
The tags to apply to the volume during creation.
Throughput int
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.
VolumeId string
Property volumeId
VolumeType string
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
autoEnableIO Boolean
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.
availabilityZone String
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
encrypted Boolean
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.
iops Integer
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.
kmsKeyId String
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.
multiAttachEnabled Boolean
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.
outpostArn String
The Amazon Resource Name (ARN) of the Outpost.
size Integer
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
snapshotId String
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
tags List<TagResponse>
The tags to apply to the volume during creation.
throughput Integer
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.
volumeId String
Property volumeId
volumeType String
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
autoEnableIO boolean
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.
availabilityZone string
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
encrypted boolean
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.
iops number
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.
kmsKeyId string
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.
multiAttachEnabled boolean
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.
outpostArn string
The Amazon Resource Name (ARN) of the Outpost.
size number
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
snapshotId string
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
tags TagResponse[]
The tags to apply to the volume during creation.
throughput number
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.
volumeId string
Property volumeId
volumeType string
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
auto_enable_io bool
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.
availability_zone str
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
encrypted bool
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.
iops int
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.
kms_key_id str
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.
multi_attach_enabled bool
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.
outpost_arn str
The Amazon Resource Name (ARN) of the Outpost.
size int
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
snapshot_id str
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
tags Sequence[TagResponse]
The tags to apply to the volume during creation.
throughput int
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.
volume_id str
Property volumeId
volume_type str
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
autoEnableIO Boolean
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.
availabilityZone String
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
encrypted Boolean
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.
iops Number
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.
kmsKeyId String
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.
multiAttachEnabled Boolean
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.
outpostArn String
The Amazon Resource Name (ARN) of the Outpost.
size Number
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
snapshotId String
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
tags List<Property Map>
The tags to apply to the volume during creation.
throughput Number
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.
volumeId String
Property volumeId
volumeType String
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

Ec2VolumePropertiesResponse

ProvisioningState This property is required. string
The status of the last operation.
Arn string
Amazon Resource Name (ARN)
AwsAccountId string
AWS Account ID
AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsEc2VolumePropertiesResponse
AWS Properties
AwsRegion string
AWS Region
AwsSourceSchema string
AWS Source Schema
AwsTags Dictionary<string, string>
AWS Tags
PublicCloudConnectorsResourceId string
Public Cloud Connectors Resource ID
PublicCloudResourceName string
Public Cloud Resource Name
ProvisioningState This property is required. string
The status of the last operation.
Arn string
Amazon Resource Name (ARN)
AwsAccountId string
AWS Account ID
AwsProperties AwsEc2VolumePropertiesResponse
AWS Properties
AwsRegion string
AWS Region
AwsSourceSchema string
AWS Source Schema
AwsTags map[string]string
AWS Tags
PublicCloudConnectorsResourceId string
Public Cloud Connectors Resource ID
PublicCloudResourceName string
Public Cloud Resource Name
provisioningState This property is required. String
The status of the last operation.
arn String
Amazon Resource Name (ARN)
awsAccountId String
AWS Account ID
awsProperties AwsEc2VolumePropertiesResponse
AWS Properties
awsRegion String
AWS Region
awsSourceSchema String
AWS Source Schema
awsTags Map<String,String>
AWS Tags
publicCloudConnectorsResourceId String
Public Cloud Connectors Resource ID
publicCloudResourceName String
Public Cloud Resource Name
provisioningState This property is required. string
The status of the last operation.
arn string
Amazon Resource Name (ARN)
awsAccountId string
AWS Account ID
awsProperties AwsEc2VolumePropertiesResponse
AWS Properties
awsRegion string
AWS Region
awsSourceSchema string
AWS Source Schema
awsTags {[key: string]: string}
AWS Tags
publicCloudConnectorsResourceId string
Public Cloud Connectors Resource ID
publicCloudResourceName string
Public Cloud Resource Name
provisioning_state This property is required. str
The status of the last operation.
arn str
Amazon Resource Name (ARN)
aws_account_id str
AWS Account ID
aws_properties AwsEc2VolumePropertiesResponse
AWS Properties
aws_region str
AWS Region
aws_source_schema str
AWS Source Schema
aws_tags Mapping[str, str]
AWS Tags
public_cloud_connectors_resource_id str
Public Cloud Connectors Resource ID
public_cloud_resource_name str
Public Cloud Resource Name
provisioningState This property is required. String
The status of the last operation.
arn String
Amazon Resource Name (ARN)
awsAccountId String
AWS Account ID
awsProperties Property Map
AWS Properties
awsRegion String
AWS Region
awsSourceSchema String
AWS Source Schema
awsTags Map<String>
AWS Tags
publicCloudConnectorsResourceId String
Public Cloud Connectors Resource ID
publicCloudResourceName String
Public Cloud Resource Name

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TagResponse

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
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native