Package com.hashicorp.cdktf.providers.google.tags_tag_key

Class TagsTagKey.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<TagsTagKey>
    Enclosing class:
    TagsTagKey
    @Stability(Stable)
public static final class TagsTagKey.Builder
extends Object
implements software.amazon.jsii.Builder<TagsTagKey>
    A fluent builder for TagsTagKey.

    • Method Detail

      • create

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

      • connection

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

      • connection

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

      • count

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • parent

        @Stability(Stable)
public TagsTagKey.Builder parent​(String parent)
        Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id} or projects/{project_id_or_number}.

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

        Parameters:
        parent - Input only. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id} or projects/{project_id_or_number}. This parameter is required.
        Returns:
        this

      • shortName

        @Stability(Stable)
public TagsTagKey.Builder shortName​(String shortName)
        Input only.

        The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tags_tag_key#short_name TagsTagKey#short_name}

        Parameters:
        shortName - Input only. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public TagsTagKey.Builder description​(String description)
        User-assigned description of the TagKey. Must not exceed 256 characters.

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

        Parameters:
        description - User-assigned description of the TagKey. Must not exceed 256 characters. This parameter is required.
        Returns:
        this

      • id

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

      • purpose

        @Stability(Stable)
public TagsTagKey.Builder purpose​(String purpose)
        Optional. A purpose cannot be changed once set.

        A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. Possible values: ["GCE_FIREWALL"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tags_tag_key#purpose TagsTagKey#purpose}

        Parameters:
        purpose - Optional. A purpose cannot be changed once set. This parameter is required.
        Returns:
        this

      • purposeData

        @Stability(Stable)
public TagsTagKey.Builder purposeData​(Map<String,​String> purposeData)
        Optional. Purpose data cannot be changed once set.

        Purpose data corresponds to the policy system that the tag is intended for. For example, the GCE_FIREWALL purpose expects data in the following format: 'network = "/"'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/tags_tag_key#purpose_data TagsTagKey#purpose_data}

        Parameters:
        purposeData - Optional. Purpose data cannot be changed once set. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public TagsTagKey.Builder timeouts​(TagsTagKeyTimeouts timeouts)
        timeouts block.

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

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

      • build

        @Stability(Stable)
public TagsTagKey build()
        Specified by:
        build in interface software.amazon.jsii.Builder<TagsTagKey>
        Returns:
        a newly built instance of TagsTagKey.