apigeeEndpointAttachment.go.md

apigeeEndpointAttachment Submodule

Constructs

ApigeeEndpointAttachment

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment google_apigee_endpoint_attachment}.

Initializers

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

apigeeendpointattachment.NewApigeeEndpointAttachment(scope Construct, id *string, config ApigeeEndpointAttachmentConfig) ApigeeEndpointAttachment

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	ApigeeEndpointAttachmentConfig	No description.

---

scope^Required

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

The scope in which to define this construct.

---

id^Required

• Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ApigeeEndpointAttachmentConfig

---

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.
ResetTimeouts	No description.

---

ToString

func ToString() *string

Returns a string representation of this construct.

AddOverride

func AddOverride(path *string, value interface{})

path^Required

• Type: *string

---

value^Required

• Type: interface{}

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

newLogicalId^Required

• 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.

moveTarget^Required

• Type: *string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

HasResourceMove

func HasResourceMove() interface{}

ImportFrom

func ImportFrom(id *string, provider TerraformProvider)

id^Required

• Type: *string

---

provider^Optional

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

---

InterpolationForAttribute

func InterpolationForAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• 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.

id^Required

• 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.

moveTarget^Required

• Type: *string

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

---

index^Optional

• 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".

id^Required

• Type: *string

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

---

PutTimeouts

func PutTimeouts(value ApigeeEndpointAttachmentTimeouts)

value^Required

• Type: ApigeeEndpointAttachmentTimeouts

---

ResetId

func ResetId()

ResetTimeouts

func ResetTimeouts()

Static Functions

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

---

IsConstruct

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

apigeeendpointattachment.ApigeeEndpointAttachment_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.

x^Required

• Type: interface{}

Any object.

---

IsTerraformElement

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

apigeeendpointattachment.ApigeeEndpointAttachment_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

---

IsTerraformResource

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

apigeeendpointattachment.ApigeeEndpointAttachment_IsTerraformResource(x interface{}) *bool

x^Required

• Type: interface{}

---

GenerateConfigForImport

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

apigeeendpointattachment.ApigeeEndpointAttachment_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scope^Required

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

The scope in which to define this construct.

---

importToId^Required

• Type: *string

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

---

importFromId^Required

• Type: *string

The id of the existing ApigeeEndpointAttachment that should be imported.

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

---

provider^Optional

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

? Optional instance of the provider where the ApigeeEndpointAttachment 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.
ConnectionState	*string	No description.
Host	*string	No description.
Name	*string	No description.
Timeouts	ApigeeEndpointAttachmentTimeoutsOutputReference	No description.
EndpointAttachmentIdInput	*string	No description.
IdInput	*string	No description.
LocationInput	*string	No description.
OrgIdInput	*string	No description.
ServiceAttachmentInput	*string	No description.
TimeoutsInput	interface{}	No description.
EndpointAttachmentId	*string	No description.
Id	*string	No description.
Location	*string	No description.
OrgId	*string	No description.
ServiceAttachment	*string	No description.

---

Node^Required

func Node() Node

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

The tree node.

---

CdktfStack^Required

func CdktfStack() TerraformStack

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

---

Fqn^Required

func Fqn() *string

• Type: *string

---

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

---

TerraformMetaArguments^Required

func TerraformMetaArguments() *map[string]interface{}

• Type: *map[string]interface{}

---

TerraformResourceType^Required

func TerraformResourceType() *string

• Type: *string

---

TerraformGeneratorMetadata^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

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

---

Connection^Optional

func Connection() interface{}

• Type: interface{}

---

Count^Optional

func Count() interface{}

• Type: interface{}

---

DependsOn^Optional

func DependsOn() *[]*string

• Type: *[]*string

---

ForEach^Optional

func ForEach() ITerraformIterator

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

---

Lifecycle^Optional

func Lifecycle() TerraformResourceLifecycle

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

---

Provider^Optional

func Provider() TerraformProvider

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

---

Provisioners^Optional

func Provisioners() *[]interface{}

• Type: *[]interface{}

---

ConnectionState^Required

func ConnectionState() *string

• Type: *string

---

Host^Required

func Host() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

Timeouts^Required

func Timeouts() ApigeeEndpointAttachmentTimeoutsOutputReference

• Type: ApigeeEndpointAttachmentTimeoutsOutputReference

---

EndpointAttachmentIdInput^Optional

func EndpointAttachmentIdInput() *string

• Type: *string

---

IdInput^Optional

