dataexternal

README

data_external

Refer to the Terraform Registry for docs: data_external.

Documentation

Index

• func DataExternal_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DataExternal_IsConstruct(x interface{}) *bool
• func DataExternal_IsTerraformDataSource(x interface{}) *bool
• func DataExternal_IsTerraformElement(x interface{}) *bool
• func DataExternal_TfResourceType() *string
• func NewDataExternal_Override(d DataExternal, scope constructs.Construct, id *string, ...)
• type DataExternal
  • func NewDataExternal(scope constructs.Construct, id *string, config *DataExternalConfig) DataExternal
• type DataExternalConfig

Functions

func DataExternal_GenerateConfigForImport

func DataExternal_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DataExternal resource upon running "cdktf plan <stack-name>".

func DataExternal_IsConstruct

func DataExternal_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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataExternal_IsTerraformDataSource

func DataExternal_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataExternal_IsTerraformElement

func DataExternal_IsTerraformElement(x interface{}) *bool

Experimental.

func DataExternal_TfResourceType

func DataExternal_TfResourceType() *string

func NewDataExternal_Override

func NewDataExternal_Override(d DataExternal, scope constructs.Construct, id *string, config *DataExternalConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs/data-sources/external external} Data Source.

Types

type DataExternal

type DataExternal interface {
	cdktf.TerraformDataSource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	// The tree node.
	Node() constructs.Node
	Program() *[]*string
	SetProgram(val *[]*string)
	ProgramInput() *[]*string
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	Query() *map[string]*string
	SetQuery(val *map[string]*string)
	QueryInput() *map[string]*string
	// Experimental.
	RawOverrides() interface{}
	Result() cdktf.StringMap
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	WorkingDir() *string
	SetWorkingDir(val *string)
	WorkingDirInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetQuery()
	ResetWorkingDir()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs/data-sources/external external}.

func NewDataExternal

func NewDataExternal(scope constructs.Construct, id *string, config *DataExternalConfig) DataExternal

Create a new {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs/data-sources/external external} Data Source.

type DataExternalConfig

type DataExternalConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// A list of strings, whose first element is the program to run and whose subsequent elements are optional command line arguments to the program.
	//
	// Terraform does not execute the program through a shell, so it is not necessary to escape shell metacharacters nor add quotes around arguments containing spaces.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs/data-sources/external#program DataExternal#program}
	Program *[]*string `field:"required" json:"program" yaml:"program"`
	// A map of string values to pass to the external program as the query arguments.
	//
	// If not supplied, the program will receive an empty object as its input.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs/data-sources/external#query DataExternal#query}
	Query *map[string]*string `field:"optional" json:"query" yaml:"query"`
	// Working directory of the program. If not supplied, the program will run in the current directory.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs/data-sources/external#working_dir DataExternal#working_dir}
	WorkingDir *string `field:"optional" json:"workingDir" yaml:"workingDir"`
}