Class CfnStageProps
Properties for defining a CfnStage
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStageProps : Object, ICfnStageProps
Syntax (vb)
Public Class CfnStageProps
Inherits Object
Implements ICfnStageProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
var routeSettings;
var stageVariables;
var tags;
var cfnStageProps = new CfnStageProps {
ApiId = "apiId",
StageName = "stageName",
// the properties below are optional
AccessLogSettings = new AccessLogSettingsProperty {
DestinationArn = "destinationArn",
Format = "format"
},
AccessPolicyId = "accessPolicyId",
AutoDeploy = false,
ClientCertificateId = "clientCertificateId",
DefaultRouteSettings = new RouteSettingsProperty {
DataTraceEnabled = false,
DetailedMetricsEnabled = false,
LoggingLevel = "loggingLevel",
ThrottlingBurstLimit = 123,
ThrottlingRateLimit = 123
},
DeploymentId = "deploymentId",
Description = "description",
RouteSettings = routeSettings,
StageVariables = stageVariables,
Tags = tags
};
Synopsis
Constructors
CfnStageProps() |
Properties
AccessLogSettings | Settings for logging access in this stage. |
AccessPolicyId | This parameter is not currently supported. |
ApiId | The API identifier. |
AutoDeploy | Specifies whether updates to an API automatically trigger a new deployment. |
ClientCertificateId | The identifier of a client certificate for a |
DefaultRouteSettings | The default route settings for the stage. |
DeploymentId | The deployment identifier for the API stage. |
Description | The description for the API stage. |
RouteSettings | Route settings for the stage. |
StageName | The stage name. |
StageVariables | A map that defines the stage variables for a |
Tags | The collection of tags. |
Constructors
CfnStageProps()
public CfnStageProps()
Properties
AccessLogSettings
Settings for logging access in this stage.
public object AccessLogSettings { get; set; }
Property Value
System.Object
Remarks
AccessPolicyId
This parameter is not currently supported.
public string AccessPolicyId { get; set; }
Property Value
System.String
Remarks
ApiId
The API identifier.
public string ApiId { get; set; }
Property Value
System.String
Remarks
AutoDeploy
Specifies whether updates to an API automatically trigger a new deployment.
public object AutoDeploy { get; set; }
Property Value
System.Object
Remarks
The default value is false
.
ClientCertificateId
The identifier of a client certificate for a Stage
.
public string ClientCertificateId { get; set; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
DefaultRouteSettings
The default route settings for the stage.
public object DefaultRouteSettings { get; set; }
Property Value
System.Object
Remarks
DeploymentId
The deployment identifier for the API stage.
public string DeploymentId { get; set; }
Property Value
System.String
Remarks
Can't be updated if autoDeploy
is enabled.
Description
The description for the API stage.
public string Description { get; set; }
Property Value
System.String
Remarks
RouteSettings
Route settings for the stage.
public object RouteSettings { get; set; }
Property Value
System.Object
Remarks
StageName
The stage name.
public string StageName { get; set; }
Property Value
System.String
Remarks
Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default
. Maximum length is 128 characters.
StageVariables
A map that defines the stage variables for a Stage
.
public object StageVariables { get; set; }
Property Value
System.Object
Remarks
Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
Tags
The collection of tags.
public object Tags { get; set; }
Property Value
System.Object
Remarks
Each tag element is associated with a given resource.