Class CfnApiProps
Properties for defining a CfnApi.
Inheritance
System.Object
CfnApiProps
Implements
Namespace: Amazon.CDK.AWS.SAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApiProps : Object, ICfnApiPropsSyntax (vb)
Public Class CfnApiProps
Inherits Object
Implements ICfnApiPropsRemarks
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
| Cfn |
Properties
Constructors
CfnApiProps()
public CfnApiProps()Properties
AccessLogSetting
public object AccessLogSetting { get; set; }Property Value
System.
Remarks
AlwaysDeploy
public object AlwaysDeploy { get; set; }Property Value
System.
Remarks
Auth
public object Auth { get; set; }Property Value
System.
Remarks
BinaryMediaTypes
public string[] BinaryMediaTypes { get; set; }Property Value
System.
Remarks
CacheClusterEnabled
public object CacheClusterEnabled { get; set; }Property Value
System.
Remarks
CacheClusterSize
public string CacheClusterSize { get; set; }Property Value
System.
Remarks
CanarySetting
public object CanarySetting { get; set; }Property Value
System.
Remarks
Cors
public object Cors { get; set; }Property Value
System.
Remarks
DefinitionBody
public object DefinitionBody { get; set; }Property Value
System.
Remarks
DefinitionUri
public object DefinitionUri { get; set; }Property Value
System.
Remarks
Description
public string Description { get; set; }Property Value
System.
Remarks
DisableExecuteApiEndpoint
public object DisableExecuteApiEndpoint { get; set; }Property Value
System.
Remarks
Domain
public object Domain { get; set; }Property Value
System.
Remarks
EndpointConfiguration
public object EndpointConfiguration { get; set; }Property Value
System.
Remarks
GatewayResponses
public object GatewayResponses { get; set; }Property Value
System.
Remarks
MethodSettings
public object MethodSettings { get; set; }Property Value
System.
Remarks
MinimumCompressionSize
public Nullable<double> MinimumCompressionSize { get; set; }Property Value
System.
Remarks
Models
public object Models { get; set; }Property Value
System.
Remarks
Name
public string Name { get; set; }Property Value
System.
Remarks
OpenApiVersion
public string OpenApiVersion { get; set; }Property Value
System.
Remarks
StageName
public string StageName { get; set; }Property Value
System.
Remarks
Tags
public IDictionary<string, string> Tags { get; set; }Property Value
System.
Remarks
TracingEnabled
public object TracingEnabled { get; set; }Property Value
System.
Remarks
Variables
public object Variables { get; set; }Property Value
System.