Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getDeployment

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getDeployment

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

    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>
    def get_deployment(deployment_id: Optional[str] = None,
                   rest_api_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(deployment_id: Optional[pulumi.Input[str]] = None,
                   rest_api_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
    func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

    > 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)
}
    public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigateway:getDeployment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DeploymentId string
    The ID for the deployment. For example: abc123 .
    RestApiId string
    The string identifier of the associated RestApi.
    DeploymentId string
    The ID for the deployment. For example: abc123 .
    RestApiId string
    The string identifier of the associated RestApi.
    deploymentId String
    The ID for the deployment. For example: abc123 .
    restApiId String
    The string identifier of the associated RestApi.
    deploymentId string
    The ID for the deployment. For example: abc123 .
    restApiId string
    The string identifier of the associated RestApi.
    deployment_id str
    The ID for the deployment. For example: abc123 .
    rest_api_id str
    The string identifier of the associated RestApi.
    deploymentId String
    The ID for the deployment. For example: abc123 .
    restApiId String
    The string identifier of the associated RestApi.

    getDeployment Result

    The following output properties are available:

    DeploymentId string
    The ID for the deployment. For example: abc123 .
    Description string
    The description for the Deployment resource to create.
    DeploymentId string
    The ID for the deployment. For example: abc123 .
    Description string
    The description for the Deployment resource to create.
    deploymentId String
    The ID for the deployment. For example: abc123 .
    description String
    The description for the Deployment resource to create.
    deploymentId string
    The ID for the deployment. For example: abc123 .
    description string
    The description for the Deployment resource to create.
    deployment_id str
    The ID for the deployment. For example: abc123 .
    description str
    The description for the Deployment resource to create.
    deploymentId String
    The ID for the deployment. For example: abc123 .
    description String
    The description for the Deployment resource to create.

    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.28.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aws-native