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

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

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

    Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.

    Create Instance Resource

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

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             organization_id: Optional[str] = None,
             consumer_accept_list: Optional[Sequence[str]] = None,
             description: Optional[str] = None,
             disk_encryption_key_name: Optional[str] = None,
             display_name: Optional[str] = None,
             ip_range: Optional[str] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             peering_cidr_range: Optional[InstancePeeringCidrRange] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: google-native:apigee/v1:Instance
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 InstanceArgs
    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 InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var exampleinstanceResourceResourceFromApigeev1 = new GoogleNative.Apigee.V1.Instance("exampleinstanceResourceResourceFromApigeev1", new()
{
    OrganizationId = "string",
    ConsumerAcceptList = new[]
    {
        "string",
    },
    Description = "string",
    DiskEncryptionKeyName = "string",
    DisplayName = "string",
    IpRange = "string",
    Location = "string",
    Name = "string",
    PeeringCidrRange = GoogleNative.Apigee.V1.InstancePeeringCidrRange.CidrRangeUnspecified,
});

    example, err := apigee.NewInstance(ctx, "exampleinstanceResourceResourceFromApigeev1", &apigee.InstanceArgs{
OrganizationId: pulumi.String("string"),
ConsumerAcceptList: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
DiskEncryptionKeyName: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IpRange: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
PeeringCidrRange: apigee.InstancePeeringCidrRangeCidrRangeUnspecified,
})

    var exampleinstanceResourceResourceFromApigeev1 = new Instance("exampleinstanceResourceResourceFromApigeev1", InstanceArgs.builder()        
    .organizationId("string")
    .consumerAcceptList("string")
    .description("string")
    .diskEncryptionKeyName("string")
    .displayName("string")
    .ipRange("string")
    .location("string")
    .name("string")
    .peeringCidrRange("CIDR_RANGE_UNSPECIFIED")
    .build());

    exampleinstance_resource_resource_from_apigeev1 = google_native.apigee.v1.Instance("exampleinstanceResourceResourceFromApigeev1",
    organization_id="string",
    consumer_accept_list=["string"],
    description="string",
    disk_encryption_key_name="string",
    display_name="string",
    ip_range="string",
    location="string",
    name="string",
    peering_cidr_range=google_native.apigee.v1.InstancePeeringCidrRange.CIDR_RANGE_UNSPECIFIED)

    const exampleinstanceResourceResourceFromApigeev1 = new google_native.apigee.v1.Instance("exampleinstanceResourceResourceFromApigeev1", {
    organizationId: "string",
    consumerAcceptList: ["string"],
    description: "string",
    diskEncryptionKeyName: "string",
    displayName: "string",
    ipRange: "string",
    location: "string",
    name: "string",
    peeringCidrRange: google_native.apigee.v1.InstancePeeringCidrRange.CidrRangeUnspecified,
});

    type: google-native:apigee/v1:Instance
