Class DeploymentProps

Inheritance

System.Object

DeploymentProps

Implements

IDeploymentProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class DeploymentProps : Object, IDeploymentProps

Syntax (vb)

Public Class DeploymentProps
    Inherits Object
    Implements IDeploymentProps

Remarks

ExampleMetadata: infused

Examples

// production stage
var prdLogGroup = new LogGroup(this, "PrdLogs");
var api = new RestApi(this, "books", new RestApiProps {
    DeployOptions = new StageOptions {
        AccessLogDestination = new LogGroupLogDestination(prdLogGroup),
        AccessLogFormat = AccessLogFormat.JsonWithStandardFields()
    }
});
var deployment = new Deployment(this, "Deployment", new DeploymentProps { Api = api });

// development stage
var devLogGroup = new LogGroup(this, "DevLogs");
new Stage(this, "dev", new StageProps {
    Deployment = deployment,
    AccessLogDestination = new LogGroupLogDestination(devLogGroup),
    AccessLogFormat = AccessLogFormat.JsonWithStandardFields(new JsonWithStandardFieldProps {
        Caller = false,
        HttpMethod = true,
        Ip = true,
        Protocol = true,
        RequestTime = true,
        ResourcePath = true,
        ResponseLength = true,
        Status = true,
        User = true
    })
});

Synopsis

Constructors

DeploymentProps()

Properties

Api	The Rest API to deploy.
Description	A description of the purpose of the API Gateway deployment.
RetainDeployments	When an API Gateway model is updated, a new deployment will automatically be created.

Constructors

DeploymentProps()

public DeploymentProps()

Properties

Api

The Rest API to deploy.

public IRestApi Api { get; set; }

Property Value

IRestApi

Description

A description of the purpose of the API Gateway deployment.

public string Description { get; set; }

Property Value

System.String

Remarks

Default: - No description.

RetainDeployments

When an API Gateway model is updated, a new deployment will automatically be created.

public Nullable<bool> RetainDeployments { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

If this is true, the old API Gateway Deployment resource will not be deleted. This will allow manually reverting back to a previous deployment in case for example

Default: false

Implements

IDeploymentProps