Class CfnHttpApi
Inherited Members
Namespace: Amazon.CDK.AWS.SAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnHttpApi : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnHttpApi
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html
CloudformationResource: AWS::Serverless::HttpApi
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 cfnHttpApi = new CfnHttpApi(this, "MyCfnHttpApi", 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
CfnHttpApi(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnHttpApi(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnHttpApi(Construct, String, ICfnHttpApiProps) |
Properties
AccessLogSetting | |
Auth | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CorsConfiguration | |
DefaultRouteSettings | |
DefinitionBody | |
DefinitionUri | |
Description | |
DisableExecuteApiEndpoint | |
Domain | |
FailOnWarnings | |
REQUIRED_TRANSFORM | The |
RouteSettings | |
StageName | |
StageVariables | |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnHttpApi(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnHttpApi(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnHttpApi(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnHttpApi(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnHttpApi(Construct, String, ICfnHttpApiProps)
public CfnHttpApi(Construct scope, string id, ICfnHttpApiProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnHttpApiProps
Resource properties.
Properties
AccessLogSetting
public virtual object AccessLogSetting { get; set; }
Property Value
System.Object
Auth
public virtual object Auth { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CorsConfiguration
public virtual object CorsConfiguration { get; set; }
Property Value
System.Object
DefaultRouteSettings
public virtual object DefaultRouteSettings { get; set; }
Property Value
System.Object
DefinitionBody
public virtual object DefinitionBody { get; set; }
Property Value
System.Object
DefinitionUri
public virtual object DefinitionUri { get; set; }
Property Value
System.Object
Description
public virtual string Description { get; set; }
Property Value
System.String
DisableExecuteApiEndpoint
public virtual object DisableExecuteApiEndpoint { get; set; }
Property Value
System.Object
Domain
public virtual object Domain { get; set; }
Property Value
System.Object
FailOnWarnings
public virtual object FailOnWarnings { get; set; }
Property Value
System.Object
REQUIRED_TRANSFORM
The Transform
a template must use in order to use this resource.
public static string REQUIRED_TRANSFORM { get; }
Property Value
System.String
RouteSettings
public virtual object RouteSettings { get; set; }
Property Value
System.Object
StageName
public virtual string StageName { get; set; }
Property Value
System.String
StageVariables
public virtual object StageVariables { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>