1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. Deployment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.apigatewayv2.Deployment

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 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 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

    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:

    ApiId string
    The API identifier.
    Description string
    The description for the deployment resource.
    StageName string
    The name of an existing stage to associate with the deployment.
    ApiId string
    The API identifier.
    Description string
    The description for the deployment resource.
    StageName string
    The name of an existing stage to associate with the deployment.
    apiId String
    The API identifier.
    description String
    The description for the deployment resource.
    stageName String
    The name of an existing stage to associate with the deployment.
    apiId string
    The API identifier.
    description string
    The description for the deployment resource.
    stageName 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.
    apiId String
    The API identifier.
    description String
    The description for the deployment resource.
    stageName 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:

    DeploymentId string
    The deployment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    DeploymentId string
    The deployment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    deploymentId String
    The deployment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    deploymentId 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.
    deploymentId 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
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi