`dataCloudflareZone` Submodule

Constructs

DataCloudflareZone

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone cloudflare_zone}.

Initializers

import "github.com/cdktf/cdktf-provider-cloudflare-go/cloudflare/v11/datacloudflarezone"

datacloudflarezone.NewDataCloudflareZone(scope Construct, id *string, config DataCloudflareZoneConfig) DataCloudflareZone

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`DataCloudflareZoneConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`id`^Required

Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Optional

Type: DataCloudflareZoneConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	Adds this resource to the terraform JSON output.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.
`ResetAccountId`	No description.
`ResetId`	No description.
`ResetName`	No description.
`ResetZoneId`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: *string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

func ToHclTerraform() interface{}

Adds this resource to the terraform JSON output.

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`ResetAccountId`

func ResetAccountId()

`ResetId`

func ResetId()

`ResetName`

func ResetName()

`ResetZoneId`

func ResetZoneId()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformDataSource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a DataCloudflareZone resource upon running "cdktf plan ".

`IsConstruct`

import "github.com/cdktf/cdktf-provider-cloudflare-go/cloudflare/v11/datacloudflarezone"

datacloudflarezone.DataCloudflareZone_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-cloudflare-go/cloudflare/v11/datacloudflarezone"

datacloudflarezone.DataCloudflareZone_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformDataSource`

import "github.com/cdktf/cdktf-provider-cloudflare-go/cloudflare/v11/datacloudflarezone"

datacloudflarezone.DataCloudflareZone_IsTerraformDataSource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-cloudflare-go/cloudflare/v11/datacloudflarezone"

datacloudflarezone.DataCloudflareZone_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a DataCloudflareZone resource upon running "cdktf plan ".

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`importToId`^Required

Type: *string

The construct id used in the generated config for the DataCloudflareZone to import.

`importFromId`^Required

Type: *string

The id of the existing DataCloudflareZone that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the DataCloudflareZone to import is found.

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`TerraformMetaArguments`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`NameServers`	`[]string`	No description.
`Paused`	`github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable`	No description.
`Plan`	`*string`	No description.
`Status`	`*string`	No description.
`VanityNameServers`	`[]string`	No description.
`AccountIdInput`	`*string`	No description.
`IdInput`	`*string`	No description.
`NameInput`	`*string`	No description.
`ZoneIdInput`	`*string`	No description.
`AccountId`	`*string`	No description.
`Id`	`*string`	No description.
`Name`	`*string`	No description.
`ZoneId`	`*string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`NameServers`^Required

func NameServers() *[]*string

Type: *[]*string

`Paused`^Required

func Paused() IResolvable

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable

`Plan`^Required

func Plan() *string

Type: *string

`Status`^Required

func Status() *string

Type: *string

`VanityNameServers`^Required

func VanityNameServers() *[]*string

Type: *[]*string

`AccountIdInput`^Optional

func AccountIdInput() *string

Type: *string

`IdInput`^Optional

func IdInput() *string

Type: *string

`NameInput`^Optional

func NameInput() *string

Type: *string

`ZoneIdInput`^Optional

func ZoneIdInput() *string

Type: *string

`AccountId`^Required

func AccountId() *string

Type: *string

`Id`^Required

func Id() *string

Type: *string

`Name`^Required

func Name() *string

Type: *string

`ZoneId`^Required

func ZoneId() *string

Type: *string

Constants

Name	Type	Description
`TfResourceType`	`*string`	No description.

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

DataCloudflareZoneConfig

Initializer

import "github.com/cdktf/cdktf-provider-cloudflare-go/cloudflare/v11/datacloudflarezone"

&datacloudflarezone.DataCloudflareZoneConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	AccountId: *string,
	Id: *string,
	Name: *string,
	ZoneId: *string,
}

Properties

Name	Type	Description
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`AccountId`	`*string`	The account identifier to target for the resource.
`Id`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone#id DataCloudflareZone#id}.
`Name`	`*string`	The name of the zone. Must provide only one of `zone_id`, `name`.
`ZoneId`	`*string`	The zone identifier to target for the resource. Must provide only one of `zone_id`, `name`.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

`ForEach`^Optional

ForEach ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

Provider TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`AccountId`^Optional

AccountId *string

Type: *string

The account identifier to target for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone#account_id DataCloudflareZone#account_id}

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone#id DataCloudflareZone#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.

`Name`^Optional

Name *string

Type: *string

The name of the zone. Must provide only one of zone_id, name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone#name DataCloudflareZone#name}

`ZoneId`^Optional

ZoneId *string

Type: *string

The zone identifier to target for the resource. Must provide only one of zone_id, name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/data-sources/zone#zone_id DataCloudflareZone#zone_id}

Files

dataCloudflareZone.go.md

Latest commit

History

dataCloudflareZone.go.md

File metadata and controls

dataCloudflareZone Submodule

Constructs