provider

README

provider

Refer to the Terraform Registry for docs: external.

Documentation

Index

• func ExternalProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func ExternalProvider_IsConstruct(x interface{}) *bool
• func ExternalProvider_IsTerraformElement(x interface{}) *bool
• func ExternalProvider_IsTerraformProvider(x interface{}) *bool
• func ExternalProvider_TfResourceType() *string
• func NewExternalProvider_Override(e ExternalProvider, scope constructs.Construct, id *string, ...)
• type ExternalProvider
  • func NewExternalProvider(scope constructs.Construct, id *string, config *ExternalProviderConfig) ExternalProvider
• type ExternalProviderConfig

Functions

func ExternalProvider_GenerateConfigForImport

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

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

func ExternalProvider_IsConstruct

func ExternalProvider_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 ExternalProvider_IsTerraformElement

func ExternalProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func ExternalProvider_IsTerraformProvider

func ExternalProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func ExternalProvider_TfResourceType

func ExternalProvider_TfResourceType() *string

func NewExternalProvider_Override

func NewExternalProvider_Override(e ExternalProvider, scope constructs.Construct, id *string, config *ExternalProviderConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs external} Resource.

Types

type ExternalProvider

type ExternalProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// 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 external}.

func NewExternalProvider

func NewExternalProvider(scope constructs.Construct, id *string, config *ExternalProviderConfig) ExternalProvider

Create a new {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs external} Resource.

type ExternalProviderConfig

type ExternalProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/external/2.3.4/docs#alias ExternalProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
}