AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigatewayv2.Deployment
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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 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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const aws_nativeDeploymentResource = new aws_native.apigatewayv2.Deployment("aws-nativeDeploymentResource", {
apiId: "string",
description: "string",
stageName: "string",
});
Coming soon!
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:
- Api
Id 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 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 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 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 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 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 - Id string
- The provider-assigned unique ID for this managed resource.
- Deployment
Id string - Id string
- The provider-assigned unique ID for this managed resource.
- deployment
Id String - id String
- The provider-assigned unique ID for this managed resource.
- deployment
Id string - id string
- The provider-assigned unique ID for this managed resource.
- deployment_
id str - id str
- The provider-assigned unique ID for this managed resource.
- deployment
Id String - id String
- The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.