Docs Home
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
aws-native.apigatewayv2.Deployment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.
Create Deployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);@overload
def Deployment(resource_name: str,
args: DeploymentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Deployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
description: Optional[str] = None,
stage_name: Optional[str] = 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: aws-native:apigatewayv2:Deployment
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. DeploymentArgs - 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. 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
This property is required. string - The unique name of the resource.
- args
This property is required. DeploymentArgs - 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. DeploymentArgs - 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. 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Deployment resource accepts the following input properties:
- Api
Id This property is required. string - The API identifier.
- Description string
- The description for the deployment resource.
- Stage
Name string - The name of an existing stage to associate with the deployment.
- Api
Id This property is required. string - The API identifier.
- Description string
- The description for the deployment resource.
- Stage
Name string - The name of an existing stage to associate with the deployment.
- api
Id This property is required. String - The API identifier.
- description String
- The description for the deployment resource.
- stage
Name String - The name of an existing stage to associate with the deployment.
- api
Id This property is required. string - The API identifier.
- description string
- The description for the deployment resource.
- stage
Name string - The name of an existing stage to associate with the deployment.
- api_
id This property is required. str - The API identifier.
- description str
- The description for the deployment resource.
- stage_
name str - The name of an existing stage to associate with the deployment.
- api
Id This property is required. String - The API identifier.
- description String
- The description for the deployment resource.
- stage
Name String - The name of an existing stage to associate with the deployment.
Outputs
All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:
- Deployment
Id string - The deployment ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Deployment
Id string - The deployment ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- deployment
Id String - The deployment ID.
- id String
- The provider-assigned unique ID for this managed resource.
- deployment
Id string - The deployment ID.
- id string
- The provider-assigned unique ID for this managed resource.
- deployment_
id str - The deployment ID.
- id str
- The provider-assigned unique ID for this managed resource.
- deployment
Id String - The deployment ID.
- id String
- The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi