Google Anthos Multi Cloud V1 Client - Class UpdateAwsClusterRequest (0.6.1)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class UpdateAwsClusterRequest.

Request message for AwsClusters.UpdateAwsCluster method.

Generated from protobuf message google.cloud.gkemulticloud.v1.UpdateAwsClusterRequest

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ aws_cluster Google\Cloud\GkeMultiCloud\V1\AwsCluster

Required. The AwsCluster resource to update.
↳ validate_only bool

If set, only validate the request, but do not actually update the cluster.
↳ update_mask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AwsCluster: * description. * annotations. * control_plane.version. * authorization.admin_users. * authorization.admin_groups. * binary_authorization.evaluation_mode. * control_plane.aws_services_authentication.role_arn. * control_plane.aws_services_authentication.role_session_name. * control_plane.config_encryption.kms_key_arn. * control_plane.instance_type. * control_plane.security_group_ids. * control_plane.proxy_config. * control_plane.proxy_config.secret_arn. * control_plane.proxy_config.secret_version. * control_plane.root_volume.size_gib. * control_plane.root_volume.volume_type. * control_plane.root_volume.iops. * control_plane.root_volume.throughput. * control_plane.root_volume.kms_key_arn. * control_plane.ssh_config. * control_plane.ssh_config.ec2_key_pair. * control_plane.instance_placement.tenancy. * control_plane.iam_instance_profile. * logging_config.component_config.enable_components. * control_plane.tags. * monitoring_config.managed_prometheus_config.enabled. * networking.per_node_pool_sg_rules_disabled.

getAwsCluster

Required. The AwsCluster resource to update.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AwsCluster|null

hasAwsCluster

clearAwsCluster

setAwsCluster

Required. The AwsCluster resource to update.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsCluster
Returns
Type Description
$this

getValidateOnly

If set, only validate the request, but do not actually update the cluster.

Returns
Type Description
bool

setValidateOnly

If set, only validate the request, but do not actually update the cluster.

Parameter
Name Description
var bool
Returns
Type Description
$this

getUpdateMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AwsCluster:

  • description.
  • annotations.
    • control_plane.version.
    • authorization.admin_users.
    • authorization.admin_groups.
    • binary_authorization.evaluation_mode.
    • control_plane.aws_services_authentication.role_arn.
    • control_plane.aws_services_authentication.role_session_name.
    • control_plane.config_encryption.kms_key_arn.
    • control_plane.instance_type.
    • control_plane.security_group_ids.
    • control_plane.proxy_config.
    • control_plane.proxy_config.secret_arn.
    • control_plane.proxy_config.secret_version.
    • control_plane.root_volume.size_gib.
    • control_plane.root_volume.volume_type.
    • control_plane.root_volume.iops.
    • control_plane.root_volume.throughput.
    • control_plane.root_volume.kms_key_arn.
    • control_plane.ssh_config.
    • control_plane.ssh_config.ec2_key_pair.
    • control_plane.instance_placement.tenancy.
    • control_plane.iam_instance_profile.
    • logging_config.component_config.enable_components.
    • control_plane.tags.
    • monitoring_config.managed_prometheus_config.enabled.
    • networking.per_node_pool_sg_rules_disabled.
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AwsCluster:

  • description.
  • annotations.
    • control_plane.version.
    • authorization.admin_users.
    • authorization.admin_groups.
    • binary_authorization.evaluation_mode.
    • control_plane.aws_services_authentication.role_arn.
    • control_plane.aws_services_authentication.role_session_name.
    • control_plane.config_encryption.kms_key_arn.
    • control_plane.instance_type.
    • control_plane.security_group_ids.
    • control_plane.proxy_config.
    • control_plane.proxy_config.secret_arn.
    • control_plane.proxy_config.secret_version.
    • control_plane.root_volume.size_gib.
    • control_plane.root_volume.volume_type.
    • control_plane.root_volume.iops.
    • control_plane.root_volume.throughput.
    • control_plane.root_volume.kms_key_arn.
    • control_plane.ssh_config.
    • control_plane.ssh_config.ec2_key_pair.
    • control_plane.instance_placement.tenancy.
    • control_plane.iam_instance_profile.
    • logging_config.component_config.enable_components.
    • control_plane.tags.
    • monitoring_config.managed_prometheus_config.enabled.
    • networking.per_node_pool_sg_rules_disabled.
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
awsCluster Google\Cloud\GkeMultiCloud\V1\AwsCluster

Required. The AwsCluster resource to update.
updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AwsCluster:

  • description.
  • annotations.
  • control_plane.version.
  • authorization.admin_users.
  • authorization.admin_groups.
  • binary_authorization.evaluation_mode.
  • control_plane.aws_services_authentication.role_arn.
  • control_plane.aws_services_authentication.role_session_name.
  • control_plane.config_encryption.kms_key_arn.
  • control_plane.instance_type.
  • control_plane.security_group_ids.
  • control_plane.proxy_config.
  • control_plane.proxy_config.secret_arn.
  • control_plane.proxy_config.secret_version.
  • control_plane.root_volume.size_gib.
  • control_plane.root_volume.volume_type.
  • control_plane.root_volume.iops.
  • control_plane.root_volume.throughput.
  • control_plane.root_volume.kms_key_arn.
  • control_plane.ssh_config.
  • control_plane.ssh_config.ec2_key_pair.
  • control_plane.instance_placement.tenancy.
  • control_plane.iam_instance_profile.
  • logging_config.component_config.enable_components.
  • control_plane.tags.
  • monitoring_config.managed_prometheus_config.enabled.
  • networking.per_node_pool_sg_rules_disabled.
Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\UpdateAwsClusterRequest