Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. apigee
  6. EnvKeystore
Viewing docs for Google Cloud v9.24.0
published on Friday, May 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.apigee.EnvKeystore

gcp logo
Viewing docs for Google Cloud v9.24.0
published on Friday, May 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    An Environment KeyStore in Apigee.

    To get more information about EnvKeystore, see:

    Create EnvKeystore Resource

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

    Constructor syntax

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

@overload
def EnvKeystore(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                env_id: Optional[str] = None,
                deletion_policy: Optional[str] = None,
                name: Optional[str] = None)
    func NewEnvKeystore(ctx *Context, name string, args EnvKeystoreArgs, opts ...ResourceOption) (*EnvKeystore, error)
    public EnvKeystore(string name, EnvKeystoreArgs args, CustomResourceOptions? opts = null)
    public EnvKeystore(String name, EnvKeystoreArgs args)
public EnvKeystore(String name, EnvKeystoreArgs args, CustomResourceOptions options)

    type: gcp:apigee:EnvKeystore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_apigee_envkeystore" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnvKeystoreArgs
    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 EnvKeystoreArgs
    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 EnvKeystoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvKeystoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvKeystoreArgs
    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 envKeystoreResource = new Gcp.Apigee.EnvKeystore("envKeystoreResource", new()
{
    EnvId = "string",
    DeletionPolicy = "string",
    Name = "string",
});

    example, err := apigee.NewEnvKeystore(ctx, "envKeystoreResource", &apigee.EnvKeystoreArgs{
	EnvId:          pulumi.String("string"),
	DeletionPolicy: pulumi.String("string"),
	Name:           pulumi.String("string"),
})

    resource "gcp_apigee_envkeystore" "envKeystoreResource" {
  env_id          = "string"
  deletion_policy = "string"
  name            = "string"
}

    var envKeystoreResource = new EnvKeystore("envKeystoreResource", EnvKeystoreArgs.builder()
    .envId("string")
    .deletionPolicy("string")
    .name("string")
    .build());

    env_keystore_resource = gcp.apigee.EnvKeystore("envKeystoreResource",
    env_id="string",
    deletion_policy="string",
    name="string")

    const envKeystoreResource = new gcp.apigee.EnvKeystore("envKeystoreResource", {
    envId: "string",
    deletionPolicy: "string",
    name: "string",
});

    type: gcp:apigee:EnvKeystore
properties:
    deletionPolicy: string
    envId: string
    name: string

    EnvKeystore 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 EnvKeystore resource accepts the following input properties:

    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    DeletionPolicy 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.
    Name string
    The name of the newly created keystore.
    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    DeletionPolicy 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.
    Name string
    The name of the newly created keystore.
    env_id string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    deletion_policy 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.
    name string
    The name of the newly created keystore.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    deletionPolicy 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.
    name String
    The name of the newly created keystore.
    envId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    deletionPolicy 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.
    name string
    The name of the newly created keystore.
    env_id str
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    deletion_policy str
    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.
    name str
    The name of the newly created keystore.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    deletionPolicy 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.
    name String
    The name of the newly created keystore.

    Outputs

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

    Aliases List<string>
    Aliases in this keystore.
    Id string
    The provider-assigned unique ID for this managed resource.
    Aliases []string
    Aliases in this keystore.
    Id string
    The provider-assigned unique ID for this managed resource.
    aliases list(string)
    Aliases in this keystore.
    id string
    The provider-assigned unique ID for this managed resource.
    aliases List<String>
    Aliases in this keystore.
    id String
    The provider-assigned unique ID for this managed resource.
    aliases string[]
    Aliases in this keystore.
    id string
    The provider-assigned unique ID for this managed resource.
    aliases Sequence[str]
    Aliases in this keystore.
    id str
    The provider-assigned unique ID for this managed resource.
    aliases List<String>
    Aliases in this keystore.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EnvKeystore Resource

    Get an existing EnvKeystore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EnvKeystoreState, opts?: CustomResourceOptions): EnvKeystore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliases: Optional[Sequence[str]] = None,
        deletion_policy: Optional[str] = None,
        env_id: Optional[str] = None,
        name: Optional[str] = None) -> EnvKeystore
    func GetEnvKeystore(ctx *Context, name string, id IDInput, state *EnvKeystoreState, opts ...ResourceOption) (*EnvKeystore, error)
    public static EnvKeystore Get(string name, Input<string> id, EnvKeystoreState? state, CustomResourceOptions? opts = null)
    public static EnvKeystore get(String name, Output<String> id, EnvKeystoreState state, CustomResourceOptions options)
    resources:  _:    type: gcp:apigee:EnvKeystore    get:      id: ${id}
    import {
  to = gcp_apigee_envkeystore.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Aliases List<string>
    Aliases in this keystore.
    DeletionPolicy 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.
    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    Name string
    The name of the newly created keystore.
    Aliases []string
    Aliases in this keystore.
    DeletionPolicy 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.
    EnvId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    Name string
    The name of the newly created keystore.
    aliases list(string)
    Aliases in this keystore.
    deletion_policy 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.
    env_id string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    name string
    The name of the newly created keystore.
    aliases List<String>
    Aliases in this keystore.
    deletionPolicy 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.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    name String
    The name of the newly created keystore.
    aliases string[]
    Aliases in this keystore.
    deletionPolicy 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.
    envId string
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    name string
    The name of the newly created keystore.
    aliases Sequence[str]
    Aliases in this keystore.
    deletion_policy str
    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.
    env_id str
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    name str
    The name of the newly created keystore.
    aliases List<String>
    Aliases in this keystore.
    deletionPolicy 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.
    envId String
    The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
    name String
    The name of the newly created keystore.

    Import

    EnvKeystore can be imported using any of these accepted formats:

    • {{env_id}}/keystores/{{name}}
    • {{env_id}}/{{name}}

    When using the pulumi import command, EnvKeystore can be imported using one of the formats above. For example:

    $ pulumi import gcp:apigee/envKeystore:EnvKeystore default {{env_id}}/keystores/{{name}}
$ pulumi import gcp:apigee/envKeystore:EnvKeystore default {{env_id}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.24.0
    published on Friday, May 22, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial