Google Anthos Multi Cloud V1 Client - Class AwsCluster (1.2.2)

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

An Anthos cluster running on AWS.

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

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

The name of this resource. Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id> . See Resource Names for more details on Google Cloud Platform resource names.

↳ description
string

Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

↳ networking
AwsClusterNetworking

Required. Cluster-wide networking configuration.

↳ aws_region
string

Required. The AWS region where the cluster runs. Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

↳ control_plane
AwsControlPlane

Required. Configuration related to the cluster control plane.

↳ authorization
AwsAuthorization

Required. Configuration related to the cluster RBAC settings.

↳ state
int

Output only. The current state of the cluster.

↳ endpoint
string

Output only. The endpoint of the cluster's API server.

↳ uid
string

Output only. A globally unique identifier for the cluster.

↳ reconciling
bool

Output only. If set, there are currently changes in flight to the cluster.

↳ create_time
Google\Protobuf\Timestamp

Output only. The time at which this cluster was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time at which this cluster was last updated.

↳ etag
string

Allows clients to perform consistent read-modify-writes through optimistic concurrency control. Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

↳ annotations
array| Google\Protobuf\Internal\MapField

Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

↳ workload_identity_config
WorkloadIdentityConfig

Output only. Workload Identity settings.

↳ cluster_ca_certificate
string

Output only. PEM encoded x509 certificate of the cluster root of trust.

↳ fleet
Fleet

Required. Fleet configuration.

↳ logging_config
LoggingConfig

Optional. Logging configuration for this cluster.

↳ errors
array< AwsClusterError >

Output only. A set of errors found in the cluster.

↳ monitoring_config
MonitoringConfig

Optional. Monitoring configuration for this cluster.

↳ binary_authorization
BinaryAuthorization

Optional. Binary Authorization configuration for this cluster.

getName

The name of this resource.

Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id> . See Resource Names for more details on Google Cloud Platform resource names.

Returns
Type
Description
string

setName

The name of this resource.

Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id> . See Resource Names for more details on Google Cloud Platform resource names.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. A human readable description of this cluster.

Cannot be longer than 255 UTF-8 encoded bytes.

Returns
Type
Description
string

setDescription

Optional. A human readable description of this cluster.

Cannot be longer than 255 UTF-8 encoded bytes.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNetworking

Required. Cluster-wide networking configuration.

Returns
Type
Description

hasNetworking

clearNetworking

setNetworking

Required. Cluster-wide networking configuration.

Parameter
Name
Description
Returns
Type
Description
$this

getAwsRegion

Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

Returns
Type
Description
string

setAwsRegion

Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getControlPlane

Required. Configuration related to the cluster control plane.

Returns
Type
Description

hasControlPlane

clearControlPlane

setControlPlane

Required. Configuration related to the cluster control plane.

Parameter
Name
Description
Returns
Type
Description
$this

getAuthorization

Required. Configuration related to the cluster RBAC settings.

Returns
Type
Description

hasAuthorization

clearAuthorization

setAuthorization

Required. Configuration related to the cluster RBAC settings.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. The current state of the cluster.

Returns
Type
Description
int

setState

Output only. The current state of the cluster.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getEndpoint

Output only. The endpoint of the cluster's API server.

Returns
Type
Description
string

setEndpoint

Output only. The endpoint of the cluster's API server.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

Output only. A globally unique identifier for the cluster.

Returns
Type
Description
string

setUid

Output only. A globally unique identifier for the cluster.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReconciling

Output only. If set, there are currently changes in flight to the cluster.

Returns
Type
Description
bool

setReconciling

Output only. If set, there are currently changes in flight to the cluster.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getCreateTime

Output only. The time at which this cluster was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which this cluster was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time at which this cluster was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which this cluster was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
Type
Description
string

setEtag

Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAnnotations

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Returns
Type
Description

setAnnotations

Optional. Annotations on the cluster.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Parameter
Name
Description
Returns
Type
Description
$this

getWorkloadIdentityConfig

Output only. Workload Identity settings.

Returns
Type
Description

hasWorkloadIdentityConfig

clearWorkloadIdentityConfig

setWorkloadIdentityConfig

Output only. Workload Identity settings.

Parameter
Name
Description
Returns
Type
Description
$this

getClusterCaCertificate

Output only. PEM encoded x509 certificate of the cluster root of trust.

Returns
Type
Description
string

setClusterCaCertificate

Output only. PEM encoded x509 certificate of the cluster root of trust.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFleet

Required. Fleet configuration.

Returns
Type
Description
Fleet |null

hasFleet

clearFleet

setFleet

Required. Fleet configuration.

Parameter
Name
Description
var
Returns
Type
Description
$this

getLoggingConfig

Optional. Logging configuration for this cluster.

Returns
Type
Description

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Optional. Logging configuration for this cluster.

Parameter
Name
Description
Returns
Type
Description
$this

getErrors

Output only. A set of errors found in the cluster.

Returns
Type
Description

setErrors

Output only. A set of errors found in the cluster.

Parameter
Name
Description
var
array< AwsClusterError >
Returns
Type
Description
$this

getMonitoringConfig

Optional. Monitoring configuration for this cluster.

Returns
Type
Description

hasMonitoringConfig

clearMonitoringConfig

setMonitoringConfig

Optional. Monitoring configuration for this cluster.

Parameter
Name
Description
Returns
Type
Description
$this

getBinaryAuthorization

Optional. Binary Authorization configuration for this cluster.

Returns
Type
Description

hasBinaryAuthorization

clearBinaryAuthorization

setBinaryAuthorization

Optional. Binary Authorization configuration for this cluster.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: