provider

README

provider

Refer to the Terraform Registory for docs: tfe.

Documentation

Index

• func NewTfeProvider_Override(t TfeProvider, scope constructs.Construct, id *string, ...)
• func TfeProvider_IsConstruct(x interface{}) *bool
• func TfeProvider_IsTerraformElement(x interface{}) *bool
• func TfeProvider_IsTerraformProvider(x interface{}) *bool
• func TfeProvider_TfResourceType() *string
• type TfeProvider
  • func NewTfeProvider(scope constructs.Construct, id *string, config *TfeProviderConfig) TfeProvider
• type TfeProviderConfig

Functions

func NewTfeProvider_Override

func NewTfeProvider_Override(t TfeProvider, scope constructs.Construct, id *string, config *TfeProviderConfig)

Create a new {@link https://www.terraform.io/docs/providers/tfe tfe} Resource.

func TfeProvider_IsConstruct

func TfeProvider_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 TfeProvider_IsTerraformElement

func TfeProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func TfeProvider_IsTerraformProvider

func TfeProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func TfeProvider_TfResourceType

func TfeProvider_TfResourceType() *string

Types

type TfeProvider

type TfeProvider 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
	Hostname() *string
	SetHostname(val *string)
	HostnameInput() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	Organization() *string
	SetOrganization(val *string)
	OrganizationInput() *string
	// Experimental.
	RawOverrides() interface{}
	SslSkipVerify() interface{}
	SetSslSkipVerify(val interface{})
	SslSkipVerifyInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Token() *string
	SetToken(val *string)
	TokenInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetHostname()
	ResetOrganization()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetSslSkipVerify()
	ResetToken()
	SynthesizeAttributes() *map[string]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://www.terraform.io/docs/providers/tfe tfe}.

func NewTfeProvider

func NewTfeProvider(scope constructs.Construct, id *string, config *TfeProviderConfig) TfeProvider

Create a new {@link https://www.terraform.io/docs/providers/tfe tfe} Resource.

type TfeProviderConfig

type TfeProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/tfe#alias TfeProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// The Terraform Enterprise hostname to connect to. Defaults to app.terraform.io.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/tfe#hostname TfeProvider#hostname}
	Hostname *string `field:"optional" json:"hostname" yaml:"hostname"`
	// The organization to apply to a resource if one is not defined on the resource itself.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/tfe#organization TfeProvider#organization}
	Organization *string `field:"optional" json:"organization" yaml:"organization"`
	// Whether or not to skip certificate verifications.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/tfe#ssl_skip_verify TfeProvider#ssl_skip_verify}
	SslSkipVerify interface{} `field:"optional" json:"sslSkipVerify" yaml:"sslSkipVerify"`
	// The token used to authenticate with Terraform Enterprise.
	//
	// We recommend omitting
	// the token which can be set as credentials in the CLI config file.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/tfe#token TfeProvider#token}
	Token *string `field:"optional" json:"token" yaml:"token"`
}