gcp.apigee.EndpointAttachment
Explore with Pulumi AI
Apigee Endpoint Attachment.
To get more information about EndpointAttachment, see:
- API documentation
- How-to Guides
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 EndpointAttachment("endpointAttachmentResource", 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:
- Endpoint
Attachment stringId - ID of the endpoint attachment.
- Location string
- Location of the endpoint attachment.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - Service
Attachment string - Format: projects//regions//serviceAttachments/*
- Endpoint
Attachment stringId - ID of the endpoint attachment.
- Location string
- Location of the endpoint attachment.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - Service
Attachment string - Format: projects//regions//serviceAttachments/*
- endpoint
Attachment StringId - ID of the endpoint attachment.
- location String
- Location of the endpoint attachment.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - service
Attachment String - Format: projects//regions//serviceAttachments/*
- endpoint
Attachment stringId - ID of the endpoint attachment.
- location string
- Location of the endpoint attachment.
- org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - service
Attachment string - Format: projects//regions//serviceAttachments/*
- endpoint_
attachment_ strid - 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/*
- endpoint
Attachment StringId - ID of the endpoint attachment.
- location String
- Location of the endpoint attachment.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - service
Attachment String - Format: projects//regions//serviceAttachments/*
Outputs
All input properties are implicitly available as output properties. Additionally, the EndpointAttachment resource produces the following output properties:
- Connection
State 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 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 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 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}.
- connection
State 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.
- Connection
State string - State of the endpoint attachment connection to the service attachment.
- Endpoint
Attachment stringId - 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}.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - Service
Attachment string - Format: projects//regions//serviceAttachments/*
- Connection
State string - State of the endpoint attachment connection to the service attachment.
- Endpoint
Attachment stringId - 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}.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - Service
Attachment string - Format: projects//regions//serviceAttachments/*
- connection
State String - State of the endpoint attachment connection to the service attachment.
- endpoint
Attachment StringId - 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}.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - service
Attachment String - Format: projects//regions//serviceAttachments/*
- connection
State string - State of the endpoint attachment connection to the service attachment.
- endpoint
Attachment stringId - 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}.
- org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - service
Attachment string - Format: projects//regions//serviceAttachments/*
- connection_
state str - State of the endpoint attachment connection to the service attachment.
- endpoint_
attachment_ strid - 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/*
- connection
State String - State of the endpoint attachment connection to the service attachment.
- endpoint
Attachment StringId - 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}.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}
. - service
Attachment 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.