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 \ V1Methods
__construct
Constructor.
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
↳ 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
↳ authorization
↳ 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
↳ update_time
↳ 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
↳ cluster_ca_certificate
string
Output only. PEM encoded x509 certificate of the cluster root of trust.
↳ fleet
↳ logging_config
↳ errors
↳ monitoring_config
↳ binary_authorization
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.
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.
var
string
$this
getDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
string
setDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
var
string
$this
getNetworking
Required. Cluster-wide networking configuration.
hasNetworking
clearNetworking
setNetworking
Required. Cluster-wide networking configuration.
$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.
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.
var
string
$this
getControlPlane
Required. Configuration related to the cluster control plane.
hasControlPlane
clearControlPlane
setControlPlane
Required. Configuration related to the cluster control plane.
$this
getAuthorization
Required. Configuration related to the cluster RBAC settings.
hasAuthorization
clearAuthorization
setAuthorization
Required. Configuration related to the cluster RBAC settings.
$this
getState
Output only. The current state of the cluster.
int
setState
Output only. The current state of the cluster.
var
int
$this
getEndpoint
Output only. The endpoint of the cluster's API server.
string
setEndpoint
Output only. The endpoint of the cluster's API server.
var
string
$this
getUid
Output only. A globally unique identifier for the cluster.
string
setUid
Output only. A globally unique identifier for the cluster.
var
string
$this
getReconciling
Output only. If set, there are currently changes in flight to the cluster.
bool
setReconciling
Output only. If set, there are currently changes in flight to the cluster.
var
bool
$this
getCreateTime
Output only. The time at which this cluster was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this cluster was created.
$this
getUpdateTime
Output only. The time at which this cluster was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this cluster was last updated.
$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.
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.
var
string
$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.
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.
$this
getWorkloadIdentityConfig
Output only. Workload Identity settings.
hasWorkloadIdentityConfig
clearWorkloadIdentityConfig
setWorkloadIdentityConfig
Output only. Workload Identity settings.
$this
getClusterCaCertificate
Output only. PEM encoded x509 certificate of the cluster root of trust.
string
setClusterCaCertificate
Output only. PEM encoded x509 certificate of the cluster root of trust.
var
string
$this
getFleet
Required. Fleet configuration.
hasFleet
clearFleet
setFleet
Required. Fleet configuration.
$this
getLoggingConfig
Optional. Logging configuration for this cluster.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Logging configuration for this cluster.
$this
getErrors
Output only. A set of errors found in the cluster.
setErrors
Output only. A set of errors found in the cluster.
$this
getMonitoringConfig
Optional. Monitoring configuration for this cluster.
hasMonitoringConfig
clearMonitoringConfig
setMonitoringConfig
Optional. Monitoring configuration for this cluster.
$this
getBinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
hasBinaryAuthorization
clearBinaryAuthorization
setBinaryAuthorization
Optional. Binary Authorization configuration for this cluster.
$this