gcloud iam workload-identity-pools providers update-aws - update an AWS workload identity pool provider

gcloud iam workload-identity-pools providers update-aws(PROVIDER :--location=LOCATION--workload-identity-pool=WORKLOAD_IDENTITY_POOL)[--account-id=ACCOUNT_ID][--attribute-condition=ATTRIBUTE_CONDITION][--attribute-mapping=[KEY=VALUE,…]][--description=DESCRIPTION][--disabled][--display-name=DISPLAY_NAME][GCLOUD_WIDE_FLAG …]

Workload identity pool provider resource - The workload identity pool providerto update. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.

To set theproject attribute:

• provide the argumentprovider on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

This must be specified.

PROVIDER

ID of the workload identity pool provider or fully qualified identifier for theworkload identity pool provider.

To set theprovider attribute:

• provide the argumentprovider on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--location=LOCATION

The location name.

To set thelocation attribute:

• provide the argumentprovider on the command line with a fullyspecified name;
• provide the argument--location on the command line.

--workload-identity-pool=WORKLOAD_IDENTITY_POOL

The ID to use for the pool, which becomes the final component of the resourcename. This value should be 4-32 characters, and may contain the characters[a-z0-9-]. The prefixgcp- is reserved for use by Google, and maynot be specified.To set theworkload-identity-pool attribute:

• provide the argumentprovider on the command line with a fullyspecified name;
• provide the argument--workload-identity-pool on the command line.

--account-id=ACCOUNT_ID

The AWS account ID.

--attribute-condition=ATTRIBUTE_CONDITION

A Common ExpressionLanguage expression, in plain text, to restrict what otherwise validauthentication credentials issued by the provider should not be accepted.

The expression must output a boolean representing whether to allow thefederation.

The following keywords may be referenced in the expressions:

• assertion: JSON representing the authentication credential issuedby the provider.
• google: The Google attributes mapped from the assertion in theattribute_mappings.
• attribute: The custom attributes mapped from the assertion in theattribute_mappings.

The maximum length of the attribute condition expression is 4096 characters. Ifunspecified, all valid authentication credential are accepted.

The following example shows how to only allow credentials with a mappedgoogle.groups value ofadmins:

"'admins' in google.groups"

--attribute-mapping=[KEY=VALUE,…]

Maps attributes from authentication credentials issued by an external identityprovider to Google Cloud attributes, such assubject andsegment.

Each key must be a string specifying the Google Cloud IAM attribute to map to.

The following keys are supported:

• google.subject: The principal IAM is authenticating. You canreference this value in IAM bindings. This is also the subject that appears inCloud Logging logs. Cannot exceed 127 bytes.

• google.groups: Groups the external identity belongs to. You cangrant groups access to resources using an IAMprincipalSet binding;access applies to all members of the group.

You can also provide custom attributes by specifyingattribute.{custom_attribute}, where{custom_attribute}is the name of the custom attribute to be mapped. You can define a maximum of 50custom attributes. The maximum length of a mapped attribute key is 100characters, and the key may only contain the characters[a-z_0-9].

You can reference these attributes in IAM policies to define fine-grained accessfor a workload to Google Cloud resources. For example:

• google.subject:principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}

• google.groups:principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}

• attribute.{custom_attribute}:principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}

Each value must be aCommonExpression Language function that maps an identity provider credential tothe normalized attribute specified by the corresponding map key.

You can use theassertion keyword in the expression to access aJSON representation of the authentication credential issued by the provider.

The maximum length of an attribute mapping expression is 2048 characters. Whenevaluated, the total size of all mapped attributes must not exceed 8KB.

For AWS providers, the following rules apply:

• If no attribute mapping is defined, the following default mapping applies:

{"google.subject":"assertion.arn","attribute.aws_role":"assertion.arn.contains('assumed-role')"" ? assertion.arn.extract('{account_arn}assumed-role/')""   + 'assumed-role/'""   + assertion.arn.extract('assumed-role/{role_name}/')"" : assertion.arn",}

• If any custom attribute mappings are defined, they must include a mapping to thegoogle.subject attribute.

For OIDC providers, the following rules apply:

• Custom attribute mappings must be defined, and must include a mapping to thegoogle.subject attribute. For example, the following maps thesub claim of the incoming credential to thesubjectattribute on a Google token.

{"google.subject":"assertion.sub"}

--description=DESCRIPTION

A description for the provider. Cannot exceed 256 characters.

--disabled

Whether the provider is disabled. You cannot use a disabled provider to exchangetokens. However, existing tokens still grant access.

--display-name=DISPLAY_NAME

A display name for the provider. Cannot exceed 32 characters.

Run$gcloud help for details.