Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cloudstoragegateway
  5. GatewayBlockVolume
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.cloudstoragegateway.GatewayBlockVolume

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a Cloud Storage Gateway Gateway Block Volume resource.

    For information about Cloud Storage Gateway Gateway Block Volume and how to use it, see What is Gateway Block Volume.

    NOTE: Available since v1.144.0.

    Create GatewayBlockVolume Resource

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

    Constructor syntax

    new GatewayBlockVolume(name: string, args: GatewayBlockVolumeArgs, opts?: CustomResourceOptions);
    @overload
def GatewayBlockVolume(resource_name: str,
                       args: GatewayBlockVolumeArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def GatewayBlockVolume(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       oss_bucket_name: Optional[str] = None,
                       gateway_block_volume_name: Optional[str] = None,
                       protocol: Optional[str] = None,
                       oss_endpoint: Optional[str] = None,
                       gateway_id: Optional[str] = None,
                       oss_bucket_ssl: Optional[bool] = None,
                       chap_enabled: Optional[bool] = None,
                       local_path: Optional[str] = None,
                       chunk_size: Optional[int] = None,
                       cache_mode: Optional[str] = None,
                       is_source_deletion: Optional[bool] = None,
                       chap_in_user: Optional[str] = None,
                       chap_in_password: Optional[str] = None,
                       recovery: Optional[bool] = None,
                       size: Optional[int] = None)
    func NewGatewayBlockVolume(ctx *Context, name string, args GatewayBlockVolumeArgs, opts ...ResourceOption) (*GatewayBlockVolume, error)
    public GatewayBlockVolume(string name, GatewayBlockVolumeArgs args, CustomResourceOptions? opts = null)
    public GatewayBlockVolume(String name, GatewayBlockVolumeArgs args)
public GatewayBlockVolume(String name, GatewayBlockVolumeArgs args, CustomResourceOptions options)

    type: alicloud:cloudstoragegateway:GatewayBlockVolume
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 GatewayBlockVolumeArgs
    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 GatewayBlockVolumeArgs
    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 GatewayBlockVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayBlockVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayBlockVolumeArgs
    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 gatewayBlockVolumeResource = new AliCloud.CloudStorageGateway.GatewayBlockVolume("gatewayBlockVolumeResource", new()
{
    OssBucketName = "string",
    GatewayBlockVolumeName = "string",
    Protocol = "string",
    OssEndpoint = "string",
    GatewayId = "string",
    OssBucketSsl = false,
    ChapEnabled = false,
    LocalPath = "string",
    ChunkSize = 0,
    CacheMode = "string",
    IsSourceDeletion = false,
    ChapInUser = "string",
    ChapInPassword = "string",
    Recovery = false,
    Size = 0,
});

    example, err := cloudstoragegateway.NewGatewayBlockVolume(ctx, "gatewayBlockVolumeResource", &cloudstoragegateway.GatewayBlockVolumeArgs{
	OssBucketName:          pulumi.String("string"),
	GatewayBlockVolumeName: pulumi.String("string"),
	Protocol:               pulumi.String("string"),
	OssEndpoint:            pulumi.String("string"),
	GatewayId:              pulumi.String("string"),
	OssBucketSsl:           pulumi.Bool(false),
	ChapEnabled:            pulumi.Bool(false),
	LocalPath:              pulumi.String("string"),
	ChunkSize:              pulumi.Int(0),
	CacheMode:              pulumi.String("string"),
	IsSourceDeletion:       pulumi.Bool(false),
	ChapInUser:             pulumi.String("string"),
	ChapInPassword:         pulumi.String("string"),
	Recovery:               pulumi.Bool(false),
	Size:                   pulumi.Int(0),
})

    var gatewayBlockVolumeResource = new GatewayBlockVolume("gatewayBlockVolumeResource", GatewayBlockVolumeArgs.builder()
    .ossBucketName("string")
    .gatewayBlockVolumeName("string")
    .protocol("string")
    .ossEndpoint("string")
    .gatewayId("string")
    .ossBucketSsl(false)
    .chapEnabled(false)
    .localPath("string")
    .chunkSize(0)
    .cacheMode("string")
    .isSourceDeletion(false)
    .chapInUser("string")
    .chapInPassword("string")
    .recovery(false)
    .size(0)
    .build());

    gateway_block_volume_resource = alicloud.cloudstoragegateway.GatewayBlockVolume("gatewayBlockVolumeResource",
    oss_bucket_name="string",
    gateway_block_volume_name="string",
    protocol="string",
    oss_endpoint="string",
    gateway_id="string",
    oss_bucket_ssl=False,
    chap_enabled=False,
    local_path="string",
    chunk_size=0,
    cache_mode="string",
    is_source_deletion=False,
    chap_in_user="string",
    chap_in_password="string",
    recovery=False,
    size=0)

    const gatewayBlockVolumeResource = new alicloud.cloudstoragegateway.GatewayBlockVolume("gatewayBlockVolumeResource", {
    ossBucketName: "string",
    gatewayBlockVolumeName: "string",
    protocol: "string",
    ossEndpoint: "string",
    gatewayId: "string",
    ossBucketSsl: false,
    chapEnabled: false,
    localPath: "string",
    chunkSize: 0,
    cacheMode: "string",
    isSourceDeletion: false,
    chapInUser: "string",
    chapInPassword: "string",
    recovery: false,
    size: 0,
});

    type: alicloud:cloudstoragegateway:GatewayBlockVolume
properties:
    cacheMode: string
    chapEnabled: false
    chapInPassword: string
    chapInUser: string
    chunkSize: 0
    gatewayBlockVolumeName: string
    gatewayId: string
    isSourceDeletion: false
    localPath: string
    ossBucketName: string
    ossBucketSsl: false
    ossEndpoint: string
    protocol: string
    recovery: false
    size: 0

    GatewayBlockVolume 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 GatewayBlockVolume resource accepts the following input properties:

    GatewayBlockVolumeName string
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    GatewayId string
    The Gateway ID.
    OssBucketName string
    The name of the OSS Bucket.
    OssEndpoint string
    The endpoint of the OSS Bucket.
    Protocol string
    The Protocol. Valid values: iSCSI.
    CacheMode string
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    ChapEnabled bool
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    ChapInPassword string
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChapInUser string
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChunkSize int
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    IsSourceDeletion bool
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    LocalPath string
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    OssBucketSsl bool
    Whether to enable SSL access your OSS Buckets. Default value: true.
    Recovery bool
    The recovery.
    Size int
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    GatewayBlockVolumeName string
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    GatewayId string
    The Gateway ID.
    OssBucketName string
    The name of the OSS Bucket.
    OssEndpoint string
    The endpoint of the OSS Bucket.
    Protocol string
    The Protocol. Valid values: iSCSI.
    CacheMode string
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    ChapEnabled bool
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    ChapInPassword string
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChapInUser string
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChunkSize int
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    IsSourceDeletion bool
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    LocalPath string
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    OssBucketSsl bool
    Whether to enable SSL access your OSS Buckets. Default value: true.
    Recovery bool
    The recovery.
    Size int
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    gatewayBlockVolumeName String
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gatewayId String
    The Gateway ID.
    ossBucketName String
    The name of the OSS Bucket.
    ossEndpoint String
    The endpoint of the OSS Bucket.
    protocol String
    The Protocol. Valid values: iSCSI.
    cacheMode String
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chapEnabled Boolean
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chapInPassword String
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chapInUser String
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunkSize Integer
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    isSourceDeletion Boolean
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    localPath String
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    ossBucketSsl Boolean
    Whether to enable SSL access your OSS Buckets. Default value: true.
    recovery Boolean
    The recovery.
    size Integer
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    gatewayBlockVolumeName string
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gatewayId string
    The Gateway ID.
    ossBucketName string
    The name of the OSS Bucket.
    ossEndpoint string
    The endpoint of the OSS Bucket.
    protocol string
    The Protocol. Valid values: iSCSI.
    cacheMode string
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chapEnabled boolean
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chapInPassword string
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chapInUser string
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunkSize number
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    isSourceDeletion boolean
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    localPath string
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    ossBucketSsl boolean
    Whether to enable SSL access your OSS Buckets. Default value: true.
    recovery boolean
    The recovery.
    size number
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    gateway_block_volume_name str
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gateway_id str
    The Gateway ID.
    oss_bucket_name str
    The name of the OSS Bucket.
    oss_endpoint str
    The endpoint of the OSS Bucket.
    protocol str
    The Protocol. Valid values: iSCSI.
    cache_mode str
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chap_enabled bool
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chap_in_password str
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chap_in_user str
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunk_size int
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    is_source_deletion bool
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    local_path str
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    oss_bucket_ssl bool
    Whether to enable SSL access your OSS Buckets. Default value: true.
    recovery bool
    The recovery.
    size int
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    gatewayBlockVolumeName String
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gatewayId String
    The Gateway ID.
    ossBucketName String
    The name of the OSS Bucket.
    ossEndpoint String
    The endpoint of the OSS Bucket.
    protocol String
    The Protocol. Valid values: iSCSI.
    cacheMode String
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chapEnabled Boolean
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chapInPassword String
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chapInUser String
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunkSize Number
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    isSourceDeletion Boolean
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    localPath String
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    ossBucketSsl Boolean
    Whether to enable SSL access your OSS Buckets. Default value: true.
    recovery Boolean
    The recovery.
    size Number
    The Volume size. Valid values: 1 to 262144. Unit: Byte.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IndexId string
    The ID of the index.
    Status string
    The status of volume. Valid values:
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexId string
    The ID of the index.
    Status string
    The status of volume. Valid values:
    id String
    The provider-assigned unique ID for this managed resource.
    indexId String
    The ID of the index.
    status String
    The status of volume. Valid values:
    id string
    The provider-assigned unique ID for this managed resource.
    indexId string
    The ID of the index.
    status string
    The status of volume. Valid values:
    id str
    The provider-assigned unique ID for this managed resource.
    index_id str
    The ID of the index.
    status str
    The status of volume. Valid values:
    id String
    The provider-assigned unique ID for this managed resource.
    indexId String
    The ID of the index.
    status String
    The status of volume. Valid values:

    Look up Existing GatewayBlockVolume Resource

    Get an existing GatewayBlockVolume 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?: GatewayBlockVolumeState, opts?: CustomResourceOptions): GatewayBlockVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cache_mode: Optional[str] = None,
        chap_enabled: Optional[bool] = None,
        chap_in_password: Optional[str] = None,
        chap_in_user: Optional[str] = None,
        chunk_size: Optional[int] = None,
        gateway_block_volume_name: Optional[str] = None,
        gateway_id: Optional[str] = None,
        index_id: Optional[str] = None,
        is_source_deletion: Optional[bool] = None,
        local_path: Optional[str] = None,
        oss_bucket_name: Optional[str] = None,
        oss_bucket_ssl: Optional[bool] = None,
        oss_endpoint: Optional[str] = None,
        protocol: Optional[str] = None,
        recovery: Optional[bool] = None,
        size: Optional[int] = None,
        status: Optional[str] = None) -> GatewayBlockVolume
    func GetGatewayBlockVolume(ctx *Context, name string, id IDInput, state *GatewayBlockVolumeState, opts ...ResourceOption) (*GatewayBlockVolume, error)
    public static GatewayBlockVolume Get(string name, Input<string> id, GatewayBlockVolumeState? state, CustomResourceOptions? opts = null)
    public static GatewayBlockVolume get(String name, Output<String> id, GatewayBlockVolumeState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:cloudstoragegateway:GatewayBlockVolume    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:
    CacheMode string
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    ChapEnabled bool
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    ChapInPassword string
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChapInUser string
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChunkSize int
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    GatewayBlockVolumeName string
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    GatewayId string
    The Gateway ID.
    IndexId string
    The ID of the index.
    IsSourceDeletion bool
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    LocalPath string
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    OssBucketName string
    The name of the OSS Bucket.
    OssBucketSsl bool
    Whether to enable SSL access your OSS Buckets. Default value: true.
    OssEndpoint string
    The endpoint of the OSS Bucket.
    Protocol string
    The Protocol. Valid values: iSCSI.
    Recovery bool
    The recovery.
    Size int
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    Status string
    The status of volume. Valid values:
    CacheMode string
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    ChapEnabled bool
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    ChapInPassword string
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChapInUser string
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    ChunkSize int
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    GatewayBlockVolumeName string
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    GatewayId string
    The Gateway ID.
    IndexId string
    The ID of the index.
    IsSourceDeletion bool
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    LocalPath string
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    OssBucketName string
    The name of the OSS Bucket.
    OssBucketSsl bool
    Whether to enable SSL access your OSS Buckets. Default value: true.
    OssEndpoint string
    The endpoint of the OSS Bucket.
    Protocol string
    The Protocol. Valid values: iSCSI.
    Recovery bool
    The recovery.
    Size int
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    Status string
    The status of volume. Valid values:
    cacheMode String
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chapEnabled Boolean
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chapInPassword String
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chapInUser String
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunkSize Integer
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    gatewayBlockVolumeName String
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gatewayId String
    The Gateway ID.
    indexId String
    The ID of the index.
    isSourceDeletion Boolean
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    localPath String
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    ossBucketName String
    The name of the OSS Bucket.
    ossBucketSsl Boolean
    Whether to enable SSL access your OSS Buckets. Default value: true.
    ossEndpoint String
    The endpoint of the OSS Bucket.
    protocol String
    The Protocol. Valid values: iSCSI.
    recovery Boolean
    The recovery.
    size Integer
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    status String
    The status of volume. Valid values:
    cacheMode string
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chapEnabled boolean
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chapInPassword string
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chapInUser string
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunkSize number
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    gatewayBlockVolumeName string
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gatewayId string
    The Gateway ID.
    indexId string
    The ID of the index.
    isSourceDeletion boolean
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    localPath string
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    ossBucketName string
    The name of the OSS Bucket.
    ossBucketSsl boolean
    Whether to enable SSL access your OSS Buckets. Default value: true.
    ossEndpoint string
    The endpoint of the OSS Bucket.
    protocol string
    The Protocol. Valid values: iSCSI.
    recovery boolean
    The recovery.
    size number
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    status string
    The status of volume. Valid values:
    cache_mode str
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chap_enabled bool
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chap_in_password str
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chap_in_user str
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunk_size int
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    gateway_block_volume_name str
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gateway_id str
    The Gateway ID.
    index_id str
    The ID of the index.
    is_source_deletion bool
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    local_path str
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    oss_bucket_name str
    The name of the OSS Bucket.
    oss_bucket_ssl bool
    Whether to enable SSL access your OSS Buckets. Default value: true.
    oss_endpoint str
    The endpoint of the OSS Bucket.
    protocol str
    The Protocol. Valid values: iSCSI.
    recovery bool
    The recovery.
    size int
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    status str
    The status of volume. Valid values:
    cacheMode String
    The Block volume set mode to cache mode. Valid values: Cache, WriteThrough.
    chapEnabled Boolean
    Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value: false.
    chapInPassword String
    The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chapInUser String
    The Inbound CHAP user. The chap_in_user must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When the chap_enabled is true is,The chap_in_password is valid.
    chunkSize Number
    The Block volume storage allocation unit. Valid values: 8192, 16384, 32768, 65536, 131072. Default value: 32768. Unit: Byte.
    gatewayBlockVolumeName String
    The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
    gatewayId String
    The Gateway ID.
    indexId String
    The ID of the index.
    isSourceDeletion Boolean
    Whether to delete the source data. Default value true. NOTE: When is_source_deletion is true, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution.
    localPath String
    The Cache disk to local path. NOTE: When the cache_mode is Cache is,The chap_in_password is valid.
    ossBucketName String
    The name of the OSS Bucket.
    ossBucketSsl Boolean
    Whether to enable SSL access your OSS Buckets. Default value: true.
    ossEndpoint String
    The endpoint of the OSS Bucket.
    protocol String
    The Protocol. Valid values: iSCSI.
    recovery Boolean
    The recovery.
    size Number
    The Volume size. Valid values: 1 to 262144. Unit: Byte.
    status String
    The status of volume. Valid values:

    Import

    Cloud Storage Gateway Gateway Block Volume can be imported using the id, e.g.

    $ pulumi import alicloud:cloudstoragegateway/gatewayBlockVolume:GatewayBlockVolume example <gateway_id>:<index_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-alicloud