Google Cloud Classic v6.57.0, May 30 23

gcp.apigee.EnvReferences

Explore with Pulumi AI

An Environment Reference in Apigee.

To get more information about EnvReferences, see:

API documentation
How-to Guides
- Creating an environment

Create EnvReferences Resource

new EnvReferences(name: string, args: EnvReferencesArgs, opts?: CustomResourceOptions);

@overload
def EnvReferences(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  env_id: Optional[str] = None,
                  name: Optional[str] = None,
                  refers: Optional[str] = None,
                  resource_type: Optional[str] = None)
@overload
def EnvReferences(resource_name: str,
                  args: EnvReferencesArgs,
                  opts: Optional[ResourceOptions] = None)

func NewEnvReferences(ctx *Context, name string, args EnvReferencesArgs, opts ...ResourceOption) (*EnvReferences, error)

public EnvReferences(string name, EnvReferencesArgs args, CustomResourceOptions? opts = null)

public EnvReferences(String name, EnvReferencesArgs args)
public EnvReferences(String name, EnvReferencesArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args EnvReferencesArgs: 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 EnvReferencesArgs: 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 EnvReferencesArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EnvReferencesArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EnvReferencesArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

EnvReferences 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 EnvReferences 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}}.
Refers string: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
ResourceType string: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
Description string: Optional. A human-readable description of this reference.
Name string: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.

EnvId string: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
Refers string: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
ResourceType string: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
Description string: Optional. A human-readable description of this reference.
Name string: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.

envId String: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
refers String: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resourceType String: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
description String: Optional. A human-readable description of this reference.
name String: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.

envId string: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
refers string: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resourceType string: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
description string: Optional. A human-readable description of this reference.
name string: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.

env_id str: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
refers str: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resource_type str: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
description str: Optional. A human-readable description of this reference.
name str: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.

envId String: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
refers String: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resourceType String: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
description String: Optional. A human-readable description of this reference.
name String: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing EnvReferences Resource

Get an existing EnvReferences 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?: EnvReferencesState, opts?: CustomResourceOptions): EnvReferences

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        env_id: Optional[str] = None,
        name: Optional[str] = None,
        refers: Optional[str] = None,
        resource_type: Optional[str] = None) -> EnvReferences

func GetEnvReferences(ctx *Context, name string, id IDInput, state *EnvReferencesState, opts ...ResourceOption) (*EnvReferences, error)

public static EnvReferences Get(string name, Input<string> id, EnvReferencesState? state, CustomResourceOptions? opts = null)

public static EnvReferences get(String name, Output<String> id, EnvReferencesState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

Description string: Optional. A human-readable description of this reference.
EnvId string: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
Name string: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
Refers string: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
ResourceType string: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

Description string: Optional. A human-readable description of this reference.
EnvId string: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
Name string: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
Refers string: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
ResourceType string: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

description String: Optional. A human-readable description of this reference.
envId String: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
name String: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
refers String: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resourceType String: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

description string: Optional. A human-readable description of this reference.
envId string: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
name string: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
refers string: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resourceType string: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

description str: Optional. A human-readable description of this reference.
env_id str: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
name str: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
refers str: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resource_type str: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

description String: Optional. A human-readable description of this reference.
envId String: The Apigee environment group associated with the Apigee environment, in the format organizations/{{org_name}}/environments/{{env_name}}.
name String: Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
refers String: Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.
resourceType String: The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

Import

EnvReferences can be imported using any of these accepted formats

 $ pulumi import gcp:apigee/envReferences:EnvReferences default {{env_id}}/references/{{name}}

 $ pulumi import gcp:apigee/envReferences:EnvReferences default {{env_id}}/{{name}}

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.