Class CfnApiGatewayManagedOverrides

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.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnApiGatewayManagedOverrides

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApiGatewayManagedOverrides : CfnResource, IInspectable

Syntax (vb)

Public Class CfnApiGatewayManagedOverrides Inherits CfnResource Implements IInspectable

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

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)

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.

Properties

ApiId	The ID of the API for which to override the configuration of API Gateway-managed resources.
AttrId	The identifier.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	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.
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>)	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.

Constructors

CfnApiGatewayManagedOverrides(Construct, string, ICfnApiGatewayManagedOverridesProps)

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.

public CfnApiGatewayManagedOverrides(Construct scope, string id, ICfnApiGatewayManagedOverridesProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnApiGatewayManagedOverridesProps

Resource properties.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

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

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

AttrId

The identifier.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

CfnProperties

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.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

Integration

Overrides the integration configuration for an API Gateway-managed integration.

public virtual object? Integration { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

Route

Overrides the route configuration for an API Gateway-managed route.

public virtual object? Route { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

Stage

Overrides the stage configuration for an API Gateway-managed stage.

public virtual object? Stage { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

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.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apigatewaymanagedoverrides.html

CloudformationResource: AWS::ApiGatewayV2::ApiGatewayManagedOverrides

ExampleMetadata: fixture=_generated

Implements

IInspectable