1. Packages
  2. Vra Provider
  3. API Docs
  4. StorageProfileAws
vra 0.16.0 published on Tuesday, Dec 30, 2025 by vmware
vra logo
vra 0.16.0 published on Tuesday, Dec 30, 2025 by vmware

    Example Usage

    Create StorageProfileAws Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StorageProfileAws(name: string, args: StorageProfileAwsArgs, opts?: CustomResourceOptions);
    @overload
    def StorageProfileAws(resource_name: str,
                          args: StorageProfileAwsArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def StorageProfileAws(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          default_item: Optional[bool] = None,
                          region_id: Optional[str] = None,
                          description: Optional[str] = None,
                          device_type: Optional[str] = None,
                          iops: Optional[str] = None,
                          name: Optional[str] = None,
                          storage_profile_aws_id: Optional[str] = None,
                          supports_encryption: Optional[bool] = None,
                          tags: Optional[Sequence[StorageProfileAwsTagArgs]] = None,
                          volume_type: Optional[str] = None)
    func NewStorageProfileAws(ctx *Context, name string, args StorageProfileAwsArgs, opts ...ResourceOption) (*StorageProfileAws, error)
    public StorageProfileAws(string name, StorageProfileAwsArgs args, CustomResourceOptions? opts = null)
    public StorageProfileAws(String name, StorageProfileAwsArgs args)
    public StorageProfileAws(String name, StorageProfileAwsArgs args, CustomResourceOptions options)
    
    type: vra:StorageProfileAws
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StorageProfileAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StorageProfileAwsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StorageProfileAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageProfileAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageProfileAwsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var storageProfileAwsResource = new Vra.StorageProfileAws("storageProfileAwsResource", new()
    {
        DefaultItem = false,
        RegionId = "string",
        Description = "string",
        DeviceType = "string",
        Iops = "string",
        Name = "string",
        StorageProfileAwsId = "string",
        SupportsEncryption = false,
        Tags = new[]
        {
            new Vra.Inputs.StorageProfileAwsTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        VolumeType = "string",
    });
    
    example, err := vra.NewStorageProfileAws(ctx, "storageProfileAwsResource", &vra.StorageProfileAwsArgs{
    	DefaultItem:         pulumi.Bool(false),
    	RegionId:            pulumi.String("string"),
    	Description:         pulumi.String("string"),
    	DeviceType:          pulumi.String("string"),
    	Iops:                pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	StorageProfileAwsId: pulumi.String("string"),
    	SupportsEncryption:  pulumi.Bool(false),
    	Tags: vra.StorageProfileAwsTagArray{
    		&vra.StorageProfileAwsTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	VolumeType: pulumi.String("string"),
    })
    
    var storageProfileAwsResource = new StorageProfileAws("storageProfileAwsResource", StorageProfileAwsArgs.builder()
        .defaultItem(false)
        .regionId("string")
        .description("string")
        .deviceType("string")
        .iops("string")
        .name("string")
        .storageProfileAwsId("string")
        .supportsEncryption(false)
        .tags(StorageProfileAwsTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .volumeType("string")
        .build());
    
    storage_profile_aws_resource = vra.StorageProfileAws("storageProfileAwsResource",
        default_item=False,
        region_id="string",
        description="string",
        device_type="string",
        iops="string",
        name="string",
        storage_profile_aws_id="string",
        supports_encryption=False,
        tags=[{
            "key": "string",
            "value": "string",
        }],
        volume_type="string")
    
    const storageProfileAwsResource = new vra.StorageProfileAws("storageProfileAwsResource", {
        defaultItem: false,
        regionId: "string",
        description: "string",
        deviceType: "string",
        iops: "string",
        name: "string",
        storageProfileAwsId: "string",
        supportsEncryption: false,
        tags: [{
            key: "string",
            value: "string",
        }],
        volumeType: "string",
    });
    
    type: vra:StorageProfileAws
    properties:
        defaultItem: false
        description: string
        deviceType: string
        iops: string
        name: string
        regionId: string
        storageProfileAwsId: string
        supportsEncryption: false
        tags:
            - key: string
              value: string
        volumeType: string
    

    StorageProfileAws Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StorageProfileAws resource accepts the following input properties:

    DefaultItem bool
    Indicates if this storage profile is a default profile.
    RegionId string
    A link to the region that is associated with the storage profile.
    Description string
    A human-friendly description.
    DeviceType string
    Indicates the type of storage device.
    Iops string
    Indicates maximum I/O operations per second in range(1-20,000).
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    StorageProfileAwsId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags List<StorageProfileAwsTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    VolumeType string
    Indicates the type of volume associated with type of storage.
    DefaultItem bool
    Indicates if this storage profile is a default profile.
    RegionId string
    A link to the region that is associated with the storage profile.
    Description string
    A human-friendly description.
    DeviceType string
    Indicates the type of storage device.
    Iops string
    Indicates maximum I/O operations per second in range(1-20,000).
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    StorageProfileAwsId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags []StorageProfileAwsTagArgs
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    VolumeType string
    Indicates the type of volume associated with type of storage.
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    regionId String
    A link to the region that is associated with the storage profile.
    description String
    A human-friendly description.
    deviceType String
    Indicates the type of storage device.
    iops String
    Indicates maximum I/O operations per second in range(1-20,000).
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    storageProfileAwsId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<StorageProfileAwsTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    volumeType String
    Indicates the type of volume associated with type of storage.
    defaultItem boolean
    Indicates if this storage profile is a default profile.
    regionId string
    A link to the region that is associated with the storage profile.
    description string
    A human-friendly description.
    deviceType string
    Indicates the type of storage device.
    iops string
    Indicates maximum I/O operations per second in range(1-20,000).
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    storageProfileAwsId string
    supportsEncryption boolean
    Indicates whether this storage profile supports encryption or not.
    tags StorageProfileAwsTag[]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    volumeType string
    Indicates the type of volume associated with type of storage.
    default_item bool
    Indicates if this storage profile is a default profile.
    region_id str
    A link to the region that is associated with the storage profile.
    description str
    A human-friendly description.
    device_type str
    Indicates the type of storage device.
    iops str
    Indicates maximum I/O operations per second in range(1-20,000).
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    storage_profile_aws_id str
    supports_encryption bool
    Indicates whether this storage profile supports encryption or not.
    tags Sequence[StorageProfileAwsTagArgs]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    volume_type str
    Indicates the type of volume associated with type of storage.
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    regionId String
    A link to the region that is associated with the storage profile.
    description String
    A human-friendly description.
    deviceType String
    Indicates the type of storage device.
    iops String
    Indicates maximum I/O operations per second in range(1-20,000).
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    storageProfileAwsId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    volumeType String
    Indicates the type of volume associated with type of storage.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StorageProfileAws resource produces the following output properties:

    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links List<StorageProfileAwsLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links []StorageProfileAwsLink
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<StorageProfileAwsLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    id string
    The provider-assigned unique ID for this managed resource.
    links StorageProfileAwsLink[]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    organizationId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    external_region_id str
    The id of the region as seen in the cloud provider for which this profile is defined.
    id str
    The provider-assigned unique ID for this managed resource.
    links Sequence[StorageProfileAwsLink]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    organization_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    id String
    The provider-assigned unique ID for this managed resource.
    links List<Property Map>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.

    Look up Existing StorageProfileAws Resource

    Get an existing StorageProfileAws resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StorageProfileAwsState, opts?: CustomResourceOptions): StorageProfileAws
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            default_item: Optional[bool] = None,
            description: Optional[str] = None,
            device_type: Optional[str] = None,
            external_region_id: Optional[str] = None,
            iops: Optional[str] = None,
            links: Optional[Sequence[StorageProfileAwsLinkArgs]] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            owner: Optional[str] = None,
            region_id: Optional[str] = None,
            storage_profile_aws_id: Optional[str] = None,
            supports_encryption: Optional[bool] = None,
            tags: Optional[Sequence[StorageProfileAwsTagArgs]] = None,
            updated_at: Optional[str] = None,
            volume_type: Optional[str] = None) -> StorageProfileAws
    func GetStorageProfileAws(ctx *Context, name string, id IDInput, state *StorageProfileAwsState, opts ...ResourceOption) (*StorageProfileAws, error)
    public static StorageProfileAws Get(string name, Input<string> id, StorageProfileAwsState? state, CustomResourceOptions? opts = null)
    public static StorageProfileAws get(String name, Output<String> id, StorageProfileAwsState state, CustomResourceOptions options)
    resources:  _:    type: vra:StorageProfileAws    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    DefaultItem bool
    Indicates if this storage profile is a default profile.
    Description string
    A human-friendly description.
    DeviceType string
    Indicates the type of storage device.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Iops string
    Indicates maximum I/O operations per second in range(1-20,000).
    Links List<StorageProfileAwsLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    RegionId string
    A link to the region that is associated with the storage profile.
    StorageProfileAwsId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags List<StorageProfileAwsTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    VolumeType string
    Indicates the type of volume associated with type of storage.
    CreatedAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    DefaultItem bool
    Indicates if this storage profile is a default profile.
    Description string
    A human-friendly description.
    DeviceType string
    Indicates the type of storage device.
    ExternalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    Iops string
    Indicates maximum I/O operations per second in range(1-20,000).
    Links []StorageProfileAwsLinkArgs
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    RegionId string
    A link to the region that is associated with the storage profile.
    StorageProfileAwsId string
    SupportsEncryption bool
    Indicates whether this storage profile supports encryption or not.
    Tags []StorageProfileAwsTagArgs
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    VolumeType string
    Indicates the type of volume associated with type of storage.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    description String
    A human-friendly description.
    deviceType String
    Indicates the type of storage device.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    iops String
    Indicates maximum I/O operations per second in range(1-20,000).
    links List<StorageProfileAwsLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    regionId String
    A link to the region that is associated with the storage profile.
    storageProfileAwsId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<StorageProfileAwsTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    volumeType String
    Indicates the type of volume associated with type of storage.
    createdAt string
    Date when the entity was created. The date is in ISO 6801 and UTC.
    defaultItem boolean
    Indicates if this storage profile is a default profile.
    description string
    A human-friendly description.
    deviceType string
    Indicates the type of storage device.
    externalRegionId string
    The id of the region as seen in the cloud provider for which this profile is defined.
    iops string
    Indicates maximum I/O operations per second in range(1-20,000).
    links StorageProfileAwsLink[]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    organizationId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    regionId string
    A link to the region that is associated with the storage profile.
    storageProfileAwsId string
    supportsEncryption boolean
    Indicates whether this storage profile supports encryption or not.
    tags StorageProfileAwsTag[]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    volumeType string
    Indicates the type of volume associated with type of storage.
    created_at str
    Date when the entity was created. The date is in ISO 6801 and UTC.
    default_item bool
    Indicates if this storage profile is a default profile.
    description str
    A human-friendly description.
    device_type str
    Indicates the type of storage device.
    external_region_id str
    The id of the region as seen in the cloud provider for which this profile is defined.
    iops str
    Indicates maximum I/O operations per second in range(1-20,000).
    links Sequence[StorageProfileAwsLinkArgs]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    organization_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    region_id str
    A link to the region that is associated with the storage profile.
    storage_profile_aws_id str
    supports_encryption bool
    Indicates whether this storage profile supports encryption or not.
    tags Sequence[StorageProfileAwsTagArgs]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    volume_type str
    Indicates the type of volume associated with type of storage.
    createdAt String
    Date when the entity was created. The date is in ISO 6801 and UTC.
    defaultItem Boolean
    Indicates if this storage profile is a default profile.
    description String
    A human-friendly description.
    deviceType String
    Indicates the type of storage device.
    externalRegionId String
    The id of the region as seen in the cloud provider for which this profile is defined.
    iops String
    Indicates maximum I/O operations per second in range(1-20,000).
    links List<Property Map>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    regionId String
    A link to the region that is associated with the storage profile.
    storageProfileAwsId String
    supportsEncryption Boolean
    Indicates whether this storage profile supports encryption or not.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    volumeType String
    Indicates the type of volume associated with type of storage.

    Supporting Types

    Href string
    Hrefs List<string>
    Rel string
    Href string
    Hrefs []string
    Rel string
    href String
    hrefs List<String>
    rel String
    href string
    hrefs string[]
    rel string
    href str
    hrefs Sequence[str]
    rel str
    href String
    hrefs List<String>
    rel String

    StorageProfileAwsTag, StorageProfileAwsTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    vra 0.16.0 published on Tuesday, Dec 30, 2025 by vmware
      Meet Neo: Your AI Platform Teammate