Google Native

Pulumi Official
Package maintained by Pulumi
v0.20.0 published on Monday, Jun 6, 2022 by Pulumi

Deployment

CreateApiDeployment creates a specified deployment.

Create a Deployment Resource

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_guidance: Optional[str] = None,
               annotations: Optional[Mapping[str, str]] = None,
               api_deployment_id: Optional[str] = None,
               api_id: Optional[str] = None,
               api_spec_revision: Optional[str] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               endpoint_uri: Optional[str] = None,
               external_channel_uri: Optional[str] = None,
               intended_audience: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None)
@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)
func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: google-native:apigeeregistry/v1:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

ApiDeploymentId string

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

ApiId string
AccessGuidance string

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

Annotations Dictionary<string, string>

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

ApiSpecRevision string

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

Description string

A detailed description.

DisplayName string

Human-meaningful name.

EndpointUri string

The address where the deployment is serving. Changes to this value will update the revision.

ExternalChannelUri string

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

IntendedAudience string

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

Labels Dictionary<string, string>

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

Location string
Name string

Resource name.

Project string
ApiDeploymentId string

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

ApiId string
AccessGuidance string

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

Annotations map[string]string

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

ApiSpecRevision string

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

Description string

A detailed description.

DisplayName string

Human-meaningful name.

EndpointUri string

The address where the deployment is serving. Changes to this value will update the revision.

ExternalChannelUri string

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

IntendedAudience string

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

Labels map[string]string

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

Location string
Name string

Resource name.

Project string
apiDeploymentId String

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

apiId String
accessGuidance String

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

annotations Map<String,String>

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

apiSpecRevision String

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

description String

A detailed description.

displayName String

Human-meaningful name.

endpointUri String

The address where the deployment is serving. Changes to this value will update the revision.

externalChannelUri String

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

intendedAudience String

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

labels Map<String,String>

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

location String
name String

Resource name.

project String
apiDeploymentId string

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

apiId string
accessGuidance string

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

annotations {[key: string]: string}

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

apiSpecRevision string

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

description string

A detailed description.

displayName string

Human-meaningful name.

endpointUri string

The address where the deployment is serving. Changes to this value will update the revision.

externalChannelUri string

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

intendedAudience string

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

labels {[key: string]: string}

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

location string
name string

Resource name.

project string
api_deployment_id str

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

api_id str
access_guidance str

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

annotations Mapping[str, str]

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

api_spec_revision str

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

description str

A detailed description.

display_name str

Human-meaningful name.

endpoint_uri str

The address where the deployment is serving. Changes to this value will update the revision.

external_channel_uri str

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

intended_audience str

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

labels Mapping[str, str]

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

location str
name str

Resource name.

project str
apiDeploymentId String

Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.

apiId String
accessGuidance String

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

annotations Map<String>

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

apiSpecRevision String

The full resource name (including revision id) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

description String

A detailed description.

displayName String

Human-meaningful name.

endpointUri String

The address where the deployment is serving. Changes to this value will update the revision.

externalChannelUri String

The address of the external channel of the API (e.g. the Developer Portal). Changes to this value will not affect the revision.

intendedAudience String

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

labels Map<String>

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "apigeeregistry.googleapis.com/" and cannot be changed.

location String
name String

Resource name.

project String

Outputs

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

CreateTime string

Creation timestamp; when the deployment resource was created.

Id string

The provider-assigned unique ID for this managed resource.

RevisionCreateTime string

Revision creation timestamp; when the represented revision was created.

RevisionId string

Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

RevisionUpdateTime string

Last update timestamp: when the represented revision was last modified.

CreateTime string

Creation timestamp; when the deployment resource was created.

Id string

The provider-assigned unique ID for this managed resource.

RevisionCreateTime string

Revision creation timestamp; when the represented revision was created.

RevisionId string

Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

RevisionUpdateTime string

Last update timestamp: when the represented revision was last modified.

createTime String

Creation timestamp; when the deployment resource was created.

id String

The provider-assigned unique ID for this managed resource.

revisionCreateTime String

Revision creation timestamp; when the represented revision was created.

revisionId String

Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

revisionUpdateTime String

Last update timestamp: when the represented revision was last modified.

createTime string

Creation timestamp; when the deployment resource was created.

id string

The provider-assigned unique ID for this managed resource.

revisionCreateTime string

Revision creation timestamp; when the represented revision was created.

revisionId string

Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

revisionUpdateTime string

Last update timestamp: when the represented revision was last modified.

create_time str

Creation timestamp; when the deployment resource was created.

id str

The provider-assigned unique ID for this managed resource.

revision_create_time str

Revision creation timestamp; when the represented revision was created.

revision_id str

Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

revision_update_time str

Last update timestamp: when the represented revision was last modified.

createTime String

Creation timestamp; when the deployment resource was created.

id String

The provider-assigned unique ID for this managed resource.

revisionCreateTime String

Revision creation timestamp; when the represented revision was created.

revisionId String

Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

revisionUpdateTime String

Last update timestamp: when the represented revision was last modified.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0