properties:
    consumerAcceptList:
        - string
    description: string
    diskEncryptionKeyName: string
    displayName: string
    ipRange: string
    location: string
    name: string
    organizationId: string
    peeringCidrRange: CIDR_RANGE_UNSPECIFIED

    Instance Resource Properties

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

    Inputs

    The Instance resource accepts the following input properties:

    OrganizationId string
    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.
    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.
    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
    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 Pulumi.GoogleNative.Apigee.V1.InstancePeeringCidrRange
    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.
    OrganizationId string
    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.
    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.
    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
    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 InstancePeeringCidrRange
    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.
    organizationId String
    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.
    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.
    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
    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 InstancePeeringCidrRange
    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.
    organizationId string
    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.
    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.
    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
    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 InstancePeeringCidrRange
    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.
    organization_id str
    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.
    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.
    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
    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 InstancePeeringCidrRange
    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.
    organizationId String
    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.
    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.
    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
    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 "CIDR_RANGE_UNSPECIFIED" | "SLASH_16" | "SLASH_17" | "SLASH_18" | "SLASH_19" | "SLASH_20" | "SLASH_22" | "SLASH_23"
    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.

    Outputs

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

    CreatedAt string
    Time the instance was created in milliseconds since epoch.
    Host string
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    Time the instance was last modified in milliseconds since epoch.
    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.
    CreatedAt string
    Time the instance was created in milliseconds since epoch.
    Host string
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    Time the instance was last modified in milliseconds since epoch.
    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.
    createdAt String
    Time the instance was created in milliseconds since epoch.
    host String
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    Time the instance was last modified in milliseconds since epoch.
    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.
    createdAt string
    Time the instance was created in milliseconds since epoch.
    host string
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt string
    Time the instance was last modified in milliseconds since epoch.
    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.
    created_at str
    Time the instance was created in milliseconds since epoch.
    host str
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at str
    Time the instance was last modified in milliseconds since epoch.
    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.
    createdAt String
    Time the instance was created in milliseconds since epoch.
    host String
    Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    Time the instance was last modified in milliseconds since epoch.
    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.

    Supporting Types

    InstancePeeringCidrRange, InstancePeeringCidrRangeArgs

    CidrRangeUnspecified
    CIDR_RANGE_UNSPECIFIEDRange not specified.
    Slash16
    SLASH_16/16 CIDR range.
    Slash17
    SLASH_17/17 CIDR range.
    Slash18
    SLASH_18/18 CIDR range.
    Slash19
    SLASH_19/19 CIDR range.
    Slash20
    SLASH_20/20 CIDR range.
    Slash22
    SLASH_22/22 CIDR range. Supported for evaluation only.
    Slash23
    SLASH_23/23 CIDR range. Supported for evaluation only.
    InstancePeeringCidrRangeCidrRangeUnspecified
    CIDR_RANGE_UNSPECIFIEDRange not specified.
    InstancePeeringCidrRangeSlash16
    SLASH_16/16 CIDR range.
    InstancePeeringCidrRangeSlash17
    SLASH_17/17 CIDR range.
    InstancePeeringCidrRangeSlash18
    SLASH_18/18 CIDR range.
    InstancePeeringCidrRangeSlash19
    SLASH_19/19 CIDR range.
    InstancePeeringCidrRangeSlash20
    SLASH_20/20 CIDR range.
    InstancePeeringCidrRangeSlash22
    SLASH_22/22 CIDR range. Supported for evaluation only.
    InstancePeeringCidrRangeSlash23
    SLASH_23/23 CIDR range. Supported for evaluation only.
    CidrRangeUnspecified
    CIDR_RANGE_UNSPECIFIEDRange not specified.
    Slash16
    SLASH_16/16 CIDR range.
    Slash17
    SLASH_17/17 CIDR range.
    Slash18
    SLASH_18/18 CIDR range.
    Slash19
    SLASH_19/19 CIDR range.
    Slash20
    SLASH_20/20 CIDR range.
    Slash22
    SLASH_22/22 CIDR range. Supported for evaluation only.
    Slash23
    SLASH_23/23 CIDR range. Supported for evaluation only.
    CidrRangeUnspecified
    CIDR_RANGE_UNSPECIFIEDRange not specified.
    Slash16
    SLASH_16/16 CIDR range.
    Slash17
    SLASH_17/17 CIDR range.
    Slash18
    SLASH_18/18 CIDR range.
    Slash19
    SLASH_19/19 CIDR range.
    Slash20
    SLASH_20/20 CIDR range.
    Slash22
    SLASH_22/22 CIDR range. Supported for evaluation only.
    Slash23
    SLASH_23/23 CIDR range. Supported for evaluation only.
    CIDR_RANGE_UNSPECIFIED
    CIDR_RANGE_UNSPECIFIEDRange not specified.
    SLASH16
    SLASH_16/16 CIDR range.
    SLASH17
    SLASH_17/17 CIDR range.
    SLASH18
    SLASH_18/18 CIDR range.
    SLASH19
    SLASH_19/19 CIDR range.
    SLASH20
    SLASH_20/20 CIDR range.
    SLASH22
    SLASH_22/22 CIDR range. Supported for evaluation only.
    SLASH23
    SLASH_23/23 CIDR range. Supported for evaluation only.
    "CIDR_RANGE_UNSPECIFIED"
    CIDR_RANGE_UNSPECIFIEDRange not specified.
    "SLASH_16"
    SLASH_16/16 CIDR range.
    "SLASH_17"
    SLASH_17/17 CIDR range.
    "SLASH_18"
    SLASH_18/18 CIDR range.
    "SLASH_19"
    SLASH_19/19 CIDR range.
    "SLASH_20"
    SLASH_20/20 CIDR range.
    "SLASH_22"
    SLASH_22/22 CIDR range. Supported for evaluation only.
    "SLASH_23"
    SLASH_23/23 CIDR range. Supported for evaluation only.

    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