This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
Creates a Reference in the specified environment.
Create Reference Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Reference(name: string, args: ReferenceArgs, opts?: CustomResourceOptions);@overload
def Reference(resource_name: str,
args: ReferenceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Reference(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment_id: Optional[str] = None,
organization_id: Optional[str] = None,
refers: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
resource_type: Optional[str] = None)func NewReference(ctx *Context, name string, args ReferenceArgs, opts ...ResourceOption) (*Reference, error)public Reference(string name, ReferenceArgs args, CustomResourceOptions? opts = null)
public Reference(String name, ReferenceArgs args)
public Reference(String name, ReferenceArgs args, CustomResourceOptions options)
type: google-native:apigee/v1:Reference
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_apigee_v1_reference" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ReferenceArgs
- 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 ReferenceArgs
- 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 ReferenceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReferenceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ReferenceArgs
- 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 referenceResource = new GoogleNative.Apigee.V1.Reference("referenceResource", new()
{
EnvironmentId = "string",
OrganizationId = "string",
Refers = "string",
Description = "string",
Name = "string",
ResourceType = "string",
});
example, err := apigee.NewReference(ctx, "referenceResource", &apigee.ReferenceArgs{
EnvironmentId: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
Refers: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
})
resource "google-native_apigee_v1_reference" "referenceResource" {
lifecycle {
create_before_destroy = true
}
environment_id = "string"
organization_id = "string"
refers = "string"
description = "string"
name = "string"
resource_type = "string"
}
var referenceResource = new Reference("referenceResource", ReferenceArgs.builder()
.environmentId("string")
.organizationId("string")
.refers("string")
.description("string")
.name("string")
.resourceType("string")
.build());
reference_resource = google_native.apigee.v1.Reference("referenceResource",
environment_id="string",
organization_id="string",
refers="string",
description="string",
name="string",
resource_type="string")
const referenceResource = new google_native.apigee.v1.Reference("referenceResource", {
environmentId: "string",
organizationId: "string",
refers: "string",
description: "string",
name: "string",
resourceType: "string",
});
type: google-native:apigee/v1:Reference
properties:
description: string
environmentId: string
name: string
organizationId: string
refers: string
resourceType: string
Reference 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 Reference resource accepts the following input properties:
- Environment
Id string - Organization
Id string - Refers string
- 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 resource_type.
- Description string
- Optional. A human-readable description of this reference.
- Name string
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- Resource
Type string - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
- Environment
Id string - Organization
Id string - Refers string
- 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 resource_type.
- Description string
- Optional. A human-readable description of this reference.
- Name string
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- Resource
Type string - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
- environment_
id string - organization_
id string - refers string
- 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 resource_type.
- description string
- Optional. A human-readable description of this reference.
- name string
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- resource_
type string - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
- environment
Id String - organization
Id String - refers String
- 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 resource_type.
- description String
- Optional. A human-readable description of this reference.
- name String
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- resource
Type String - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
- environment
Id string - organization
Id string - refers string
- 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 resource_type.
- description string
- Optional. A human-readable description of this reference.
- name string
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- resource
Type string - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
- environment_
id str - organization_
id str - refers str
- 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 resource_type.
- description str
- Optional. A human-readable description of this reference.
- name str
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- resource_
type str - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
- environment
Id String - organization
Id String - refers String
- 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 resource_type.
- description String
- Optional. A human-readable description of this reference.
- name String
- The resource id of this reference. Values must match the regular expression [\w\s-.]+.
- resource
Type String - The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
Outputs
All input properties are implicitly available as output properties. Additionally, the Reference 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 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 Reference Resource
Get an existing Reference 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>, opts?: CustomResourceOptions): Reference@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Referencefunc GetReference(ctx *Context, name string, id IDInput, state *ReferenceState, opts ...ResourceOption) (*Reference, error)public static Reference Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Reference get(String name, Output<String> id, CustomResourceOptions options)resources: existingReference: type: google-native:apigee/v1:Reference get: id: ${id}import {
to = google-native_apigee_v1_reference.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ReferenceState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi