Skip to content

Latest commit

 

History

History
1487 lines (926 loc) · 64.3 KB

computeNetworkEndpoint.go.md

File metadata and controls

1487 lines (926 loc) · 64.3 KB

computeNetworkEndpoint Submodule

Constructs

ComputeNetworkEndpoint

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint google_compute_network_endpoint}.

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

computenetworkendpoint.NewComputeNetworkEndpoint(scope Construct, id *string, config ComputeNetworkEndpointConfig) ComputeNetworkEndpoint
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config ComputeNetworkEndpointConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutTimeouts No description.
ResetId No description.
ResetInstance No description.
ResetPort No description.
ResetProject No description.
ResetTimeouts No description.
ResetZone No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.


GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


PutTimeouts
func PutTimeouts(value ComputeNetworkEndpointTimeouts)
valueRequired

ResetId
func ResetId()
ResetInstance
func ResetInstance()
ResetPort
func ResetPort()
ResetProject
func ResetProject()
ResetTimeouts
func ResetTimeouts()
ResetZone
func ResetZone()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a ComputeNetworkEndpoint resource upon running "cdktf plan ".

IsConstruct
import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

computenetworkendpoint.ComputeNetworkEndpoint_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.

xRequired
  • Type: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

computenetworkendpoint.ComputeNetworkEndpoint_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

computenetworkendpoint.ComputeNetworkEndpoint_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

computenetworkendpoint.ComputeNetworkEndpoint_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a ComputeNetworkEndpoint resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

The construct id used in the generated config for the ComputeNetworkEndpoint to import.


importFromIdRequired
  • Type: *string

The id of the existing ComputeNetworkEndpoint that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the ComputeNetworkEndpoint to import is found.


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Timeouts ComputeNetworkEndpointTimeoutsOutputReference No description.
IdInput *string No description.
InstanceInput *string No description.
IpAddressInput *string No description.
NetworkEndpointGroupInput *string No description.
PortInput *f64 No description.
ProjectInput *string No description.
TimeoutsInput interface{} No description.
ZoneInput *string No description.
Id *string No description.
Instance *string No description.
IpAddress *string No description.
NetworkEndpointGroup *string No description.
Port *f64 No description.
Project *string No description.
Zone *string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

TimeoutsRequired
func Timeouts() ComputeNetworkEndpointTimeoutsOutputReference

IdInputOptional
func IdInput() *string
  • Type: *string

InstanceInputOptional
func InstanceInput() *string
  • Type: *string

IpAddressInputOptional
func IpAddressInput() *string
  • Type: *string

NetworkEndpointGroupInputOptional
func NetworkEndpointGroupInput() *string
  • Type: *string

PortInputOptional
func PortInput() *f64
  • Type: *f64

ProjectInputOptional
func ProjectInput() *string
  • Type: *string

TimeoutsInputOptional
func TimeoutsInput() interface{}
  • Type: interface{}

ZoneInputOptional
func ZoneInput() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

InstanceRequired
func Instance() *string
  • Type: *string

IpAddressRequired
func IpAddress() *string
  • Type: *string

NetworkEndpointGroupRequired
func NetworkEndpointGroup() *string
  • Type: *string

PortRequired
func Port() *f64
  • Type: *f64

ProjectRequired
func Project() *string
  • Type: *string

ZoneRequired
func Zone() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

ComputeNetworkEndpointConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

&computenetworkendpoint.ComputeNetworkEndpointConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	IpAddress: *string,
	NetworkEndpointGroup: *string,
	Id: *string,
	Instance: *string,
	Port: *f64,
	Project: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.computeNetworkEndpoint.ComputeNetworkEndpointTimeouts,
	Zone: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
IpAddress *string IPv4 address of network endpoint.
NetworkEndpointGroup *string The network endpoint group this endpoint is part of.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#id ComputeNetworkEndpoint#id}.
Instance *string The name for a specific VM instance that the IP address belongs to.
Port *f64 Port number of network endpoint. Note 'port' is required unless the Network Endpoint Group is created with the type of 'GCE_VM_IP'.
Project *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#project ComputeNetworkEndpoint#project}.
Timeouts ComputeNetworkEndpointTimeouts timeouts block.
Zone *string Zone where the containing network endpoint group is located.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

IpAddressRequired
IpAddress *string
  • Type: *string

IPv4 address of network endpoint.

The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#ip_address ComputeNetworkEndpoint#ip_address}


NetworkEndpointGroupRequired
NetworkEndpointGroup *string
  • Type: *string

The network endpoint group this endpoint is part of.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#network_endpoint_group ComputeNetworkEndpoint#network_endpoint_group}


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#id ComputeNetworkEndpoint#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


InstanceOptional
Instance *string
  • Type: *string

The name for a specific VM instance that the IP address belongs to.

This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#instance ComputeNetworkEndpoint#instance}


PortOptional
Port *f64
  • Type: *f64

Port number of network endpoint. Note 'port' is required unless the Network Endpoint Group is created with the type of 'GCE_VM_IP'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#port ComputeNetworkEndpoint#port}


ProjectOptional
Project *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#project ComputeNetworkEndpoint#project}.


TimeoutsOptional
Timeouts ComputeNetworkEndpointTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#timeouts ComputeNetworkEndpoint#timeouts}


ZoneOptional
Zone *string
  • Type: *string

Zone where the containing network endpoint group is located.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#zone ComputeNetworkEndpoint#zone}


ComputeNetworkEndpointTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

&computenetworkendpoint.ComputeNetworkEndpointTimeouts {
	Create: *string,
	Delete: *string,
}

Properties

Name Type Description
Create *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#create ComputeNetworkEndpoint#create}.
Delete *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#delete ComputeNetworkEndpoint#delete}.

CreateOptional
Create *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#create ComputeNetworkEndpoint#create}.


DeleteOptional
Delete *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_network_endpoint#delete ComputeNetworkEndpoint#delete}.


Classes

ComputeNetworkEndpointTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/computenetworkendpoint"

computenetworkendpoint.NewComputeNetworkEndpointTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) ComputeNetworkEndpointTimeoutsOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetCreate No description.
ResetDelete No description.

ComputeFqn
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate
func ResetCreate()
ResetDelete
func ResetDelete()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
CreateInput *string No description.
DeleteInput *string No description.
Create *string No description.
Delete *string No description.
InternalValue interface{} No description.

CreationStackRequired
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
func Fqn() *string
  • Type: *string

CreateInputOptional
func CreateInput() *string
  • Type: *string

DeleteInputOptional
func DeleteInput() *string
  • Type: *string

CreateRequired
func Create() *string
  • Type: *string

DeleteRequired
func Delete() *string
  • Type: *string

InternalValueOptional
func InternalValue() interface{}
  • Type: interface{}