Google Anthos Multi Cloud V1 Client - Class AwsVolumeTemplate (0.5.4)

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

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

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.

↳ throughput int

Optional. The throughput that the volume supports, in MiB/s. Only valid if volume_type is GP3. If the volume_type is GP3 and this is not speficied, it defaults to 125.

↳ 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.

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getVolumeType

Optional. Type of the EBS volume.

When unspecified, it defaults to GP2 volume.

Returns
Type Description
int

setVolumeType

Optional. Type of the EBS volume.

When unspecified, it defaults to GP2 volume.

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.

Returns
Type Description
int

setIops

Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume.

Parameter
Name Description
var int
Returns
Type Description
$this

getThroughput

Optional. The throughput that the volume supports, in MiB/s. Only valid if volume_type is GP3.

If the volume_type is GP3 and this is not speficied, it defaults to 125.

Returns
Type Description
int

setThroughput

Optional. The throughput that the volume supports, in MiB/s. Only valid if volume_type is GP3.

If the volume_type is GP3 and this is not speficied, it defaults to 125.

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this