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

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigee/v1.getInstance

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.

    Using getInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(instance_id: Optional[str] = None,
                 organization_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 organization_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

    > Note: This function is named LookupInstance in the Go SDK.

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:apigee/v1:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getInstance Result

    The following output properties are available:

    ConsumerAcceptList List<string>
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    CreatedAt string
    Time the instance was created in milliseconds since epoch.
    Description string
    Optional. Description of the instance.
    DiskEncryptionKeyName string
    Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)
    DisplayName string
    Optional. Display name for the instance.
    Host string
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    IpRange string
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28
    LastModifiedAt string
    Time the instance was last modified in milliseconds since epoch.
    Location string
    Compute Engine location where the instance resides.
    Name string
    Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.
    PeeringCidrRange string
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.
    Port string
    Port number of the exposed Apigee endpoint.
    RuntimeVersion string
    Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    ServiceAttachment string
    Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    State string
    State of the instance. Values other than ACTIVE means the resource is not ready to use.
    ConsumerAcceptList []string
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    CreatedAt string
    Time the instance was created in milliseconds since epoch.
    Description string
    Optional. Description of the instance.
    DiskEncryptionKeyName string
    Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)
    DisplayName string
    Optional. Display name for the instance.
    Host string
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    IpRange string
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28
    LastModifiedAt string
    Time the instance was last modified in milliseconds since epoch.
    Location string
    Compute Engine location where the instance resides.
    Name string
    Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.
    PeeringCidrRange string
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.
    Port string
    Port number of the exposed Apigee endpoint.
    RuntimeVersion string
    Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    ServiceAttachment string
    Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    State string
    State of the instance. Values other than ACTIVE means the resource is not ready to use.
    consumerAcceptList List<String>
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    createdAt String
    Time the instance was created in milliseconds since epoch.
    description String
    Optional. Description of the instance.
    diskEncryptionKeyName String
    Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)
    displayName String
    Optional. Display name for the instance.
    host String
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    ipRange String
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28
    lastModifiedAt String
    Time the instance was last modified in milliseconds since epoch.
    location String
    Compute Engine location where the instance resides.
    name String
    Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.
    peeringCidrRange String
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.
    port String
    Port number of the exposed Apigee endpoint.
    runtimeVersion String
    Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    serviceAttachment String
    Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    state String
    State of the instance. Values other than ACTIVE means the resource is not ready to use.
    consumerAcceptList string[]
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    createdAt string
    Time the instance was created in milliseconds since epoch.
    description string
    Optional. Description of the instance.
    diskEncryptionKeyName string
    Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)
    displayName string
    Optional. Display name for the instance.
    host string
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    ipRange string
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28
    lastModifiedAt string
    Time the instance was last modified in milliseconds since epoch.
    location string
    Compute Engine location where the instance resides.
    name string
    Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.
    peeringCidrRange string
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.
    port string
    Port number of the exposed Apigee endpoint.
    runtimeVersion string
    Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    serviceAttachment string
    Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    state string
    State of the instance. Values other than ACTIVE means the resource is not ready to use.
    consumer_accept_list Sequence[str]
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    created_at str
    Time the instance was created in milliseconds since epoch.
    description str
    Optional. Description of the instance.
    disk_encryption_key_name str
    Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)
    display_name str
    Optional. Display name for the instance.
    host str
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    ip_range str
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28
    last_modified_at str
    Time the instance was last modified in milliseconds since epoch.
    location str
    Compute Engine location where the instance resides.
    name str
    Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.
    peering_cidr_range str
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.
    port str
    Port number of the exposed Apigee endpoint.
    runtime_version str
    Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    service_attachment str
    Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    state str
    State of the instance. Values other than ACTIVE means the resource is not ready to use.
    consumerAcceptList List<String>
    Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
    createdAt String
    Time the instance was created in milliseconds since epoch.
    description String
    Optional. Description of the instance.
    diskEncryptionKeyName String
    Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)
    displayName String
    Optional. Display name for the instance.
    host String
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    ipRange String
    Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28
    lastModifiedAt String
    Time the instance was last modified in milliseconds since epoch.
    location String
    Compute Engine location where the instance resides.
    name String
    Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.
    peeringCidrRange String
    Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.
    port String
    Port number of the exposed Apigee endpoint.
    runtimeVersion String
    Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
    serviceAttachment String
    Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
    state String
    State of the instance. Values other than ACTIVE means the resource is not ready to use.

    Package Details

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

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native