Class CfnMethodPropsMixin

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

Inheritance

object

Mixin

CfnMethodPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnMethodPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnMethodPropsMixin Inherits Mixin Implements IMixin

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnMethodPropsMixin = new CfnMethodPropsMixin(new CfnMethodMixinProps {
                 ApiKeyRequired = false,
                 AuthorizationScopes = new [] { "authorizationScopes" },
                 AuthorizationType = "authorizationType",
                 AuthorizerId = "authorizerId",
                 HttpMethod = "httpMethod",
                 Integration = new IntegrationProperty {
                     CacheKeyParameters = new [] { "cacheKeyParameters" },
                     CacheNamespace = "cacheNamespace",
                     ConnectionId = "connectionId",
                     ConnectionType = "connectionType",
                     ContentHandling = "contentHandling",
                     Credentials = "credentials",
                     IntegrationHttpMethod = "integrationHttpMethod",
                     IntegrationResponses = new [] { new IntegrationResponseProperty {
                         ContentHandling = "contentHandling",
                         ResponseParameters = new Dictionary<string, string> {
                             { "responseParametersKey", "responseParameters" }
                         },
                         ResponseTemplates = new Dictionary<string, string> {
                             { "responseTemplatesKey", "responseTemplates" }
                         },
                         SelectionPattern = "selectionPattern",
                         StatusCode = "statusCode"
                     } },
                     IntegrationTarget = "integrationTarget",
                     PassthroughBehavior = "passthroughBehavior",
                     RequestParameters = new Dictionary<string, string> {
                         { "requestParametersKey", "requestParameters" }
                     },
                     RequestTemplates = new Dictionary<string, string> {
                         { "requestTemplatesKey", "requestTemplates" }
                     },
                     ResponseTransferMode = "responseTransferMode",
                     TimeoutInMillis = 123,
                     Type = "type",
                     Uri = "uri"
                 },
                 MethodResponses = new [] { new MethodResponseProperty {
                     ResponseModels = new Dictionary<string, string> {
                         { "responseModelsKey", "responseModels" }
                     },
                     ResponseParameters = new Dictionary<string, object> {
                         { "responseParametersKey", false }
                     },
                     StatusCode = "statusCode"
                 } },
                 OperationName = "operationName",
                 RequestModels = new Dictionary<string, string> {
                     { "requestModelsKey", "requestModels" }
                 },
                 RequestParameters = new Dictionary<string, object> {
                     { "requestParametersKey", false }
                 },
                 RequestValidatorId = "requestValidatorId",
                 ResourceId = "resourceId",
                 RestApiId = "restApiId"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnMethodPropsMixin(ICfnMethodMixinProps, ICfnPropertyMixinOptions?)

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

Properties

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

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnMethodPropsMixin(ICfnMethodMixinProps, ICfnPropertyMixinOptions?)

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

public CfnMethodPropsMixin(ICfnMethodMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnMethodMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnMethodPropsMixin = new CfnMethodPropsMixin(new CfnMethodMixinProps {
                 ApiKeyRequired = false,
                 AuthorizationScopes = new [] { "authorizationScopes" },
                 AuthorizationType = "authorizationType",
                 AuthorizerId = "authorizerId",
                 HttpMethod = "httpMethod",
                 Integration = new IntegrationProperty {
                     CacheKeyParameters = new [] { "cacheKeyParameters" },
                     CacheNamespace = "cacheNamespace",
                     ConnectionId = "connectionId",
                     ConnectionType = "connectionType",
                     ContentHandling = "contentHandling",
                     Credentials = "credentials",
                     IntegrationHttpMethod = "integrationHttpMethod",
                     IntegrationResponses = new [] { new IntegrationResponseProperty {
                         ContentHandling = "contentHandling",
                         ResponseParameters = new Dictionary<string, string> {
                             { "responseParametersKey", "responseParameters" }
                         },
                         ResponseTemplates = new Dictionary<string, string> {
                             { "responseTemplatesKey", "responseTemplates" }
                         },
                         SelectionPattern = "selectionPattern",
                         StatusCode = "statusCode"
                     } },
                     IntegrationTarget = "integrationTarget",
                     PassthroughBehavior = "passthroughBehavior",
                     RequestParameters = new Dictionary<string, string> {
                         { "requestParametersKey", "requestParameters" }
                     },
                     RequestTemplates = new Dictionary<string, string> {
                         { "requestTemplatesKey", "requestTemplates" }
                     },
                     ResponseTransferMode = "responseTransferMode",
                     TimeoutInMillis = 123,
                     Type = "type",
                     Uri = "uri"
                 },
                 MethodResponses = new [] { new MethodResponseProperty {
                     ResponseModels = new Dictionary<string, string> {
                         { "responseModelsKey", "responseModels" }
                     },
                     ResponseParameters = new Dictionary<string, object> {
                         { "responseParametersKey", false }
                     },
                     StatusCode = "statusCode"
                 } },
                 OperationName = "operationName",
                 RequestModels = new Dictionary<string, string> {
                     { "requestModelsKey", "requestModels" }
                 },
                 RequestParameters = new Dictionary<string, object> {
                     { "requestParametersKey", false }
                 },
                 RequestValidatorId = "requestValidatorId",
                 ResourceId = "resourceId",
                 RestApiId = "restApiId"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

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

protected virtual ICfnMethodMixinProps Props { get; }

Property Value

ICfnMethodMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnMethodPropsMixin = new CfnMethodPropsMixin(new CfnMethodMixinProps {
                 ApiKeyRequired = false,
                 AuthorizationScopes = new [] { "authorizationScopes" },
                 AuthorizationType = "authorizationType",
                 AuthorizerId = "authorizerId",
                 HttpMethod = "httpMethod",
                 Integration = new IntegrationProperty {
                     CacheKeyParameters = new [] { "cacheKeyParameters" },
                     CacheNamespace = "cacheNamespace",
                     ConnectionId = "connectionId",
                     ConnectionType = "connectionType",
                     ContentHandling = "contentHandling",
                     Credentials = "credentials",
                     IntegrationHttpMethod = "integrationHttpMethod",
                     IntegrationResponses = new [] { new IntegrationResponseProperty {
                         ContentHandling = "contentHandling",
                         ResponseParameters = new Dictionary<string, string> {
                             { "responseParametersKey", "responseParameters" }
                         },
                         ResponseTemplates = new Dictionary<string, string> {
                             { "responseTemplatesKey", "responseTemplates" }
                         },
                         SelectionPattern = "selectionPattern",
                         StatusCode = "statusCode"
                     } },
                     IntegrationTarget = "integrationTarget",
                     PassthroughBehavior = "passthroughBehavior",
                     RequestParameters = new Dictionary<string, string> {
                         { "requestParametersKey", "requestParameters" }
                     },
                     RequestTemplates = new Dictionary<string, string> {
                         { "requestTemplatesKey", "requestTemplates" }
                     },
                     ResponseTransferMode = "responseTransferMode",
                     TimeoutInMillis = 123,
                     Type = "type",
                     Uri = "uri"
                 },
                 MethodResponses = new [] { new MethodResponseProperty {
                     ResponseModels = new Dictionary<string, string> {
                         { "responseModelsKey", "responseModels" }
                     },
                     ResponseParameters = new Dictionary<string, object> {
                         { "responseParametersKey", false }
                     },
                     StatusCode = "statusCode"
                 } },
                 OperationName = "operationName",
                 RequestModels = new Dictionary<string, string> {
                     { "requestModelsKey", "requestModels" }
                 },
                 RequestParameters = new Dictionary<string, object> {
                     { "requestParametersKey", false }
                 },
                 RequestValidatorId = "requestValidatorId",
                 ResourceId = "resourceId",
                 RestApiId = "restApiId"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

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

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins;

             var cfnMethodPropsMixin = new CfnMethodPropsMixin(new CfnMethodMixinProps {
                 ApiKeyRequired = false,
                 AuthorizationScopes = new [] { "authorizationScopes" },
                 AuthorizationType = "authorizationType",
                 AuthorizerId = "authorizerId",
                 HttpMethod = "httpMethod",
                 Integration = new IntegrationProperty {
                     CacheKeyParameters = new [] { "cacheKeyParameters" },
                     CacheNamespace = "cacheNamespace",
                     ConnectionId = "connectionId",
                     ConnectionType = "connectionType",
                     ContentHandling = "contentHandling",
                     Credentials = "credentials",
                     IntegrationHttpMethod = "integrationHttpMethod",
                     IntegrationResponses = new [] { new IntegrationResponseProperty {
                         ContentHandling = "contentHandling",
                         ResponseParameters = new Dictionary<string, string> {
                             { "responseParametersKey", "responseParameters" }
                         },
                         ResponseTemplates = new Dictionary<string, string> {
                             { "responseTemplatesKey", "responseTemplates" }
                         },
                         SelectionPattern = "selectionPattern",
                         StatusCode = "statusCode"
                     } },
                     IntegrationTarget = "integrationTarget",
                     PassthroughBehavior = "passthroughBehavior",
                     RequestParameters = new Dictionary<string, string> {
                         { "requestParametersKey", "requestParameters" }
                     },
                     RequestTemplates = new Dictionary<string, string> {
                         { "requestTemplatesKey", "requestTemplates" }
                     },
                     ResponseTransferMode = "responseTransferMode",
                     TimeoutInMillis = 123,
                     Type = "type",
                     Uri = "uri"
                 },
                 MethodResponses = new [] { new MethodResponseProperty {
                     ResponseModels = new Dictionary<string, string> {
                         { "responseModelsKey", "responseModels" }
                     },
                     ResponseParameters = new Dictionary<string, object> {
                         { "responseParametersKey", false }
                     },
                     StatusCode = "statusCode"
                 } },
                 OperationName = "operationName",
                 RequestModels = new Dictionary<string, string> {
                     { "requestModelsKey", "requestModels" }
                 },
                 RequestParameters = new Dictionary<string, object> {
                     { "requestParametersKey", false }
                 },
                 RequestValidatorId = "requestValidatorId",
                 ResourceId = "resourceId",
                 RestApiId = "restApiId"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Returns

IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html

CloudformationResource: AWS::ApiGateway::Method

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin