This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.awsconnector.getEc2Volume
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Get a Ec2Volume 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>
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]
func LookupEc2Volume(ctx *Context, args *LookupEc2VolumeArgs, opts ...InvokeOption) (*LookupEc2VolumeResult, error)
func LookupEc2VolumeOutput(ctx *Context, args *LookupEc2VolumeOutputArgs, opts ...InvokeOption) LookupEc2VolumeResultOutput
> 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)
}
public static CompletableFuture<GetEc2VolumeResult> getEc2Volume(GetEc2VolumeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:awsconnector:getEc2Volume
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of Ec2Volume
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Name string
- Name of Ec2Volume
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- name String
- Name of Ec2Volume
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- name string
- Name of Ec2Volume
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- name str
- Name of Ec2Volume
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- name String
- Name of Ec2Volume
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getEc2Volume Result
The following output properties are available:
- 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.
Azure Native. Aws Connector. Outputs. Ec2Volume Properties Response - The resource-specific properties for this resource.
- System
Data Pulumi.Azure Native. Aws Connector. Outputs. System Data Response - 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"
- Dictionary<string, string>
- Resource tags.
- 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
Ec2Volume
Properties Response - The resource-specific properties for this resource.
- System
Data SystemData Response - 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"
- map[string]string
- Resource tags.
- 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
Ec2Volume
Properties Response - The resource-specific properties for this resource.
- system
Data SystemData Response - 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"
- Map<String,String>
- Resource tags.
- 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
Ec2Volume
Properties Response - The resource-specific properties for this resource.
- system
Data SystemData Response - 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"
- {[key: string]: string}
- Resource tags.
- 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
Ec2Volume
Properties Response - The resource-specific properties for this resource.
- system_
data SystemData Response - 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"
- Mapping[str, str]
- Resource tags.
- 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.
- system
Data 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"
- Map<String>
- Resource tags.
Supporting Types
AwsEc2VolumePropertiesResponse
- Auto
Enable boolIO - 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 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
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 Forio2
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 forio1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes. - Kms
Key stringId - The identifier of the kms-key-long to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
. If you omit this property and your account is enabled for encryption by default, or Encrypted is set totrue
, 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 withalias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the aws-managed-key, usealias/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 boolEnabled - 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 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
andgp3
: 1 - 16,384 GiB +io1
: 4 - 16,384 GiB +io2
: 4 - 65,536 GiB +st1
andsc1
: 125 - 16,384 GiB +standard
: 1 - 1024 GiB - Snapshot
Id string - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
- List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag Response> - 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 string - Property volumeId
- Volume
Type 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 boolIO - 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 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
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 Forio2
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 forio1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes. - Kms
Key stringId - The identifier of the kms-key-long to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
. If you omit this property and your account is enabled for encryption by default, or Encrypted is set totrue
, 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 withalias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the aws-managed-key, usealias/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 boolEnabled - 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 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
andgp3
: 1 - 16,384 GiB +io1
: 4 - 16,384 GiB +io2
: 4 - 65,536 GiB +st1
andsc1
: 125 - 16,384 GiB +standard
: 1 - 1024 GiB - Snapshot
Id string - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
- []Tag
Response - 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 string - Property volumeId
- Volume
Type 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 BooleanIO - 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 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
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 Forio2
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 forio1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes. - kms
Key StringId - The identifier of the kms-key-long to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
. If you omit this property and your account is enabled for encryption by default, or Encrypted is set totrue
, 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 withalias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the aws-managed-key, usealias/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 BooleanEnabled - 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 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
andgp3
: 1 - 16,384 GiB +io1
: 4 - 16,384 GiB +io2
: 4 - 65,536 GiB +st1
andsc1
: 125 - 16,384 GiB +standard
: 1 - 1024 GiB - snapshot
Id String - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
- List<Tag
Response> - 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. - volume
Id String - Property volumeId
- volume
Type 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 booleanIO - 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 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
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 Forio2
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 forio1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes. - kms
Key stringId - The identifier of the kms-key-long to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
. If you omit this property and your account is enabled for encryption by default, or Encrypted is set totrue
, 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 withalias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the aws-managed-key, usealias/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 booleanEnabled - 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 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
andgp3
: 1 - 16,384 GiB +io1
: 4 - 16,384 GiB +io2
: 4 - 65,536 GiB +st1
andsc1
: 125 - 16,384 GiB +standard
: 1 - 1024 GiB - snapshot
Id string - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
- Tag
Response[] - 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. - volume
Id string - Property volumeId
- volume
Type 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_ boolio - 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
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 Forio2
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 forio1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes. - kms_
key_ strid - The identifier of the kms-key-long to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
. If you omit this property and your account is enabled for encryption by default, or Encrypted is set totrue
, 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 withalias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the aws-managed-key, usealias/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_ boolenabled - 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
andgp3
: 1 - 16,384 GiB +io1
: 4 - 16,384 GiB +io2
: 4 - 65,536 GiB +st1
andsc1
: 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.
- Sequence[Tag
Response] - 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
- auto
Enable BooleanIO - 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 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
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 Forio2
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 forio1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes. - kms
Key StringId - The identifier of the kms-key-long to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
. If you omit this property and your account is enabled for encryption by default, or Encrypted is set totrue
, 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 withalias/
. For example, for a key with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the aws-managed-key, usealias/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 BooleanEnabled - 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 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
andgp3
: 1 - 16,384 GiB +io1
: 4 - 16,384 GiB +io2
: 4 - 65,536 GiB +st1
andsc1
: 125 - 16,384 GiB +standard
: 1 - 1024 GiB - snapshot
Id String - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
- 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. - volume
Id String - Property volumeId
- volume
Type 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
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Ec2Volume Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsEc2Volume Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsEc2Volume Properties Response - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- provisioning
State string - The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsEc2Volume Properties Response - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning_
state str - The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsEc2Volume Properties Response - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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 v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi