Package com.hashicorp.cdktf.providers.google.cloud_identity_group

Class CloudIdentityGroup.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static CloudIdentityGroup.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 CloudIdentityGroup.Builder.

      • connection

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

      • connection

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • groupKey

        @Stability(Stable)
public CloudIdentityGroup.Builder groupKey​(CloudIdentityGroupGroupKey groupKey)
        group_key block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_identity_group#group_key CloudIdentityGroup#group_key}

        Parameters:
        groupKey - group_key block. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public CloudIdentityGroup.Builder labels​(Map<String,​String> labels)
        One or more label entries that apply to the Group.

        Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_identity_group#labels CloudIdentityGroup#labels}

        Parameters:
        labels - One or more label entries that apply to the Group. This parameter is required.
        Returns:
        this

      • parent

        @Stability(Stable)
public CloudIdentityGroup.Builder parent​(String parent)
        The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy.

        Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_identity_group#parent CloudIdentityGroup#parent}

        Parameters:
        parent - The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public CloudIdentityGroup.Builder description​(String description)
        An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.

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

        Parameters:
        description - An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public CloudIdentityGroup.Builder displayName​(String displayName)
        The display name of the Group.

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

        Parameters:
        displayName - The display name of the Group. This parameter is required.
        Returns:
        this

      • id

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

      • initialGroupConfig

        @Stability(Stable)
public CloudIdentityGroup.Builder initialGroupConfig​(String initialGroupConfig)
        The initial configuration options for creating a Group.

        See the [API reference](https://cloud.google.com/identity/docs/reference/rest/v1beta1/groups/create#initialgroupconfig) for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_identity_group#initial_group_config CloudIdentityGroup#initial_group_config}

        Parameters:
        initialGroupConfig - The initial configuration options for creating a Group. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public CloudIdentityGroup.Builder timeouts​(CloudIdentityGroupTimeouts timeouts)
        timeouts block.

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

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