Package com.hashicorp.cdktf.providers.google.iam_workforce_pool_provider

Class IamWorkforcePoolProvider.Builder

    • Method Detail

      • connection

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public IamWorkforcePoolProvider.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder location​(String location)
        The location for the resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#location IamWorkforcePoolProvider#location}

        Parameters:
        location - The location for the resource. This parameter is required.
        Returns:
        this

      • providerId

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder providerId​(String providerId)
        The ID for the provider, which becomes the final component of the resource name.

        This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#provider_id IamWorkforcePoolProvider#provider_id}

        Parameters:
        providerId - The ID for the provider, which becomes the final component of the resource name. This parameter is required.
        Returns:
        this

      • workforcePoolId

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder workforcePoolId​(String workforcePoolId)
        The ID to use for the pool, which becomes the final component of the resource name.

        The IDs must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix 'gcp-' is reserved for use by Google, and may not be specified. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#workforce_pool_id IamWorkforcePoolProvider#workforce_pool_id}

        Parameters:
        workforcePoolId - The ID to use for the pool, which becomes the final component of the resource name. This parameter is required.
        Returns:
        this

      • attributeCondition

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder attributeCondition​(String attributeCondition)
        A Common Expression Language expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted.

        The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * 'assertion': JSON representing the authentication credential issued by the provider. * 'google': The Google attributes mapped from the assertion in the 'attribute_mappings'. 'google.profile_photo' and 'google.display_name' are not supported. * 'attribute': The custom attributes mapped from the assertion in the 'attribute_mappings'. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credentials will be accepted. The following example shows how to only allow credentials with a mapped 'google.groups' value of 'admins': ``` "'admins' in google.groups" ``` Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#attribute_condition IamWorkforcePoolProvider#attribute_condition}

        Parameters:
        attributeCondition - A Common Expression Language expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. This parameter is required.
        Returns:
        this

      • attributeMapping

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder attributeMapping​(Map<String,​String> attributeMapping)
        Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as 'subject' and 'segment'.

        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 can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * 'google.groups': Groups the authenticating user belongs to. You can grant groups access to resources using an IAM 'principalSet' binding; access applies to all members of the group. * 'google.display_name': The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, 'google.subject' will be displayed instead. This attribute cannot be referenced in IAM bindings. * 'google.profile_photo': The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying 'attribute.{custom_attribute}', where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * 'google.subject': 'principal://iam.googleapis.com/locations/{location}/workforcePools/{pool}/subject/{value}' * 'google.groups': 'principalSet://iam.googleapis.com/locations/{location}/workforcePools/{pool}/group/{value}' * 'attribute.{custom_attribute}': 'principalSet://iam.googleapis.com/locations/{location}/workforcePools/{pool}/attribute.{custom_attribute}/{value}' Each value must be a [Common Expression Language](https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the 'assertion' keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For OIDC providers, you must supply a custom mapping that includes the 'google.subject' attribute. For example, the following maps the sub claim of the incoming credential to the 'subject' attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` An object containing a list of '"key": value' pairs. Example: '{ "name": "wrench", "mass": "1.3kg", "count": "3" }'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#attribute_mapping IamWorkforcePoolProvider#attribute_mapping}

        Parameters:
        attributeMapping - Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as 'subject' and 'segment'. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder description​(String description)
        A user-specified description of the provider. Cannot exceed 256 characters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#description IamWorkforcePoolProvider#description}

        Parameters:
        description - A user-specified description of the provider. Cannot exceed 256 characters. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder disabled​(Boolean disabled)
        Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#disabled IamWorkforcePoolProvider#disabled}

        Parameters:
        disabled - Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#disabled IamWorkforcePoolProvider#disabled}

        Parameters:
        disabled - Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder displayName​(String displayName)
        A user-specified display name for the provider. Cannot exceed 32 characters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#display_name IamWorkforcePoolProvider#display_name}

        Parameters:
        displayName - A user-specified display name for the provider. Cannot exceed 32 characters. This parameter is required.
        Returns:
        this

      • extraAttributesOauth2Client

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder extraAttributesOauth2Client​(IamWorkforcePoolProviderExtraAttributesOauth2Client extraAttributesOauth2Client)
        extra_attributes_oauth2_client block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#extra_attributes_oauth2_client IamWorkforcePoolProvider#extra_attributes_oauth2_client}

        Parameters:
        extraAttributesOauth2Client - extra_attributes_oauth2_client block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#id IamWorkforcePoolProvider#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#id IamWorkforcePoolProvider#id}. This parameter is required.
        Returns:
        this

      • oidc

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder oidc​(IamWorkforcePoolProviderOidc oidc)
        oidc block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#oidc IamWorkforcePoolProvider#oidc}

        Parameters:
        oidc - oidc block. This parameter is required.
        Returns:
        this

      • saml

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder saml​(IamWorkforcePoolProviderSaml saml)
        saml block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#saml IamWorkforcePoolProvider#saml}

        Parameters:
        saml - saml block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public IamWorkforcePoolProvider.Builder timeouts​(IamWorkforcePoolProviderTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool_provider#timeouts IamWorkforcePoolProvider#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this