func IdInput() *string

• Type: *string

---

LocationInput^Optional

func LocationInput() *string

• Type: *string

---

OrgIdInput^Optional

func OrgIdInput() *string

• Type: *string

---

ServiceAttachmentInput^Optional

func ServiceAttachmentInput() *string

• Type: *string

---

TimeoutsInput^Optional

func TimeoutsInput() interface{}

• Type: interface{}

---

EndpointAttachmentId^Required

func EndpointAttachmentId() *string

• Type: *string

---

Id^Required

func Id() *string

• Type: *string

---

Location^Required

func Location() *string

• Type: *string

---

OrgId^Required

func OrgId() *string

• Type: *string

---

ServiceAttachment^Required

func ServiceAttachment() *string

• Type: *string

---

Constants

Name	Type	Description
TfResourceType	*string	No description.

---

TfResourceType^Required

func TfResourceType() *string

• Type: *string

---

Structs

ApigeeEndpointAttachmentConfig

Initializer

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

&apigeeendpointattachment.ApigeeEndpointAttachmentConfig {
	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{},
	EndpointAttachmentId: *string,
	Location: *string,
	OrgId: *string,
	ServiceAttachment: *string,
	Id: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.apigeeEndpointAttachment.ApigeeEndpointAttachmentTimeouts,
}

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.
EndpointAttachmentId	*string	ID of the endpoint attachment.
Location	*string	Location of the endpoint attachment.
OrgId	*string	The Apigee Organization associated with the Apigee instance, in the format 'organizations/{{org_name}}'.
ServiceAttachment	*string	Format: projects/* /regions/* /serviceAttachments/*.
Id	*string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#id ApigeeEndpointAttachment#id}.
Timeouts	ApigeeEndpointAttachmentTimeouts	timeouts block.

---

Connection^Optional

Connection interface{}

• Type: interface{}

---

Count^Optional

Count interface{}

• Type: interface{}

---

DependsOn^Optional

DependsOn *[]ITerraformDependable

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

---

ForEach^Optional

ForEach ITerraformIterator

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

---

Lifecycle^Optional

Lifecycle TerraformResourceLifecycle

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

---

Provider^Optional

Provider TerraformProvider

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

---

Provisioners^Optional

Provisioners *[]interface{}

• Type: *[]interface{}

---

EndpointAttachmentId^Required

EndpointAttachmentId *string

• Type: *string

ID of the endpoint attachment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#endpoint_attachment_id ApigeeEndpointAttachment#endpoint_attachment_id}

---

Location^Required

Location *string

• Type: *string

Location of the endpoint attachment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#location ApigeeEndpointAttachment#location}

---

OrgId^Required

OrgId *string

• Type: *string

The Apigee Organization associated with the Apigee instance, in the format 'organizations/{{org_name}}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#org_id ApigeeEndpointAttachment#org_id}

---

ServiceAttachment^Required

ServiceAttachment *string

• Type: *string

Format: projects/* /regions/* /serviceAttachments/*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#service_attachment ApigeeEndpointAttachment#service_attachment}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

---

Id^Optional

Id *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#id ApigeeEndpointAttachment#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.

---

Timeouts^Optional

Timeouts ApigeeEndpointAttachmentTimeouts

• Type: ApigeeEndpointAttachmentTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#timeouts ApigeeEndpointAttachment#timeouts}

---

ApigeeEndpointAttachmentTimeouts

Initializer

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

&apigeeendpointattachment.ApigeeEndpointAttachmentTimeouts {
	Create: *string,
	Delete: *string,
}

Properties

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

---

Create^Optional

Create *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#create ApigeeEndpointAttachment#create}.

---

Delete^Optional

Delete *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_endpoint_attachment#delete ApigeeEndpointAttachment#delete}.

---

Classes

ApigeeEndpointAttachmentTimeoutsOutputReference

Initializers

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

apigeeendpointattachment.NewApigeeEndpointAttachmentTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) ApigeeEndpointAttachmentTimeoutsOutputReference

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.

---

terraformResource^Required

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

The parent resource.

---

terraformAttribute^Required

• 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{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• 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.

---

CreationStack^Required

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.

---

Fqn^Required

func Fqn() *string

• Type: *string

---

CreateInput^Optional

func CreateInput() *string

• Type: *string

---

DeleteInput^Optional

func DeleteInput() *string

• Type: *string

---

Create^Required

func Create() *string

• Type: *string

---

Delete^Required

func Delete() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---