alicloud.cloudstoragegateway.GatewayBlockVolume
Explore with Pulumi AI
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,
local_path: Optional[str] = None,
chap_enabled: Optional[bool] = None,
is_source_deletion: Optional[bool] = None,
chunk_size: Optional[int] = None,
cache_mode: Optional[str] = None,
oss_bucket_ssl: 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",
LocalPath = "string",
ChapEnabled = false,
IsSourceDeletion = false,
ChunkSize = 0,
CacheMode = "string",
OssBucketSsl = 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"),
LocalPath: pulumi.String("string"),
ChapEnabled: pulumi.Bool(false),
IsSourceDeletion: pulumi.Bool(false),
ChunkSize: pulumi.Int(0),
CacheMode: pulumi.String("string"),
OssBucketSsl: 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")
.localPath("string")
.chapEnabled(false)
.isSourceDeletion(false)
.chunkSize(0)
.cacheMode("string")
.ossBucketSsl(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",
local_path="string",
chap_enabled=False,
is_source_deletion=False,
chunk_size=0,
cache_mode="string",
oss_bucket_ssl=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",
localPath: "string",
chapEnabled: false,
isSourceDeletion: false,
chunkSize: 0,
cacheMode: "string",
ossBucketSsl: 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:
- Gateway
Block stringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- Gateway
Id string - The Gateway ID.
- Oss
Bucket stringName - The name of the OSS Bucket.
- Oss
Endpoint string - The endpoint of the OSS Bucket.
- Protocol string
- The Protocol. Valid values:
iSCSI
. - Cache
Mode string - 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 stringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - Chap
In stringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_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 boolDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - Local
Path string - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - Oss
Bucket boolSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - Recovery bool
- The recovery.
- Size int
- The Volume size. Valid values:
1
to262144
. Unit:Byte
.
- Gateway
Block stringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- Gateway
Id string - The Gateway ID.
- Oss
Bucket stringName - The name of the OSS Bucket.
- Oss
Endpoint string - The endpoint of the OSS Bucket.
- Protocol string
- The Protocol. Valid values:
iSCSI
. - Cache
Mode string - 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 stringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - Chap
In stringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_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 boolDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - Local
Path string - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - Oss
Bucket boolSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - Recovery bool
- The recovery.
- Size int
- The Volume size. Valid values:
1
to262144
. Unit:Byte
.
- gateway
Block StringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- gateway
Id String - The Gateway ID.
- oss
Bucket StringName - The name of the OSS Bucket.
- oss
Endpoint String - The endpoint of the OSS Bucket.
- protocol String
- The Protocol. Valid values:
iSCSI
. - cache
Mode String - The Block volume set mode to cache mode. Valid values:
Cache
,WriteThrough
. - chap
Enabled Boolean - Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value:
false
. - chap
In StringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap
In StringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_in_password
is valid. - chunk
Size Integer - The Block volume storage allocation unit. Valid values:
8192
,16384
,32768
,65536
,131072
. Default value:32768
. Unit:Byte
. - is
Source BooleanDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - local
Path String - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - oss
Bucket BooleanSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - recovery Boolean
- The recovery.
- size Integer
- The Volume size. Valid values:
1
to262144
. Unit:Byte
.
- gateway
Block stringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- gateway
Id string - The Gateway ID.
- oss
Bucket stringName - The name of the OSS Bucket.
- oss
Endpoint string - The endpoint of the OSS Bucket.
- protocol string
- The Protocol. Valid values:
iSCSI
. - cache
Mode string - The Block volume set mode to cache mode. Valid values:
Cache
,WriteThrough
. - chap
Enabled boolean - Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value:
false
. - chap
In stringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap
In stringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_in_password
is valid. - chunk
Size number - The Block volume storage allocation unit. Valid values:
8192
,16384
,32768
,65536
,131072
. Default value:32768
. Unit:Byte
. - is
Source booleanDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - local
Path string - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - oss
Bucket booleanSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - recovery boolean
- The recovery.
- size number
- The Volume size. Valid values:
1
to262144
. Unit:Byte
.
- gateway_
block_ strvolume_ name - 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_ strname - 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_ strpassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap_
in_ struser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_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_ booldeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, 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
isCache
is,Thechap_in_password
is valid. - oss_
bucket_ boolssl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - recovery bool
- The recovery.
- size int
- The Volume size. Valid values:
1
to262144
. Unit:Byte
.
- gateway
Block StringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- gateway
Id String - The Gateway ID.
- oss
Bucket StringName - The name of the OSS Bucket.
- oss
Endpoint String - The endpoint of the OSS Bucket.
- protocol String
- The Protocol. Valid values:
iSCSI
. - cache
Mode String - The Block volume set mode to cache mode. Valid values:
Cache
,WriteThrough
. - chap
Enabled Boolean - Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value:
false
. - chap
In StringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap
In StringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_in_password
is valid. - chunk
Size Number - The Block volume storage allocation unit. Valid values:
8192
,16384
,32768
,65536
,131072
. Default value:32768
. Unit:Byte
. - is
Source BooleanDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - local
Path String - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - oss
Bucket BooleanSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - recovery Boolean
- The recovery.
- size Number
- The Volume size. Valid values:
1
to262144
. Unit:Byte
.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayBlockVolume resource produces the following output properties:
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)
Resource lookup is not supported in YAML
- 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.
- Cache
Mode string - 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 stringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - Chap
In stringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_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 stringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- Gateway
Id string - The Gateway ID.
- Index
Id string - The ID of the index.
- Is
Source boolDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - Local
Path string - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - Oss
Bucket stringName - The name of the OSS Bucket.
- Oss
Bucket boolSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - Oss
Endpoint 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
to262144
. Unit:Byte
. - Status string
- The status of volume. Valid values:
- Cache
Mode string - 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 stringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - Chap
In stringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_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 stringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- Gateway
Id string - The Gateway ID.
- Index
Id string - The ID of the index.
- Is
Source boolDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - Local
Path string - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - Oss
Bucket stringName - The name of the OSS Bucket.
- Oss
Bucket boolSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - Oss
Endpoint 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
to262144
. Unit:Byte
. - Status string
- The status of volume. Valid values:
- cache
Mode String - The Block volume set mode to cache mode. Valid values:
Cache
,WriteThrough
. - chap
Enabled Boolean - Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value:
false
. - chap
In StringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap
In StringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_in_password
is valid. - chunk
Size Integer - The Block volume storage allocation unit. Valid values:
8192
,16384
,32768
,65536
,131072
. Default value:32768
. Unit:Byte
. - gateway
Block StringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- gateway
Id String - The Gateway ID.
- index
Id String - The ID of the index.
- is
Source BooleanDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - local
Path String - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - oss
Bucket StringName - The name of the OSS Bucket.
- oss
Bucket BooleanSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - oss
Endpoint 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
to262144
. Unit:Byte
. - status String
- The status of volume. Valid values:
- cache
Mode string - The Block volume set mode to cache mode. Valid values:
Cache
,WriteThrough
. - chap
Enabled boolean - Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value:
false
. - chap
In stringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap
In stringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_in_password
is valid. - chunk
Size number - The Block volume storage allocation unit. Valid values:
8192
,16384
,32768
,65536
,131072
. Default value:32768
. Unit:Byte
. - gateway
Block stringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- gateway
Id string - The Gateway ID.
- index
Id string - The ID of the index.
- is
Source booleanDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - local
Path string - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - oss
Bucket stringName - The name of the OSS Bucket.
- oss
Bucket booleanSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - oss
Endpoint 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
to262144
. 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_ strpassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap_
in_ struser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_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_ strvolume_ name - 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_ booldeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, 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
isCache
is,Thechap_in_password
is valid. - oss_
bucket_ strname - The name of the OSS Bucket.
- oss_
bucket_ boolssl - 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
to262144
. Unit:Byte
. - status str
- The status of volume. Valid values:
- cache
Mode String - The Block volume set mode to cache mode. Valid values:
Cache
,WriteThrough
. - chap
Enabled Boolean - Whether to enable iSCSI access of CHAP authentication, which currently supports both CHAP inbound authentication. Default value:
false
. - chap
In StringPassword - The password for inbound authentication when the block volume enables iSCSI access to CHAP authentication. NOTE: When the
chap_enabled
istrue
is,Thechap_in_password
is valid. - chap
In StringUser - The Inbound CHAP user. The
chap_in_user
must be 1 to 32 characters in length, and can contain letters and digits. NOTE: When thechap_enabled
istrue
is,Thechap_in_password
is valid. - chunk
Size Number - The Block volume storage allocation unit. Valid values:
8192
,16384
,32768
,65536
,131072
. Default value:32768
. Unit:Byte
. - gateway
Block StringVolume Name - The Block volume name. The name must be 1 to 32 characters in length, and can contain lower case letters and digits.
- gateway
Id String - The Gateway ID.
- index
Id String - The ID of the index.
- is
Source BooleanDeletion - Whether to delete the source data. Default value
true
. NOTE: Whenis_source_deletion
istrue
, the data in the OSS Bucket on the cloud is also deleted when deleting the block gateway volume. Please operate with caution. - local
Path String - The Cache disk to local path. NOTE: When the
cache_mode
isCache
is,Thechap_in_password
is valid. - oss
Bucket StringName - The name of the OSS Bucket.
- oss
Bucket BooleanSsl - Whether to enable SSL access your OSS Buckets. Default value:
true
. - oss
Endpoint 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
to262144
. 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.