AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateDeployment operation. Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.APIGateway.AmazonAPIGatewayRequest
      Amazon.APIGateway.Model.CreateDeploymentRequest

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDeploymentRequest : AmazonAPIGatewayRequest
         IAmazonWebServiceRequest

The CreateDeploymentRequest type exposes the following members

Constructors

NameDescription
Public Method CreateDeploymentRequest()

Properties

NameTypeDescription
Public Property CacheClusterEnabled System.Boolean

Gets and sets the property CacheClusterEnabled.

Enables a cache cluster for the Stage resource specified in the input.

Public Property CacheClusterSize Amazon.APIGateway.CacheClusterSize

Gets and sets the property CacheClusterSize.

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Public Property CanarySettings Amazon.APIGateway.Model.DeploymentCanarySettings

Gets and sets the property CanarySettings.

The input configuration for the canary deployment when the deployment is a canary release deployment.

Public Property Description System.String

Gets and sets the property Description.

The description for the Deployment resource to create.

Public Property RestApiId System.String

Gets and sets the property RestApiId.

The string identifier of the associated RestApi.

Public Property StageDescription System.String

Gets and sets the property StageDescription.

The description of the Stage resource for the Deployment resource to create.

Public Property StageName System.String

Gets and sets the property StageName.

The name of the Stage resource for the Deployment resource to create.

Public Property TracingEnabled System.Boolean

Gets and sets the property TracingEnabled.

Specifies whether active tracing with X-ray is enabled for the Stage.

Public Property Variables System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Variables.

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5