Class CfnApiMixinProps

Properties for CfnApiPropsMixin.

Inheritance

object

CfnApiMixinProps

Implements

ICfnApiMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnApiMixinProps : ICfnApiMixinProps

Syntax (vb)

Public Class CfnApiMixinProps Implements ICfnApiMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html

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.AWS.SAM.Mixins;

             var authorizers;
             var definitionBody;
             var gatewayResponses;
             var methodSettings;
             var models;

             var cfnApiMixinProps = new CfnApiMixinProps {
                 AccessLogSetting = new AccessLogSettingProperty {
                     DestinationArn = "destinationArn",
                     Format = "format"
                 },
                 AlwaysDeploy = false,
                 Auth = new AuthProperty {
                     AddDefaultAuthorizerToCorsPreflight = false,
                     Authorizers = authorizers,
                     DefaultAuthorizer = "defaultAuthorizer"
                 },
                 BinaryMediaTypes = new [] { "binaryMediaTypes" },
                 CacheClusterEnabled = false,
                 CacheClusterSize = "cacheClusterSize",
                 CanarySetting = new CanarySettingProperty {
                     DeploymentId = "deploymentId",
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Cors = "cors",
                 DefinitionBody = definitionBody,
                 DefinitionUri = "definitionUri",
                 Description = "description",
                 DisableExecuteApiEndpoint = false,
                 Domain = new DomainConfigurationProperty {
                     BasePath = new [] { "basePath" },
                     CertificateArn = "certificateArn",
                     DomainName = "domainName",
                     EndpointConfiguration = "endpointConfiguration",
                     MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
                         TruststoreUri = "truststoreUri",
                         TruststoreVersion = "truststoreVersion"
                     },
                     OwnershipVerificationCertificateArn = "ownershipVerificationCertificateArn",
                     Route53 = new Route53ConfigurationProperty {
                         DistributedDomainName = "distributedDomainName",
                         EvaluateTargetHealth = false,
                         HostedZoneId = "hostedZoneId",
                         HostedZoneName = "hostedZoneName",
                         IpV6 = false
                     },
                     SecurityPolicy = "securityPolicy"
                 },
                 EndpointConfiguration = "endpointConfiguration",
                 GatewayResponses = gatewayResponses,
                 MethodSettings = new [] { methodSettings },
                 MinimumCompressionSize = 123,
                 Models = models,
                 Name = "name",
                 OpenApiVersion = "openApiVersion",
                 StageName = "stageName",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TracingEnabled = false,
                 Variables = new Dictionary<string, string> {
                     { "variablesKey", "variables" }
                 }
             };

Synopsis

Constructors

CfnApiMixinProps()

Properties for CfnApiPropsMixin.

Properties

AccessLogSetting	Properties for CfnApiPropsMixin.
AlwaysDeploy	Properties for CfnApiPropsMixin.
Auth	Properties for CfnApiPropsMixin.
BinaryMediaTypes	Properties for CfnApiPropsMixin.
CacheClusterEnabled	Properties for CfnApiPropsMixin.
CacheClusterSize	Properties for CfnApiPropsMixin.
CanarySetting	Properties for CfnApiPropsMixin.
Cors	Properties for CfnApiPropsMixin.
DefinitionBody	Properties for CfnApiPropsMixin.
DefinitionUri	Properties for CfnApiPropsMixin.
Description	Properties for CfnApiPropsMixin.
DisableExecuteApiEndpoint	Properties for CfnApiPropsMixin.
Domain	Properties for CfnApiPropsMixin.
EndpointConfiguration	Properties for CfnApiPropsMixin.
GatewayResponses	Properties for CfnApiPropsMixin.
MethodSettings	Properties for CfnApiPropsMixin.
MinimumCompressionSize	Properties for CfnApiPropsMixin.
Models	Properties for CfnApiPropsMixin.
Name	Properties for CfnApiPropsMixin.
OpenApiVersion	Properties for CfnApiPropsMixin.
StageName	Properties for CfnApiPropsMixin.
Tags	Properties for CfnApiPropsMixin.
TracingEnabled	Properties for CfnApiPropsMixin.
Variables	Properties for CfnApiPropsMixin.

Constructors

CfnApiMixinProps()

Properties for CfnApiPropsMixin.

public CfnApiMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html

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.AWS.SAM.Mixins;

             var authorizers;
             var definitionBody;
             var gatewayResponses;
             var methodSettings;
             var models;

             var cfnApiMixinProps = new CfnApiMixinProps {
                 AccessLogSetting = new AccessLogSettingProperty {
                     DestinationArn = "destinationArn",
                     Format = "format"
                 },
                 AlwaysDeploy = false,
                 Auth = new AuthProperty {
                     AddDefaultAuthorizerToCorsPreflight = false,
                     Authorizers = authorizers,
                     DefaultAuthorizer = "defaultAuthorizer"
                 },
                 BinaryMediaTypes = new [] { "binaryMediaTypes" },
                 CacheClusterEnabled = false,
                 CacheClusterSize = "cacheClusterSize",
                 CanarySetting = new CanarySettingProperty {
                     DeploymentId = "deploymentId",
                     PercentTraffic = 123,
                     StageVariableOverrides = new Dictionary<string, string> {
                         { "stageVariableOverridesKey", "stageVariableOverrides" }
                     },
                     UseStageCache = false
                 },
                 Cors = "cors",
                 DefinitionBody = definitionBody,
                 DefinitionUri = "definitionUri",
                 Description = "description",
                 DisableExecuteApiEndpoint = false,
                 Domain = new DomainConfigurationProperty {
                     BasePath = new [] { "basePath" },
                     CertificateArn = "certificateArn",
                     DomainName = "domainName",
                     EndpointConfiguration = "endpointConfiguration",
                     MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
                         TruststoreUri = "truststoreUri",
                         TruststoreVersion = "truststoreVersion"
                     },
                     OwnershipVerificationCertificateArn = "ownershipVerificationCertificateArn",
                     Route53 = new Route53ConfigurationProperty {
                         DistributedDomainName = "distributedDomainName",
                         EvaluateTargetHealth = false,
                         HostedZoneId = "hostedZoneId",
                         HostedZoneName = "hostedZoneName",
                         IpV6 = false
                     },
                     SecurityPolicy = "securityPolicy"
                 },
                 EndpointConfiguration = "endpointConfiguration",
                 GatewayResponses = gatewayResponses,
                 MethodSettings = new [] { methodSettings },
                 MinimumCompressionSize = 123,
                 Models = models,
                 Name = "name",
                 OpenApiVersion = "openApiVersion",
                 StageName = "stageName",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TracingEnabled = false,
                 Variables = new Dictionary<string, string> {
                     { "variablesKey", "variables" }
                 }
             };

Properties

AccessLogSetting

Properties for CfnApiPropsMixin.

public object? AccessLogSetting { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-accesslogsetting

Type union: either IResolvable or CfnApiPropsMixin.IAccessLogSettingProperty

AlwaysDeploy

Properties for CfnApiPropsMixin.

public object? AlwaysDeploy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-alwaysdeploy

Type union: either bool or IResolvable

Auth

Properties for CfnApiPropsMixin.

public object? Auth { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-auth

Type union: either IResolvable or CfnApiPropsMixin.IAuthProperty

BinaryMediaTypes

Properties for CfnApiPropsMixin.

public string[]? BinaryMediaTypes { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-binarymediatypes

CacheClusterEnabled

Properties for CfnApiPropsMixin.

public object? CacheClusterEnabled { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-cacheclusterenabled

Type union: either bool or IResolvable

CacheClusterSize

Properties for CfnApiPropsMixin.

public string? CacheClusterSize { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-cacheclustersize

CanarySetting

Properties for CfnApiPropsMixin.

public object? CanarySetting { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-canarysetting

Type union: either IResolvable or CfnApiPropsMixin.ICanarySettingProperty

Cors

Properties for CfnApiPropsMixin.

public object? Cors { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-cors

Type union: either string or IResolvable or CfnApiPropsMixin.ICorsConfigurationProperty

DefinitionBody

Properties for CfnApiPropsMixin.

public object? DefinitionBody { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-definitionbody

DefinitionUri

Properties for CfnApiPropsMixin.

public object? DefinitionUri { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-definitionuri

Type union: either string or IResolvable or CfnApiPropsMixin.IS3LocationProperty

Description

Properties for CfnApiPropsMixin.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-description

DisableExecuteApiEndpoint

Properties for CfnApiPropsMixin.

public object? DisableExecuteApiEndpoint { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-disableexecuteapiendpoint

Type union: either bool or IResolvable

Domain

Properties for CfnApiPropsMixin.

public object? Domain { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-domain

Type union: either IResolvable or CfnApiPropsMixin.IDomainConfigurationProperty

EndpointConfiguration

Properties for CfnApiPropsMixin.

public object? EndpointConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-endpointconfiguration

Type union: either string or IResolvable or CfnApiPropsMixin.IEndpointConfigurationProperty

GatewayResponses

Properties for CfnApiPropsMixin.

public object? GatewayResponses { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-gatewayresponses

MethodSettings

Properties for CfnApiPropsMixin.

public object? MethodSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-methodsettings

Type union: either (object)[] or IResolvable

MinimumCompressionSize

Properties for CfnApiPropsMixin.

public double? MinimumCompressionSize { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-minimumcompressionsize

Models

Properties for CfnApiPropsMixin.

public object? Models { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-models

Name

Properties for CfnApiPropsMixin.

public string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-name

OpenApiVersion

Properties for CfnApiPropsMixin.

public string? OpenApiVersion { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-openapiversion

StageName

Properties for CfnApiPropsMixin.

public string? StageName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-stagename

Tags

Properties for CfnApiPropsMixin.

public IDictionary<string, string>? Tags { get; set; }

Property Value

IDictionary<string, string>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-tags

TracingEnabled

Properties for CfnApiPropsMixin.

public object? TracingEnabled { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-tracingenabled

Type union: either bool or IResolvable

Variables

Properties for CfnApiPropsMixin.

public object? Variables { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-variables

Type union: either Dictionary<string, string> or IResolvable

Implements

ICfnApiMixinProps