Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class CreateAwsClusterRequest.
Request message for AwsClusters.CreateAwsCluster method.
Generated from protobuf message google.cloud.gkemulticloud.v1.CreateAwsClusterRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent location where this AwsCluster resource will be created. Location names are formatted as See Resource Names for more details on Google Cloud resource names. Please see {@see \Google\Cloud\GkeMultiCloud\V1\AwsClustersClient::locationName()} for help formatting this field. |
awsCluster |
Google\Cloud\GkeMultiCloud\V1\AwsCluster
Required. The specification of the AwsCluster to create. |
awsClusterId |
string
Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the
AwsCluster resource name
formatted as
Valid characters are |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\CreateAwsClusterRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent location where this AwsCluster resource will be created. Location names are formatted as |
↳ aws_cluster |
Google\Cloud\GkeMultiCloud\V1\AwsCluster
Required. The specification of the AwsCluster to create. |
↳ aws_cluster_id |
string
Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AwsCluster resource name formatted as |
↳ validate_only |
bool
If set, only validate the request, but do not actually create the cluster. |
getParent
Required. The parent location where this AwsCluster resource will be created.
Location names are formatted as projects/<project-id>/locations/<region>.
See Resource Names
for more details on Google Cloud resource names.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent location where this AwsCluster resource will be created.
Location names are formatted as projects/<project-id>/locations/<region>.
See Resource Names
for more details on Google Cloud resource names.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAwsCluster
Required. The specification of the AwsCluster to create.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsCluster|null | |
hasAwsCluster
clearAwsCluster
setAwsCluster
Required. The specification of the AwsCluster to create.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsCluster
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAwsClusterId
Required. A client provided ID the resource. Must be unique within the parent resource.
The provided ID will be part of the
AwsCluster resource name
formatted as
projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.
Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setAwsClusterId
Required. A client provided ID the resource. Must be unique within the parent resource.
The provided ID will be part of the
AwsCluster resource name
formatted as
projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.
Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidateOnly
If set, only validate the request, but do not actually create the cluster.
| Returns | |
|---|---|
| Type | Description |
bool | |
setValidateOnly
If set, only validate the request, but do not actually create the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |