Class CfnStage
The AWS::ApiGatewayV2::Stage
resource specifies a stage for an API.
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStage : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStage
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see Working with stages for HTTP APIs and Deploy a WebSocket API in API Gateway .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html
CloudformationResource: AWS::ApiGatewayV2::Stage
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 cfnStage = new CfnStage(this, "MyCfnStage", 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
CfnStage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnStage(Construct, String, ICfnStageProps) |
Properties
AccessLogSettings | Settings for logging access in this stage. |
AccessPolicyId | This parameter is not currently supported. |
ApiId | The API identifier. |
AttrId | The identifier. |
AutoDeploy | Specifies whether updates to an API automatically trigger a new deployment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | The collection of tags. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnStage(Construct, String, ICfnStageProps)
public CfnStage(Construct scope, string id, ICfnStageProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStageProps
Resource properties.
Properties
AccessLogSettings
Settings for logging access in this stage.
public virtual object AccessLogSettings { get; set; }
Property Value
System.Object
AccessPolicyId
This parameter is not currently supported.
public virtual string AccessPolicyId { get; set; }
Property Value
System.String
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
AttrId
The identifier.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AutoDeploy
Specifies whether updates to an API automatically trigger a new deployment.
public virtual object AutoDeploy { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientCertificateId
The identifier of a client certificate for a Stage
.
public virtual string ClientCertificateId { get; set; }
Property Value
System.String
DefaultRouteSettings
The default route settings for the stage.
public virtual object DefaultRouteSettings { get; set; }
Property Value
System.Object
DeploymentId
The deployment identifier for the API stage.
public virtual string DeploymentId { get; set; }
Property Value
System.String
Description
The description for the API stage.
public virtual string Description { get; set; }
Property Value
System.String
RouteSettings
Route settings for the stage.
public virtual object RouteSettings { get; set; }
Property Value
System.Object
StageName
The stage name.
public virtual string StageName { get; set; }
Property Value
System.String
StageVariables
A map that defines the stage variables for a Stage
.
public virtual object StageVariables { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The collection of tags.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>