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

Interface IamWorkforcePoolConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    IamWorkforcePoolConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.561Z")
@Stability(Stable)
public interface IamWorkforcePoolConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        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}

      • getParent

        @Stability(Stable)
@NotNull
String getParent()
        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}

      • getWorkforcePoolId

        @Stability(Stable)
@NotNull
String getWorkforcePoolId()
        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}

      • getAccessRestrictions

        @Stability(Stable)
@Nullable
default IamWorkforcePoolAccessRestrictions getAccessRestrictions()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getDisabled

        @Stability(Stable)
@Nullable
default Object getDisabled()
        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}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getSessionDuration

        @Stability(Stable)
@Nullable
default String getSessionDuration()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default IamWorkforcePoolTimeouts getTimeouts()
        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}