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

Interface CloudIdentityGroupConfig

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

    • Method Detail

      • getGroupKey

        @Stability(Stable)
@NotNull
CloudIdentityGroupGroupKey getGroupKey()
        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}

      • getLabels

        @Stability(Stable)
@NotNull
Map<String,​String> getLabels()
        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}

      • getParent

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

      • getDescription

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

      • getDisplayName

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

      • getId

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

      • getInitialGroupConfig

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

      • getTimeouts

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