provider

README

provider

Refer to the Terraform Registry for docs: hcp.

Documentation

Index

• func HcpProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func HcpProvider_IsConstruct(x interface{}) *bool
• func HcpProvider_IsTerraformElement(x interface{}) *bool
• func HcpProvider_IsTerraformProvider(x interface{}) *bool
• func HcpProvider_TfResourceType() *string
• func NewHcpProvider_Override(h HcpProvider, scope constructs.Construct, id *string, ...)
• type HcpProvider
  • func NewHcpProvider(scope constructs.Construct, id *string, config *HcpProviderConfig) HcpProvider
• type HcpProviderConfig
• type HcpProviderWorkloadIdentity

Functions

func HcpProvider_GenerateConfigForImport

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

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

func HcpProvider_IsConstruct

func HcpProvider_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 HcpProvider_IsTerraformElement

func HcpProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func HcpProvider_IsTerraformProvider

func HcpProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func HcpProvider_TfResourceType

func HcpProvider_TfResourceType() *string

func NewHcpProvider_Override

func NewHcpProvider_Override(h HcpProvider, scope constructs.Construct, id *string, config *HcpProviderConfig)

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

Types

type HcpProvider

type HcpProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	ClientId() *string
	SetClientId(val *string)
	ClientIdInput() *string
	ClientSecret() *string
	SetClientSecret(val *string)
	ClientSecretInput() *string
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	CredentialFile() *string
	SetCredentialFile(val *string)
	CredentialFileInput() *string
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	ProjectId() *string
	SetProjectId(val *string)
	ProjectIdInput() *string
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	WorkloadIdentity() interface{}
	SetWorkloadIdentity(val interface{})
	WorkloadIdentityInput() interface{}
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetClientId()
	ResetClientSecret()
	ResetCredentialFile()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetProjectId()
	ResetWorkloadIdentity()
	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/hcp/0.91.1/docs hcp}.

func NewHcpProvider

func NewHcpProvider(scope constructs.Construct, id *string, config *HcpProviderConfig) HcpProvider

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

type HcpProviderConfig

type HcpProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#alias HcpProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// The OAuth2 Client ID for API operations.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#client_id HcpProvider#client_id}
	ClientId *string `field:"optional" json:"clientId" yaml:"clientId"`
	// The OAuth2 Client Secret for API operations.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#client_secret HcpProvider#client_secret}
	ClientSecret *string `field:"optional" json:"clientSecret" yaml:"clientSecret"`
	// The path to an HCP credential file to use to authenticate the provider to HCP.
	//
	// You can alternatively set the HCP_CRED_FILE environment variable to point at a credential file as well. Using a credential file allows you to authenticate the provider as a service principal via client credentials or dynamically based on Workload Identity Federation.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#credential_file HcpProvider#credential_file}
	CredentialFile *string `field:"optional" json:"credentialFile" yaml:"credentialFile"`
	// The default project in which resources should be created.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#project_id HcpProvider#project_id}
	ProjectId *string `field:"optional" json:"projectId" yaml:"projectId"`
	// workload_identity block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#workload_identity HcpProvider#workload_identity}
	WorkloadIdentity interface{} `field:"optional" json:"workloadIdentity" yaml:"workloadIdentity"`
}

type HcpProviderWorkloadIdentity

type HcpProviderWorkloadIdentity struct {
	// The resource_name of the Workload Identity Provider to exchange the token with.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#resource_name HcpProvider#resource_name}
	ResourceName *string `field:"required" json:"resourceName" yaml:"resourceName"`
	// The path to a file containing a JWT token retrieved from an OpenID Connect (OIDC) or OAuth2 provider.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.91.1/docs#token_file HcpProvider#token_file}
	TokenFile *string `field:"required" json:"tokenFile" yaml:"tokenFile"`
}