Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigeeregistry
  5. apigeeregistry/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.apigeeregistry/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

    Provisions instance resources for the Registry. Auto-naming is currently not supported for this resource.

    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,
             config: Optional[ConfigArgs] = None,
             instance_id: Optional[str] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             project: Optional[str] = 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:apigeeregistry/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.

    Constructor example

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

    var exampleinstanceResourceResourceFromApigeeregistryv1 = new GoogleNative.ApigeeRegistry.V1.Instance("exampleinstanceResourceResourceFromApigeeregistryv1", new()
{
    Config = new GoogleNative.ApigeeRegistry.V1.Inputs.ConfigArgs
    {
        CmekKeyName = "string",
    },
    InstanceId = "string",
    Location = "string",
    Name = "string",
    Project = "string",
});

    example, err := apigeeregistry.NewInstance(ctx, "exampleinstanceResourceResourceFromApigeeregistryv1", &apigeeregistry.InstanceArgs{
	Config: &apigeeregistry.ConfigArgs{
		CmekKeyName: pulumi.String("string"),
	},
	InstanceId: pulumi.String("string"),
	Location:   pulumi.String("string"),
	Name:       pulumi.String("string"),
	Project:    pulumi.String("string"),
})

    var exampleinstanceResourceResourceFromApigeeregistryv1 = new Instance("exampleinstanceResourceResourceFromApigeeregistryv1", InstanceArgs.builder()
    .config(ConfigArgs.builder()
        .cmekKeyName("string")
        .build())
    .instanceId("string")
    .location("string")
    .name("string")
    .project("string")
    .build());

    exampleinstance_resource_resource_from_apigeeregistryv1 = google_native.apigeeregistry.v1.Instance("exampleinstanceResourceResourceFromApigeeregistryv1",
    config={
        "cmek_key_name": "string",
    },
    instance_id="string",
    location="string",
    name="string",
    project="string")

    const exampleinstanceResourceResourceFromApigeeregistryv1 = new google_native.apigeeregistry.v1.Instance("exampleinstanceResourceResourceFromApigeeregistryv1", {
    config: {
        cmekKeyName: "string",
    },
    instanceId: "string",
    location: "string",
    name: "string",
    project: "string",
});

    type: google-native:apigeeregistry/v1:Instance
properties:
    config:
        cmekKeyName: string
    instanceId: string
    location: string
    name: string
    project: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    Config Pulumi.GoogleNative.ApigeeRegistry.V1.Inputs.Config
    Config of the Instance.
    InstanceId string
    Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
    Location string
    Name string
    Format: projects/*/locations/*/instance. Currently only locations/global is supported.
    Project string
    Config ConfigArgs
    Config of the Instance.
    InstanceId string
    Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
    Location string
    Name string
    Format: projects/*/locations/*/instance. Currently only locations/global is supported.
    Project string
    config Config
    Config of the Instance.
    instanceId String
    Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
    location String
    name String
    Format: projects/*/locations/*/instance. Currently only locations/global is supported.
    project String
    config Config
    Config of the Instance.
    instanceId string
    Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
    location string
    name string
    Format: projects/*/locations/*/instance. Currently only locations/global is supported.
    project string
    config ConfigArgs
    Config of the Instance.
    instance_id str
    Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
    location str
    name str
    Format: projects/*/locations/*/instance. Currently only locations/global is supported.
    project str
    config Property Map
    Config of the Instance.
    instanceId String
    Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.
    location String
    name String
    Format: projects/*/locations/*/instance. Currently only locations/global is supported.
    project String

    Outputs

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

    Build Pulumi.GoogleNative.ApigeeRegistry.V1.Outputs.BuildResponse
    Build info of the Instance if it's in ACTIVE state.
    CreateTime string
    Creation timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the Instance.
    StateMessage string
    Extra information of Instance.State if the state is FAILED.
    UpdateTime string
    Last update timestamp.
    Build BuildResponse
    Build info of the Instance if it's in ACTIVE state.
    CreateTime string
    Creation timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the Instance.
    StateMessage string
    Extra information of Instance.State if the state is FAILED.
    UpdateTime string
    Last update timestamp.
    build BuildResponse
    Build info of the Instance if it's in ACTIVE state.
    createTime String
    Creation timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the Instance.
    stateMessage String
    Extra information of Instance.State if the state is FAILED.
    updateTime String
    Last update timestamp.
    build BuildResponse
    Build info of the Instance if it's in ACTIVE state.
    createTime string
    Creation timestamp.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the Instance.
    stateMessage string
    Extra information of Instance.State if the state is FAILED.
    updateTime string
    Last update timestamp.
    build BuildResponse
    Build info of the Instance if it's in ACTIVE state.
    create_time str
    Creation timestamp.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the Instance.
    state_message str
    Extra information of Instance.State if the state is FAILED.
    update_time str
    Last update timestamp.
    build Property Map
    Build info of the Instance if it's in ACTIVE state.
    createTime String
    Creation timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the Instance.
    stateMessage String
    Extra information of Instance.State if the state is FAILED.
    updateTime String
    Last update timestamp.

    Supporting Types

    BuildResponse, BuildResponseArgs

    CommitId string
    Commit ID of the latest commit in the build.
    CommitTime string
    Commit time of the latest commit in the build.
    Repo string
    Path of the open source repository: github.com/apigee/registry.
    CommitId string
    Commit ID of the latest commit in the build.
    CommitTime string
    Commit time of the latest commit in the build.
    Repo string
    Path of the open source repository: github.com/apigee/registry.
    commitId String
    Commit ID of the latest commit in the build.
    commitTime String
    Commit time of the latest commit in the build.
    repo String
    Path of the open source repository: github.com/apigee/registry.
    commitId string
    Commit ID of the latest commit in the build.
    commitTime string
    Commit time of the latest commit in the build.
    repo string
    Path of the open source repository: github.com/apigee/registry.
    commit_id str
    Commit ID of the latest commit in the build.
    commit_time str
    Commit time of the latest commit in the build.
    repo str
    Path of the open source repository: github.com/apigee/registry.
    commitId String
    Commit ID of the latest commit in the build.
    commitTime String
    Commit time of the latest commit in the build.
    repo String
    Path of the open source repository: github.com/apigee/registry.

    Config, ConfigArgs

    CmekKeyName string
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    CmekKeyName string
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    cmekKeyName String
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    cmekKeyName string
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    cmek_key_name str
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    cmekKeyName String
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.

    ConfigResponse, ConfigResponseArgs

    CmekKeyName string
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    Location string
    The GCP location where the Instance resides.
    CmekKeyName string
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    Location string
    The GCP location where the Instance resides.
    cmekKeyName String
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    location String
    The GCP location where the Instance resides.
    cmekKeyName string
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    location string
    The GCP location where the Instance resides.
    cmek_key_name str
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    location str
    The GCP location where the Instance resides.
    cmekKeyName String
    The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
    location String
    The GCP location where the Instance resides.

    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