UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

183 lines 7.01 kB
import * as pulumi from "@pulumi/pulumi"; /** * A Space in Apigee * * To get more information about Space, see: * * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.spaces) * * How-to Guides * * [Managing Spaces](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/manage-spaces) * * ## Example Usage * * ### Apigee Space Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const current = gcp.organizations.getClientConfig({}); * const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"}); * const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", { * name: "apigee-range", * purpose: "VPC_PEERING", * addressType: "INTERNAL", * prefixLength: 16, * network: apigeeNetwork.id, * }); * const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", { * network: apigeeNetwork.id, * service: "servicenetworking.googleapis.com", * reservedPeeringRanges: [apigeeRange.name], * }); * const apigeeOrg = new gcp.apigee.Organization("apigee_org", { * analyticsRegion: "us-central1", * projectId: current.then(current => current.project), * authorizedNetwork: apigeeNetwork.id, * }, { * dependsOn: [apigeeVpcConnection], * }); * const space = new gcp.apigee.Space("space", { * orgId: apigeeOrg.id, * spaceId: "tf-test-space", * displayName: "tf test Space", * }); * ``` * * ## Import * * Space can be imported using any of these accepted formats: * * * `{{org_id}}/spaces/{{space_id}}` * * `{{org_id}}/{{space_id}}` * * When using the `pulumi import` command, Space can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apigee/space:Space default {{org_id}}/spaces/{{space_id}} * $ pulumi import gcp:apigee/space:Space default {{org_id}}/{{space_id}} * ``` */ export declare class Space extends pulumi.CustomResource { /** * Get an existing Space resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SpaceState, opts?: pulumi.CustomResourceOptions): Space; /** * Returns true if the given object is an instance of Space. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Space; /** * Create timestamp of the space. */ readonly createTime: pulumi.Output<string>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output<string>; /** * The display name of the Space. */ readonly displayName: pulumi.Output<string>; /** * Identifier. Id of the space. This field is used as the resource name, and must follow AIP-122 guidelines. */ readonly name: pulumi.Output<string>; /** * The Apigee Organization associated with the Apigee Space, in the format `organizations/{{org_name}}`. */ readonly orgId: pulumi.Output<string>; /** * Space ID of the Apigee Space. */ readonly spaceId: pulumi.Output<string>; /** * Last modified timestamp of the space. */ readonly updateTime: pulumi.Output<string>; /** * Create a Space resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: SpaceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Space resources. */ export interface SpaceState { /** * Create timestamp of the space. */ createTime?: pulumi.Input<string | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * The display name of the Space. */ displayName?: pulumi.Input<string | undefined>; /** * Identifier. Id of the space. This field is used as the resource name, and must follow AIP-122 guidelines. */ name?: pulumi.Input<string | undefined>; /** * The Apigee Organization associated with the Apigee Space, in the format `organizations/{{org_name}}`. */ orgId?: pulumi.Input<string | undefined>; /** * Space ID of the Apigee Space. */ spaceId?: pulumi.Input<string | undefined>; /** * Last modified timestamp of the space. */ updateTime?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Space resource. */ export interface SpaceArgs { /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * The display name of the Space. */ displayName: pulumi.Input<string>; /** * The Apigee Organization associated with the Apigee Space, in the format `organizations/{{org_name}}`. */ orgId: pulumi.Input<string>; /** * Space ID of the Apigee Space. */ spaceId: pulumi.Input<string>; } //# sourceMappingURL=space.d.ts.map