class CfnApiGatewayManagedOverridesPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnApiGatewayManagedOverridesPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnApiGatewayManagedOverridesPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnApiGatewayManagedOverridesPropsMixin
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnApiGatewayManagedOverridesPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnApiGatewayManagedOverridesPropsMixin

Implements IMixin

Extends Mixin

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';

declare const routeSettings: any;
declare const stageVariables: any;
const cfnApiGatewayManagedOverridesPropsMixin = new apigatewayv2_mixins.CfnApiGatewayManagedOverridesPropsMixin({
  apiId: 'apiId',
  integration: {
    description: 'description',
    integrationMethod: 'integrationMethod',
    payloadFormatVersion: 'payloadFormatVersion',
    timeoutInMillis: 123,
  },
  route: {
    authorizationScopes: ['authorizationScopes'],
    authorizationType: 'authorizationType',
    authorizerId: 'authorizerId',
    operationName: 'operationName',
    target: 'target',
  },
  stage: {
    accessLogSettings: {
      destinationArn: 'destinationArn',
      format: 'format',
    },
    autoDeploy: false,
    defaultRouteSettings: {
      dataTraceEnabled: false,
      detailedMetricsEnabled: false,
      loggingLevel: 'loggingLevel',
      throttlingBurstLimit: 123,
      throttlingRateLimit: 123,
    },
    description: 'description',
    routeSettings: routeSettings,
    stageVariables: stageVariables,
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnApiGatewayManagedOverridesPropsMixin(props: CfnApiGatewayManagedOverridesMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnApiGatewayManagedOverridesMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGatewayV2::ApiGatewayManagedOverrides.

Properties

Name	Type	Description
props	CfnApiGatewayManagedOverridesMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnApiGatewayManagedOverridesMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.