Package com.hashicorp.cdktf.providers.google.dataplex_zone

Interface DataplexZoneConfig

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

    • Method Detail

      • getDiscoverySpec

        @Stability(Stable)
@NotNull
DataplexZoneDiscoverySpec getDiscoverySpec()
        discovery_spec block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#discovery_spec DataplexZone#discovery_spec}

      • getLake

        @Stability(Stable)
@NotNull
String getLake()
        The lake for the resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#lake DataplexZone#lake}

      • 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/dataplex_zone#location DataplexZone#location}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The name of the zone.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#name DataplexZone#name}

      • getResourceSpec

        @Stability(Stable)
@NotNull
DataplexZoneResourceSpec getResourceSpec()
        resource_spec block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#resource_spec DataplexZone#resource_spec}

      • getType

        @Stability(Stable)
@NotNull
String getType()
        Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#type DataplexZone#type}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Optional. Description of the zone.

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

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        Optional. User friendly display name.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#display_name DataplexZone#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/dataplex_zone#id DataplexZone#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.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        Optional. User defined labels for the zone.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effective_labels` for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#labels DataplexZone#labels}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The project for the resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_zone#project DataplexZone#project}

      • getTimeouts

        @Stability(Stable)
@Nullable
default DataplexZoneTimeouts getTimeouts()
        timeouts block.

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