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

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.getDeployment

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.

Using getDeployment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
Copy
def get_deployment(api_id: Optional[str] = None,
                   deployment_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(api_id: Optional[pulumi.Input[str]] = None,
                   deployment_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
Copy
func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput
Copy

> Note: This function is named LookupDeployment in the Go SDK.

public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:apigatewayv2:getDeployment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId This property is required. string
The API identifier.
DeploymentId This property is required. string
The deployment ID.
ApiId This property is required. string
The API identifier.
DeploymentId This property is required. string
The deployment ID.
apiId This property is required. String
The API identifier.
deploymentId This property is required. String
The deployment ID.
apiId This property is required. string
The API identifier.
deploymentId This property is required. string
The deployment ID.
api_id This property is required. str
The API identifier.
deployment_id This property is required. str
The deployment ID.
apiId This property is required. String
The API identifier.
deploymentId This property is required. String
The deployment ID.

getDeployment Result

The following output properties are available:

DeploymentId string
The deployment ID.
Description string
The description for the deployment resource.
DeploymentId string
The deployment ID.
Description string
The description for the deployment resource.
deploymentId String
The deployment ID.
description String
The description for the deployment resource.
deploymentId string
The deployment ID.
description string
The description for the deployment resource.
deployment_id str
The deployment ID.
description str
The description for the deployment resource.
deploymentId String
The deployment ID.
description String
The description for the deployment 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