Class CfnHttpApiProps

Properties for defining a CfnHttpApi.

Inheritance

System.Object

CfnHttpApiProps

Implements

ICfnHttpApiProps

Namespace: Amazon.CDK.AWS.SAM

Assembly: Amazon.CDK.AWS.SAM.dll

Syntax (csharp)

public class CfnHttpApiProps : Object, ICfnHttpApiProps

Syntax (vb)

Public Class CfnHttpApiProps
    Inherits Object
    Implements ICfnHttpApiProps

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

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 cfnHttpApiProps = new CfnHttpApiProps {
    AccessLogSetting = new AccessLogSettingProperty {
        DestinationArn = "destinationArn",
        Format = "format"
    },
    Auth = new HttpApiAuthProperty {
        Authorizers = authorizers,
        DefaultAuthorizer = "defaultAuthorizer"
    },
    CorsConfiguration = false,
    DefaultRouteSettings = new RouteSettingsProperty {
        DataTraceEnabled = false,
        DetailedMetricsEnabled = false,
        LoggingLevel = "loggingLevel",
        ThrottlingBurstLimit = 123,
        ThrottlingRateLimit = 123
    },
    DefinitionBody = definitionBody,
    DefinitionUri = "definitionUri",
    Description = "description",
    DisableExecuteApiEndpoint = false,
    Domain = new HttpApiDomainConfigurationProperty {
        CertificateArn = "certificateArn",
        DomainName = "domainName",

        // the properties below are optional
        BasePath = "basePath",
        EndpointConfiguration = "endpointConfiguration",
        MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
            TruststoreUri = "truststoreUri",
            TruststoreVersion = false
        },
        Route53 = new Route53ConfigurationProperty {
            DistributedDomainName = "distributedDomainName",
            EvaluateTargetHealth = false,
            HostedZoneId = "hostedZoneId",
            HostedZoneName = "hostedZoneName",
            IpV6 = false
        },
        SecurityPolicy = "securityPolicy"
    },
    FailOnWarnings = false,
    RouteSettings = new RouteSettingsProperty {
        DataTraceEnabled = false,
        DetailedMetricsEnabled = false,
        LoggingLevel = "loggingLevel",
        ThrottlingBurstLimit = 123,
        ThrottlingRateLimit = 123
    },
    StageName = "stageName",
    StageVariables = new Dictionary<string, string> {
        { "stageVariablesKey", "stageVariables" }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};

Synopsis

Constructors

CfnHttpApiProps()

Properties

AccessLogSetting	AWS::Serverless::HttpApi.AccessLogSetting.
Auth	AWS::Serverless::HttpApi.Auth.
CorsConfiguration	AWS::Serverless::HttpApi.CorsConfiguration.
DefaultRouteSettings	AWS::Serverless::HttpApi.DefaultRouteSettings.
DefinitionBody	AWS::Serverless::HttpApi.DefinitionBody.
DefinitionUri	AWS::Serverless::HttpApi.DefinitionUri.
Description	AWS::Serverless::HttpApi.Description.
DisableExecuteApiEndpoint	AWS::Serverless::HttpApi.DisableExecuteApiEndpoint.
Domain	AWS::Serverless::HttpApi.Domain.
FailOnWarnings	AWS::Serverless::HttpApi.FailOnWarnings.
RouteSettings	AWS::Serverless::HttpApi.RouteSettings.
StageName	AWS::Serverless::HttpApi.StageName.
StageVariables	AWS::Serverless::HttpApi.StageVariables.
Tags	AWS::Serverless::HttpApi.Tags.

Constructors

CfnHttpApiProps()

public CfnHttpApiProps()

Properties

AccessLogSetting

AWS::Serverless::HttpApi.AccessLogSetting.

public object AccessLogSetting { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Auth

AWS::Serverless::HttpApi.Auth.

public object Auth { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

CorsConfiguration

AWS::Serverless::HttpApi.CorsConfiguration.

public object CorsConfiguration { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

DefaultRouteSettings

AWS::Serverless::HttpApi.DefaultRouteSettings.

public object DefaultRouteSettings { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

DefinitionBody

AWS::Serverless::HttpApi.DefinitionBody.

public object DefinitionBody { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

DefinitionUri

AWS::Serverless::HttpApi.DefinitionUri.

public object DefinitionUri { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Description

AWS::Serverless::HttpApi.Description.

public string Description { get; set; }

Property Value

System.String

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

DisableExecuteApiEndpoint

AWS::Serverless::HttpApi.DisableExecuteApiEndpoint.

public object DisableExecuteApiEndpoint { get; set; }

Property Value

System.Object

Remarks

Link: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-httpapi.html#sam-httpapi-disableexecuteapiendpoint

Domain

AWS::Serverless::HttpApi.Domain.

public object Domain { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

FailOnWarnings

AWS::Serverless::HttpApi.FailOnWarnings.

public object FailOnWarnings { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

RouteSettings

AWS::Serverless::HttpApi.RouteSettings.

public object RouteSettings { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

StageName

AWS::Serverless::HttpApi.StageName.

public string StageName { get; set; }

Property Value

System.String

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

StageVariables

AWS::Serverless::HttpApi.StageVariables.

public object StageVariables { get; set; }

Property Value

System.Object

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Tags

AWS::Serverless::HttpApi.Tags.

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Link: https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi

Implements

ICfnHttpApiProps