pulumi-gcp-kotlin/com.pulumi.gcp.apigee.kotlin/InstanceArgs

InstanceArgs

data class InstanceArgs(val consumerAcceptLists: Output<List<String>>? = null, val description: Output<String>? = null, val diskEncryptionKeyName: Output<String>? = null, val displayName: Output<String>? = null, val ipRange: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val orgId: Output<String>? = null, val peeringCidrRange: Output<String>? = null) : ConvertibleToJava<InstanceArgs>

An Instance is the runtime dataplane in Apigee. To get more information about Instance, see:

Example Usage

Apigee Instance Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.Instance;
import com.pulumi.gcp.apigee.InstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var current = OrganizationsFunctions.getClientConfig();
        var apigeeNetwork = new Network("apigeeNetwork");
        var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(16)
            .network(apigeeNetwork.id())
            .build());
        var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
            .network(apigeeNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(apigeeRange.name())
            .build());
        var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeVpcConnection)
                .build());
        var apigeeInstance = new Instance("apigeeInstance", InstanceArgs.builder()
            .location("us-central1")
            .orgId(apigeeOrg.id())
            .build());
    }
}
Content copied to clipboard

Apigee Instance Cidr Range

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.Instance;
import com.pulumi.gcp.apigee.InstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var current = OrganizationsFunctions.getClientConfig();
        var apigeeNetwork = new Network("apigeeNetwork");
        var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(22)
            .network(apigeeNetwork.id())
            .build());
        var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
            .network(apigeeNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(apigeeRange.name())
            .build());
        var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeVpcConnection)
                .build());
        var apigeeInstance = new Instance("apigeeInstance", InstanceArgs.builder()
            .location("us-central1")
            .orgId(apigeeOrg.id())
            .peeringCidrRange("SLASH_22")
            .build());
    }
}
Content copied to clipboard

Apigee Instance Ip Range

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.Instance;
import com.pulumi.gcp.apigee.InstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var current = OrganizationsFunctions.getClientConfig();
        var apigeeNetwork = new Network("apigeeNetwork");
        var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(22)
            .network(apigeeNetwork.id())
            .build());
        var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
            .network(apigeeNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(apigeeRange.name())
            .build());
        var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeVpcConnection)
                .build());
        var apigeeInstance = new Instance("apigeeInstance", InstanceArgs.builder()
            .location("us-central1")
            .orgId(apigeeOrg.id())
            .ipRange("10.87.8.0/22")
            .build());
    }
}
Content copied to clipboard

Apigee Instance Full

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.projects.ServiceIdentity;
import com.pulumi.gcp.projects.ServiceIdentityArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.Instance;
import com.pulumi.gcp.apigee.InstanceArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var current = OrganizationsFunctions.getClientConfig();
        var apigeeNetwork = new Network("apigeeNetwork");
        var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(16)
            .network(apigeeNetwork.id())
            .build());
        var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
            .network(apigeeNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(apigeeRange.name())
            .build());
        var apigeeKeyring = new KeyRing("apigeeKeyring", KeyRingArgs.builder()
            .location("us-central1")
            .build());
        var apigeeKey = new CryptoKey("apigeeKey", CryptoKeyArgs.builder()
            .keyRing(apigeeKeyring.id())
            .build());
        var apigeeSa = new ServiceIdentity("apigeeSa", ServiceIdentityArgs.builder()
            .project(google_project.project().project_id())
            .service(google_project_service.apigee().service())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
        var apigeeSaKeyuser = new CryptoKeyIAMBinding("apigeeSaKeyuser", CryptoKeyIAMBindingArgs.builder()
            .cryptoKeyId(apigeeKey.id())
            .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
            .members(apigeeSa.email().applyValue(email -> String.format("serviceAccount:%s", email)))
            .build());
        var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .displayName("apigee-org")
            .description("Auto-provisioned Apigee Org.")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .runtimeDatabaseEncryptionKeyName(apigeeKey.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(
                    apigeeVpcConnection,
                    apigeeSaKeyuser)
                .build());
        var apigeeInstance = new Instance("apigeeInstance", InstanceArgs.builder()
            .location("us-central1")
            .description("Auto-managed Apigee Runtime Instance")
            .displayName("my-instance-name")
            .orgId(apigeeOrg.id())
            .diskEncryptionKeyName(apigeeKey.id())
            .build());
    }
}
Content copied to clipboard

Import

Instance can be imported using any of these accepted formats

$ pulumi import gcp:apigee/instance:Instance default {{org_id}}/instances/{{name}}
Content copied to clipboard
$ pulumi import gcp:apigee/instance:Instance default {{org_id}}/{{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(consumerAcceptLists: Output<List<String>>? = null, description: Output<String>? = null, diskEncryptionKeyName: Output<String>? = null, displayName: Output<String>? = null, ipRange: Output<String>? = null, location: Output<String>? = null, name: Output<String>? = null, orgId: Output<String>? = null, peeringCidrRange: Output<String>? = null)

Properties

Link copied to clipboard
val consumerAcceptLists: Output<List<String>>? = null

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.

Link copied to clipboard
val description: Output<String>? = null

Description of the instance.

Link copied to clipboard
val diskEncryptionKeyName: Output<String>? = null

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/([^/]+)

Link copied to clipboard
val displayName: Output<String>? = null

Display name of the instance.

Link copied to clipboard
val ipRange: Output<String>? = null

IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22"

Link copied to clipboard
val location: Output<String>? = null

Required. Compute Engine location where the instance resides.

Link copied to clipboard
val name: Output<String>? = null

Resource ID of the instance.

Link copied to clipboard
val orgId: Output<String>? = null

The Apigee Organization associated with the Apigee instance, in the format organizations/{{org_name}}.

Link copied to clipboard
val peeringCidrRange: Output<String>? = null

The size of the CIDR block range that will be reserved by the instance. For valid values, see CidrRange on the documentation.

Functions

Link copied to clipboard
open override fun toJava(): InstanceArgs