Package com.hashicorp.cdktf.providers.google.iam_workforce_pool

Class IamWorkforcePool.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static IamWorkforcePool.Builder create​(software.constructs.Construct scope,
                                              String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of IamWorkforcePool.Builder.

      • connection

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

      • connection

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

      • count

        @Stability(Experimental)
public IamWorkforcePool.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

        @Stability(Experimental)
public IamWorkforcePool.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public IamWorkforcePool.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#location IamWorkforcePool#location}

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

      • parent

        @Stability(Stable)
public IamWorkforcePool.Builder parent​(String parent)
        Immutable. The resource name of the parent. Format: 'organizations/{org-id}'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool#parent IamWorkforcePool#parent}

        Parameters:
        parent - Immutable. The resource name of the parent. Format: 'organizations/{org-id}'. This parameter is required.
        Returns:
        this

      • workforcePoolId

        @Stability(Stable)
public IamWorkforcePool.Builder workforcePoolId​(String workforcePoolId)
        The name of the pool.

        The ID 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#workforce_pool_id IamWorkforcePool#workforce_pool_id}

        Parameters:
        workforcePoolId - The name of the pool. This parameter is required.
        Returns:
        this

      • accessRestrictions

        @Stability(Stable)
public IamWorkforcePool.Builder accessRestrictions​(IamWorkforcePoolAccessRestrictions accessRestrictions)
        access_restrictions block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool#access_restrictions IamWorkforcePool#access_restrictions}

        Parameters:
        accessRestrictions - access_restrictions block. This parameter is required.
        Returns:
        this

      • description

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

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

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

      • disabled

        @Stability(Stable)
public IamWorkforcePool.Builder disabled​(Boolean disabled)
        Whether the pool is disabled.

        You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool#disabled IamWorkforcePool#disabled}

        Parameters:
        disabled - Whether the pool is disabled. This parameter is required.
        Returns:
        this

      • disabled

        @Stability(Stable)
public IamWorkforcePool.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        Whether the pool is disabled.

        You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool#disabled IamWorkforcePool#disabled}

        Parameters:
        disabled - Whether the pool is disabled. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public IamWorkforcePool.Builder displayName​(String displayName)
        A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.

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

        Parameters:
        displayName - A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public IamWorkforcePool.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool#id IamWorkforcePool#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#id IamWorkforcePool#id}. This parameter is required.
        Returns:
        this

      • sessionDuration

        @Stability(Stable)
public IamWorkforcePool.Builder sessionDuration​(String sessionDuration)
        Duration that the Google Cloud access tokens, console sign-in sessions, and 'gcloud' sign-in sessions from this pool are valid.

        Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If 'sessionDuration' is not configured, minted credentials have a default duration of one hour (3600s). A duration in seconds with up to nine fractional digits, ending with ''s''. Example: "'3.5s'". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/iam_workforce_pool#session_duration IamWorkforcePool#session_duration}

        Parameters:
        sessionDuration - Duration that the Google Cloud access tokens, console sign-in sessions, and 'gcloud' sign-in sessions from this pool are valid. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public IamWorkforcePool.Builder timeouts​(IamWorkforcePoolTimeouts timeouts)
        timeouts block.

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

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