Class CfnApiGatewayManagedOverrides
A CloudFormation AWS::ApiGatewayV2::ApiGatewayManagedOverrides
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnApiGatewayManagedOverrides : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApiGatewayManagedOverrides
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGatewayV2::ApiGatewayManagedOverrides
resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create. When you create an API by using quick create, an AWS::ApiGatewayV2::Route
, AWS::ApiGatewayV2::Integration
, and AWS::ApiGatewayV2::Stage
are created for you and associated with your AWS::ApiGatewayV2::Api
. The AWS::ApiGatewayV2::ApiGatewayManagedOverrides
resource enables you to set, or override the properties of these implicit resources. Supported only for HTTP APIs.
CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides
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 cfnApiGatewayManagedOverrides = new CfnApiGatewayManagedOverrides(this, "MyCfnApiGatewayManagedOverrides", new CfnApiGatewayManagedOverridesProps {
ApiId = "apiId",
// the properties below are optional
Integration = new IntegrationOverridesProperty {
Description = "description",
IntegrationMethod = "integrationMethod",
PayloadFormatVersion = "payloadFormatVersion",
TimeoutInMillis = 123
},
Route = new RouteOverridesProperty {
AuthorizationScopes = new [] { "authorizationScopes" },
AuthorizationType = "authorizationType",
AuthorizerId = "authorizerId",
OperationName = "operationName",
Target = "target"
},
Stage = new StageOverridesProperty {
AccessLogSettings = new AccessLogSettingsProperty {
DestinationArn = "destinationArn",
Format = "format"
},
AutoDeploy = false,
DefaultRouteSettings = new RouteSettingsProperty {
DataTraceEnabled = false,
DetailedMetricsEnabled = false,
LoggingLevel = "loggingLevel",
ThrottlingBurstLimit = 123,
ThrottlingRateLimit = 123
},
Description = "description",
RouteSettings = routeSettings,
StageVariables = stageVariables
}
});
Synopsis
Constructors
CfnApiGatewayManagedOverrides(Construct, String, ICfnApiGatewayManagedOverridesProps) | Create a new |
CfnApiGatewayManagedOverrides(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApiGatewayManagedOverrides(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The ID of the API for which to override the configuration of API Gateway-managed resources. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Integration | Overrides the integration configuration for an API Gateway-managed integration. |
Route | Overrides the route configuration for an API Gateway-managed route. |
Stage | Overrides the stage configuration for an API Gateway-managed stage. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApiGatewayManagedOverrides(Construct, String, ICfnApiGatewayManagedOverridesProps)
Create a new AWS::ApiGatewayV2::ApiGatewayManagedOverrides
.
public CfnApiGatewayManagedOverrides(Construct scope, string id, ICfnApiGatewayManagedOverridesProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApiGatewayManagedOverridesProps
- resource properties.
CfnApiGatewayManagedOverrides(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApiGatewayManagedOverrides(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApiGatewayManagedOverrides(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApiGatewayManagedOverrides(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
The ID of the API for which to override the configuration of API Gateway-managed resources.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
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
Integration
Overrides the integration configuration for an API Gateway-managed integration.
public virtual object Integration { get; set; }
Property Value
System.Object
Remarks
Route
Overrides the route configuration for an API Gateway-managed route.
public virtual object Route { get; set; }
Property Value
System.Object
Remarks
Stage
Overrides the stage configuration for an API Gateway-managed stage.
public virtual object Stage { get; set; }
Property Value
System.Object
Remarks
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>