target

package
v5.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

boundary_target

Refer to the Terraform Registory for docs: boundary_target.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewTarget_Override

func NewTarget_Override(t Target, scope constructs.Construct, id *string, config *TargetConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target boundary_target} Resource.

func Target_IsConstruct

func Target_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 Target_IsTerraformElement

func Target_IsTerraformElement(x interface{}) *bool

Experimental.

func Target_IsTerraformResource

func Target_IsTerraformResource(x interface{}) *bool

Experimental.

func Target_TfResourceType

func Target_TfResourceType() *string

Types

type Target

type Target interface {
	cdktf.TerraformResource
	Address() *string
	SetAddress(val *string)
	AddressInput() *string
	BrokeredCredentialSourceIds() *[]*string
	SetBrokeredCredentialSourceIds(val *[]*string)
	BrokeredCredentialSourceIdsInput() *[]*string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	DefaultClientPort() *float64
	SetDefaultClientPort(val *float64)
	DefaultClientPortInput() *float64
	DefaultPort() *float64
	SetDefaultPort(val *float64)
	DefaultPortInput() *float64
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	EgressWorkerFilter() *string
	SetEgressWorkerFilter(val *string)
	EgressWorkerFilterInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	HostSourceIds() *[]*string
	SetHostSourceIds(val *[]*string)
	HostSourceIdsInput() *[]*string
	Id() *string
	IngressWorkerFilter() *string
	SetIngressWorkerFilter(val *string)
	IngressWorkerFilterInput() *string
	InjectedApplicationCredentialSourceIds() *[]*string
	SetInjectedApplicationCredentialSourceIds(val *[]*string)
	InjectedApplicationCredentialSourceIdsInput() *[]*string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	ScopeId() *string
	SetScopeId(val *string)
	ScopeIdInput() *string
	SessionConnectionLimit() *float64
	SetSessionConnectionLimit(val *float64)
	SessionConnectionLimitInput() *float64
	SessionMaxSeconds() *float64
	SetSessionMaxSeconds(val *float64)
	SessionMaxSecondsInput() *float64
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	WorkerFilter() *string
	SetWorkerFilter(val *string)
	WorkerFilterInput() *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)
	ResetAddress()
	ResetBrokeredCredentialSourceIds()
	ResetDefaultClientPort()
	ResetDefaultPort()
	ResetDescription()
	ResetEgressWorkerFilter()
	ResetHostSourceIds()
	ResetIngressWorkerFilter()
	ResetInjectedApplicationCredentialSourceIds()
	ResetName()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetSessionConnectionLimit()
	ResetSessionMaxSeconds()
	ResetWorkerFilter()
	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://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target boundary_target}.

func NewTarget

func NewTarget(scope constructs.Construct, id *string, config *TargetConfig) Target

Create a new {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target boundary_target} Resource.

type TargetConfig

type TargetConfig 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"`
	// The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#scope_id Target#scope_id}
	ScopeId *string `field:"required" json:"scopeId" yaml:"scopeId"`
	// The target resource type.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#type Target#type}
	Type *string `field:"required" json:"type" yaml:"type"`
	// Optionally, a valid network address to connect to for this target. Cannot be used alongside host_source_ids.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#address Target#address}
	Address *string `field:"optional" json:"address" yaml:"address"`
	// A list of brokered credential source ID's.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#brokered_credential_source_ids Target#brokered_credential_source_ids}
	BrokeredCredentialSourceIds *[]*string `field:"optional" json:"brokeredCredentialSourceIds" yaml:"brokeredCredentialSourceIds"`
	// The default client port for this target.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#default_client_port Target#default_client_port}
	DefaultClientPort *float64 `field:"optional" json:"defaultClientPort" yaml:"defaultClientPort"`
	// The default port for this target.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#default_port Target#default_port}
	DefaultPort *float64 `field:"optional" json:"defaultPort" yaml:"defaultPort"`
	// The target description.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#description Target#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Boolean expression to filter the workers used to access this target.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#egress_worker_filter Target#egress_worker_filter}
	EgressWorkerFilter *string `field:"optional" json:"egressWorkerFilter" yaml:"egressWorkerFilter"`
	// A list of host source ID's. Cannot be used alongside address.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#host_source_ids Target#host_source_ids}
	HostSourceIds *[]*string `field:"optional" json:"hostSourceIds" yaml:"hostSourceIds"`
	// HCP Only.
	//
	// Boolean expression to filter the workers a user will connect to when initiating a session against this target
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#ingress_worker_filter Target#ingress_worker_filter}
	IngressWorkerFilter *string `field:"optional" json:"ingressWorkerFilter" yaml:"ingressWorkerFilter"`
	// A list of injected application credential source ID's.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#injected_application_credential_source_ids Target#injected_application_credential_source_ids}
	InjectedApplicationCredentialSourceIds *[]*string `field:"optional" json:"injectedApplicationCredentialSourceIds" yaml:"injectedApplicationCredentialSourceIds"`
	// The target name. Defaults to the resource name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#name Target#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#session_connection_limit Target#session_connection_limit}.
	SessionConnectionLimit *float64 `field:"optional" json:"sessionConnectionLimit" yaml:"sessionConnectionLimit"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#session_max_seconds Target#session_max_seconds}.
	SessionMaxSeconds *float64 `field:"optional" json:"sessionMaxSeconds" yaml:"sessionMaxSeconds"`
	// Boolean expression to filter the workers for this target.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.8/docs/resources/target#worker_filter Target#worker_filter}
	WorkerFilter *string `field:"optional" json:"workerFilter" yaml:"workerFilter"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL