Class CfnApiProps

Properties for defining a CfnApi.

Inheritance

object

CfnApiProps

Implements

ICfnApiProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApiProps : ICfnApiProps

Syntax (vb)

Public Class CfnApiProps Implements ICfnApiProps

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

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

             var cfnApiProps = new CfnApiProps {
                 StageName = "stageName",

                 // the properties below are optional
                 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 {
                     CertificateArn = "certificateArn",
                     DomainName = "domainName",

                     // the properties below are optional
                     BasePath = new [] { "basePath" },
                     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",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TracingEnabled = false,
                 Variables = new Dictionary<string, string> {
                     { "variablesKey", "variables" }
                 }
             };

Synopsis

Constructors

CfnApiProps()

Properties for defining a CfnApi.

Properties

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

Constructors

CfnApiProps()

Properties for defining a CfnApi.

public CfnApiProps()

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

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

             var cfnApiProps = new CfnApiProps {
                 StageName = "stageName",

                 // the properties below are optional
                 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 {
                     CertificateArn = "certificateArn",
                     DomainName = "domainName",

                     // the properties below are optional
                     BasePath = new [] { "basePath" },
                     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",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TracingEnabled = false,
                 Variables = new Dictionary<string, string> {
                     { "variablesKey", "variables" }
                 }
             };

Properties

AccessLogSetting

Properties for defining a CfnApi.

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 CfnApi.IAccessLogSettingProperty

AlwaysDeploy

Properties for defining a CfnApi.

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 defining a CfnApi.

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 CfnApi.IAuthProperty

BinaryMediaTypes

Properties for defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 CfnApi.ICanarySettingProperty

Cors

Properties for defining a CfnApi.

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 CfnApi.ICorsConfigurationProperty

DefinitionBody

Properties for defining a CfnApi.

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 defining a CfnApi.

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 CfnApi.IS3LocationProperty

Description

Properties for defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 CfnApi.IDomainConfigurationProperty

EndpointConfiguration

Properties for defining a CfnApi.

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 CfnApi.IEndpointConfigurationProperty

GatewayResponses

Properties for defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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 defining a CfnApi.

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

ICfnApiProps