class CfnMethodPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnMethodPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnMethodPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnMethodPropsMixin
Python	aws_cdk.mixins_preview.aws_apigateway.mixins.CfnMethodPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigateway » mixins » CfnMethodPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.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 apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const cfnMethodPropsMixin = new apigateway_mixins.CfnMethodPropsMixin({
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizationType: 'authorizationType',
  authorizerId: 'authorizerId',
  httpMethod: 'httpMethod',
  integration: {
    cacheKeyParameters: ['cacheKeyParameters'],
    cacheNamespace: 'cacheNamespace',
    connectionId: 'connectionId',
    connectionType: 'connectionType',
    contentHandling: 'contentHandling',
    credentials: 'credentials',
    integrationHttpMethod: 'integrationHttpMethod',
    integrationResponses: [{
      contentHandling: 'contentHandling',
      responseParameters: {
        responseParametersKey: 'responseParameters',
      },
      responseTemplates: {
        responseTemplatesKey: 'responseTemplates',
      },
      selectionPattern: 'selectionPattern',
      statusCode: 'statusCode',
    }],
    integrationTarget: 'integrationTarget',
    passthroughBehavior: 'passthroughBehavior',
    requestParameters: {
      requestParametersKey: 'requestParameters',
    },
    requestTemplates: {
      requestTemplatesKey: 'requestTemplates',
    },
    responseTransferMode: 'responseTransferMode',
    timeoutInMillis: 123,
    type: 'type',
    uri: 'uri',
  },
  methodResponses: [{
    responseModels: {
      responseModelsKey: 'responseModels',
    },
    responseParameters: {
      responseParametersKey: false,
    },
    statusCode: 'statusCode',
  }],
  operationName: 'operationName',
  requestModels: {
    requestModelsKey: 'requestModels',
  },
  requestParameters: {
    requestParametersKey: false,
  },
  requestValidatorId: 'requestValidatorId',
  resourceId: 'resourceId',
  restApiId: 'restApiId',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnMethodPropsMixin(props: CfnMethodMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::ApiGateway::Method.

Properties

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

---

props

Type: CfnMethodMixinProps

---

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.