Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AwsVolumeTemplate.
Configuration template for AWS EBS volumes.
Generated from protobuf message google.cloud.gkemulticloud.v1.AwsVolumeTemplate
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ size_gib |
int
Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. |
↳ volume_type |
int
Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. |
↳ iops |
int
Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. |
↳ kms_key_arn |
string
Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. |
getSizeGib
Optional. The size of the volume, in GiBs.
When unspecified, a default value is provided. See the specific reference in the parent resource.
Generated from protobuf field int32 size_gib = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setSizeGib
Optional. The size of the volume, in GiBs.
When unspecified, a default value is provided. See the specific reference in the parent resource.
Generated from protobuf field int32 size_gib = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVolumeType
Optional. Type of the EBS volume.
When unspecified, it defaults to GP2 volume.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate.VolumeType volume_type = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setVolumeType
Optional. Type of the EBS volume.
When unspecified, it defaults to GP2 volume.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate.VolumeType volume_type = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIops
Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume.
Generated from protobuf field int32 iops = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setIops
Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume.
Generated from protobuf field int32 iops = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsKeyArn
Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes.
If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used.
Generated from protobuf field string kms_key_arn = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyArn
Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes.
If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used.
Generated from protobuf field string kms_key_arn = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |