Google Cloud v8.30.0, May 12 25

Google Cloud v8.30.0 published on Monday, May 12, 2025 by Pulumi

gcp.apigee.EndpointAttachment

Explore with Pulumi AI

Google Cloud v8.30.0 published on Monday, May 12, 2025 by Pulumi

Create EndpointAttachment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EndpointAttachment(name: string, args: EndpointAttachmentArgs, opts?: CustomResourceOptions);

@overload
def EndpointAttachment(resource_name: str,
                       args: EndpointAttachmentArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def EndpointAttachment(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       endpoint_attachment_id: Optional[str] = None,
                       location: Optional[str] = None,
                       org_id: Optional[str] = None,
                       service_attachment: Optional[str] = None)

func NewEndpointAttachment(ctx *Context, name string, args EndpointAttachmentArgs, opts ...ResourceOption) (*EndpointAttachment, error)

public EndpointAttachment(string name, EndpointAttachmentArgs args, CustomResourceOptions? opts = null)

public EndpointAttachment(String name, EndpointAttachmentArgs args)
public EndpointAttachment(String name, EndpointAttachmentArgs args, CustomResourceOptions options)

type: gcp:apigee:EndpointAttachment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args EndpointAttachmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args EndpointAttachmentArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointAttachmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointAttachmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointAttachmentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var endpointAttachmentResource = new Gcp.Apigee.EndpointAttachment("endpointAttachmentResource", new()
{
    EndpointAttachmentId = "string",
    Location = "string",
    OrgId = "string",
    ServiceAttachment = "string",
});

example, err := apigee.NewEndpointAttachment(ctx, "endpointAttachmentResource", &apigee.EndpointAttachmentArgs{
	EndpointAttachmentId: pulumi.String("string"),
	Location:             pulumi.String("string"),
	OrgId:                pulumi.String("string"),
	ServiceAttachment:    pulumi.String("string"),
})

var endpointAttachmentResource = new com.pulumi.gcp.apigee.EndpointAttachment("endpointAttachmentResource", com.pulumi.gcp.apigee.EndpointAttachmentArgs.builder()
    .endpointAttachmentId("string")
    .location("string")
    .orgId("string")
    .serviceAttachment("string")
    .build());

endpoint_attachment_resource = gcp.apigee.EndpointAttachment("endpointAttachmentResource",
    endpoint_attachment_id="string",
    location="string",
    org_id="string",
    service_attachment="string")

const endpointAttachmentResource = new gcp.apigee.EndpointAttachment("endpointAttachmentResource", {
    endpointAttachmentId: "string",
    location: "string",
    orgId: "string",
    serviceAttachment: "string",
});

type: gcp:apigee:EndpointAttachment
properties:
    endpointAttachmentId: string
    location: string
    orgId: string
    serviceAttachment: string

EndpointAttachment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EndpointAttachment resource accepts the following input properties:

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/*

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/*

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/*

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/*

endpoint_attachment_id str: ID of the endpoint attachment.
location str: Location of the endpoint attachment.
org_id str: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
service_attachment str: Format: projects//regions//serviceAttachments/*

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/*

Outputs

All input properties are implicitly available as output properties. Additionally, the EndpointAttachment resource produces the following output properties:

ConnectionState string: State of the endpoint attachment connection to the service attachment.
Host string: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.

ConnectionState string: State of the endpoint attachment connection to the service attachment.
Host string: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.

connectionState String: State of the endpoint attachment connection to the service attachment.
host String: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.

connectionState string: State of the endpoint attachment connection to the service attachment.
host string: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
id string: The provider-assigned unique ID for this managed resource.
name string: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.

connection_state str: State of the endpoint attachment connection to the service attachment.
host str: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
id str: The provider-assigned unique ID for this managed resource.
name str: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.

connectionState String: State of the endpoint attachment connection to the service attachment.
host String: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.

Look up Existing EndpointAttachment Resource

Get an existing EndpointAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EndpointAttachmentState, opts?: CustomResourceOptions): EndpointAttachment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_state: Optional[str] = None,
        endpoint_attachment_id: Optional[str] = None,
        host: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        service_attachment: Optional[str] = None) -> EndpointAttachment

func GetEndpointAttachment(ctx *Context, name string, id IDInput, state *EndpointAttachmentState, opts ...ResourceOption) (*EndpointAttachment, error)

public static EndpointAttachment Get(string name, Input<string> id, EndpointAttachmentState? state, CustomResourceOptions? opts = null)

public static EndpointAttachment get(String name, Output<String> id, EndpointAttachmentState state, CustomResourceOptions options)

resources:  _:    type: gcp:apigee:EndpointAttachment    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ConnectionState string: State of the endpoint attachment connection to the service attachment.
EndpointAttachmentId string: ID of the endpoint attachment.
Host string: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
Location string: Location of the endpoint attachment.
Name string: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.
OrgId string: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
ServiceAttachment string: Format: projects//regions//serviceAttachments/*

ConnectionState string: State of the endpoint attachment connection to the service attachment.
EndpointAttachmentId string: ID of the endpoint attachment.
Host string: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
Location string: Location of the endpoint attachment.
Name string: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.
OrgId string: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
ServiceAttachment string: Format: projects//regions//serviceAttachments/*

connectionState String: State of the endpoint attachment connection to the service attachment.
endpointAttachmentId String: ID of the endpoint attachment.
host String: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
location String: Location of the endpoint attachment.
name String: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.
orgId String: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
serviceAttachment String: Format: projects//regions//serviceAttachments/*

connectionState string: State of the endpoint attachment connection to the service attachment.
endpointAttachmentId string: ID of the endpoint attachment.
host string: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
location string: Location of the endpoint attachment.
name string: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.
orgId string: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
serviceAttachment string: Format: projects//regions//serviceAttachments/*

connection_state str: State of the endpoint attachment connection to the service attachment.
endpoint_attachment_id str: ID of the endpoint attachment.
host str: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
location str: Location of the endpoint attachment.
name str: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.
org_id str: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
service_attachment str: Format: projects//regions//serviceAttachments/*

connectionState String: State of the endpoint attachment connection to the service attachment.
endpointAttachmentId String: ID of the endpoint attachment.
host String: Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
location String: Location of the endpoint attachment.
name String: Name of the Endpoint Attachment in the following format: organizations/{organization}/endpointAttachments/{endpointAttachment}.
orgId String: The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.
serviceAttachment String: Format: projects//regions//serviceAttachments/*

Import

EndpointAttachment can be imported using any of these accepted formats:

{{org_id}}/endpointAttachments/{{endpoint_attachment_id}}
{{org_id}}/{{endpoint_attachment_id}}

When using the pulumi import command, EndpointAttachment can be imported using one of the formats above. For example:

$ pulumi import gcp:apigee/endpointAttachment:EndpointAttachment default {{org_id}}/endpointAttachments/{{endpoint_attachment_id}}

$ pulumi import gcp:apigee/endpointAttachment:EndpointAttachment default {{org_id}}/{{endpoint_attachment_id}}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.30.0 published on Monday, May 12, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.apigee.EndpointAttachment

On this page

On this page

Create EndpointAttachment Resource

Constructor syntax

Parameters

Constructor example

EndpointAttachment Resource Properties

Inputs

Outputs

Look up Existing EndpointAttachment Resource

Import

Package Details

On this page

On this page