1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. apigee
  6. apigee/v1
  7. EndpointAttachment

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates an endpoint attachment. Note: Not supported for Apigee hybrid. Auto-naming is currently not supported for this resource.

    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,
                           organization_id: Optional[str] = None,
                           endpoint_attachment_id: Optional[str] = None,
                           location: Optional[str] = None,
                           name: 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: google-native:apigee/v1:EndpointAttachment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_apigee_v1_endpoint_attachment" "name" {
        # resource properties
    }

    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 GoogleNative.Apigee.V1.EndpointAttachment("endpointAttachmentResource", new()
    {
        OrganizationId = "string",
        EndpointAttachmentId = "string",
        Location = "string",
        Name = "string",
        ServiceAttachment = "string",
    });
    
    example, err := apigee.NewEndpointAttachment(ctx, "endpointAttachmentResource", &apigee.EndpointAttachmentArgs{
    	OrganizationId:       pulumi.String("string"),
    	EndpointAttachmentId: pulumi.String("string"),
    	Location:             pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	ServiceAttachment:    pulumi.String("string"),
    })
    
    resource "google-native_apigee_v1_endpoint_attachment" "endpointAttachmentResource" {
      lifecycle {
        create_before_destroy = true
      }
      organization_id        = "string"
      endpoint_attachment_id = "string"
      location               = "string"
      name                   = "string"
      service_attachment     = "string"
    }
    
    var endpointAttachmentResource = new com.pulumi.googlenative.apigee_v1.EndpointAttachment("endpointAttachmentResource", com.pulumi.googlenative.apigee_v1.EndpointAttachmentArgs.builder()
        .organizationId("string")
        .endpointAttachmentId("string")
        .location("string")
        .name("string")
        .serviceAttachment("string")
        .build());
    
    endpoint_attachment_resource = google_native.apigee.v1.EndpointAttachment("endpointAttachmentResource",
        organization_id="string",
        endpoint_attachment_id="string",
        location="string",
        name="string",
        service_attachment="string")
    
    const endpointAttachmentResource = new google_native.apigee.v1.EndpointAttachment("endpointAttachmentResource", {
        organizationId: "string",
        endpointAttachmentId: "string",
        location: "string",
        name: "string",
        serviceAttachment: "string",
    });
    
    type: google-native:apigee/v1:EndpointAttachment
    properties:
        endpointAttachmentId: string
        location: string
        name: string
        organizationId: 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:

    OrganizationId string
    EndpointAttachmentId string
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    Location string
    Location of the endpoint attachment.
    Name string
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    ServiceAttachment string
    Format: projects//regions//serviceAttachments/*
    OrganizationId string
    EndpointAttachmentId string
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    Location string
    Location of the endpoint attachment.
    Name string
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    ServiceAttachment string
    Format: projects//regions//serviceAttachments/*
    organization_id string
    endpoint_attachment_id string
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    location string
    Location of the endpoint attachment.
    name string
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    service_attachment string
    Format: projects//regions//serviceAttachments/*
    organizationId String
    endpointAttachmentId String
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    location String
    Location of the endpoint attachment.
    name String
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    serviceAttachment String
    Format: projects//regions//serviceAttachments/*
    organizationId string
    endpointAttachmentId string
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    location string
    Location of the endpoint attachment.
    name string
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    serviceAttachment string
    Format: projects//regions//serviceAttachments/*
    organization_id str
    endpoint_attachment_id str
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    location str
    Location of the endpoint attachment.
    name str
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    service_attachment str
    Format: projects//regions//serviceAttachments/*
    organizationId String
    endpointAttachmentId String
    ID to use for the endpoint attachment. ID must start with a lowercase letter followed by up to 31 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. The minimum length is 2.
    location String
    Location of the endpoint attachment.
    name String
    Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
    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 the HTTP target endpoint directly or as the host in target server.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.
    ConnectionState string
    State of the endpoint attachment connection to the service attachment.
    Host string
    Host that can be used in either the HTTP target endpoint directly or as the host in target server.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.
    connection_state string
    State of the endpoint attachment connection to the service attachment.
    host string
    Host that can be used in either the HTTP target endpoint directly or as the host in target server.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.
    connectionState String
    State of the endpoint attachment connection to the service attachment.
    host String
    Host that can be used in either the HTTP target endpoint directly or as the host in target server.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.
    connectionState string
    State of the endpoint attachment connection to the service attachment.
    host string
    Host that can be used in either the HTTP target endpoint directly or as the host in target server.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.
    connection_state str
    State of the endpoint attachment connection to the service attachment.
    host str
    Host that can be used in either the HTTP target endpoint directly or as the host in target server.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.
    connectionState String
    State of the endpoint attachment connection to the service attachment.
    host String
    Host that can be used in either the HTTP target endpoint directly or as the host in target server.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.

    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>, opts?: CustomResourceOptions): EndpointAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = 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, CustomResourceOptions? opts = null)
    public static EndpointAttachment get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingEndpointAttachment:    type: google-native:apigee/v1:EndpointAttachment    get:      id: ${id}
    import {
      to = google-native_apigee_v1_endpoint_attachment.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state EndpointAttachmentState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo Google Cloud Native

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial