Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. Reference

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.apigee/v1.Reference

Explore with Pulumi AI

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

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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReferenceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ReferenceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReferenceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
var referenceResource = new Reference("referenceResource", ReferenceArgs.builder()
    .environmentId("string")
    .organizationId("string")
    .refers("string")
    .description("string")
    .name("string")
    .resourceType("string")
    .build());
Copy
reference_resource = google_native.apigee.v1.Reference("referenceResource",
    environment_id="string",
    organization_id="string",
    refers="string",
    description="string",
    name="string",
    resource_type="string")
Copy
const referenceResource = new google_native.apigee.v1.Reference("referenceResource", {
    environmentId: "string",
    organizationId: "string",
    refers: "string",
    description: "string",
    name: "string",
    resourceType: "string",
});
Copy
type: google-native:apigee/v1:Reference
properties:
    description: string
    environmentId: string
    name: string
    organizationId: string
    refers: string
    resourceType: string
Copy

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:

EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
Refers This property is required. 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-.]+.
ResourceType string
The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
EnvironmentId
This property is required.
Changes to this property will trigger replacement.
string
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
Refers This property is required. 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-.]+.
ResourceType string
The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
environmentId
This property is required.
Changes to this property will trigger replacement.
String
organizationId
This property is required.
Changes to this property will trigger replacement.
String
refers This property is required. 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-.]+.
resourceType String
The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
environmentId
This property is required.
Changes to this property will trigger replacement.
string
organizationId
This property is required.
Changes to this property will trigger replacement.
string
refers This property is required. 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-.]+.
resourceType string
The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
environment_id
This property is required.
Changes to this property will trigger replacement.
str
organization_id
This property is required.
Changes to this property will trigger replacement.
str
refers This property is required. 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'.
environmentId
This property is required.
Changes to this property will trigger replacement.
String
organizationId
This property is required.
Changes to this property will trigger replacement.
String
refers This property is required. 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-.]+.
resourceType 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

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