Documentation
¶
Index ¶
- func AccessLogField_ContextAccountId() *string
- func AccessLogField_ContextApiId() *string
- func AccessLogField_ContextAuthorizer(property *string) *string
- func AccessLogField_ContextAuthorizerClaims(property *string) *string
- func AccessLogField_ContextAuthorizerIntegrationLatency() *string
- func AccessLogField_ContextAuthorizerPrincipalId() *string
- func AccessLogField_ContextAwsEndpointRequestId() *string
- func AccessLogField_ContextDomainName() *string
- func AccessLogField_ContextDomainPrefix() *string
- func AccessLogField_ContextErrorMessage() *string
- func AccessLogField_ContextErrorMessageString() *string
- func AccessLogField_ContextErrorResponseType() *string
- func AccessLogField_ContextErrorValidationErrorString() *string
- func AccessLogField_ContextExtendedRequestId() *string
- func AccessLogField_ContextHttpMethod() *string
- func AccessLogField_ContextIdentityAccountId() *string
- func AccessLogField_ContextIdentityApiKey() *string
- func AccessLogField_ContextIdentityApiKeyId() *string
- func AccessLogField_ContextIdentityCaller() *string
- func AccessLogField_ContextIdentityCognitoAuthenticationProvider() *string
- func AccessLogField_ContextIdentityCognitoAuthenticationType() *string
- func AccessLogField_ContextIdentityCognitoIdentityId() *string
- func AccessLogField_ContextIdentityCognitoIdentityPoolId() *string
- func AccessLogField_ContextIdentityPrincipalOrgId() *string
- func AccessLogField_ContextIdentitySourceIp() *string
- func AccessLogField_ContextIdentityUser() *string
- func AccessLogField_ContextIdentityUserAgent() *string
- func AccessLogField_ContextIdentityUserArn() *string
- func AccessLogField_ContextIntegrationLatency() *string
- func AccessLogField_ContextIntegrationStatus() *string
- func AccessLogField_ContextPath() *string
- func AccessLogField_ContextProtocol() *string
- func AccessLogField_ContextRequestId() *string
- func AccessLogField_ContextRequestOverrideHeader(headerName *string) *string
- func AccessLogField_ContextRequestOverridePath(pathName *string) *string
- func AccessLogField_ContextRequestOverrideQuerystring(querystringName *string) *string
- func AccessLogField_ContextRequestTime() *string
- func AccessLogField_ContextRequestTimeEpoch() *string
- func AccessLogField_ContextResourceId() *string
- func AccessLogField_ContextResourcePath() *string
- func AccessLogField_ContextResponseLatency() *string
- func AccessLogField_ContextResponseLength() *string
- func AccessLogField_ContextResponseOverrideHeader(headerName *string) *string
- func AccessLogField_ContextResponseOverrideStatus() *string
- func AccessLogField_ContextStage() *string
- func AccessLogField_ContextStatus() *string
- func AccessLogField_ContextWafResponseCode() *string
- func AccessLogField_ContextWebaclArn() *string
- func AccessLogField_ContextXrayTraceId() *string
- func ApiKey_IsConstruct(x interface{}) *bool
- func ApiKey_IsResource(construct constructs.IConstruct) *bool
- func Authorizer_IsAuthorizer(x interface{}) *bool
- func Authorizer_IsConstruct(x interface{}) *bool
- func Authorizer_IsResource(construct constructs.IConstruct) *bool
- func BasePathMapping_IsConstruct(x interface{}) *bool
- func BasePathMapping_IsResource(construct constructs.IConstruct) *bool
- func CfnAccount_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAccount_IsCfnElement(x interface{}) *bool
- func CfnAccount_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAccount_IsConstruct(x interface{}) *bool
- func CfnApiKey_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApiKey_IsCfnElement(x interface{}) *bool
- func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApiKey_IsConstruct(x interface{}) *bool
- func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAuthorizer_IsCfnElement(x interface{}) *bool
- func CfnAuthorizer_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAuthorizer_IsConstruct(x interface{}) *bool
- func CfnBasePathMapping_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBasePathMapping_IsCfnElement(x interface{}) *bool
- func CfnBasePathMapping_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnBasePathMapping_IsConstruct(x interface{}) *bool
- func CfnClientCertificate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClientCertificate_IsCfnElement(x interface{}) *bool
- func CfnClientCertificate_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnClientCertificate_IsConstruct(x interface{}) *bool
- func CfnDeployment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDeployment_IsCfnElement(x interface{}) *bool
- func CfnDeployment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDeployment_IsConstruct(x interface{}) *bool
- func CfnDocumentationPart_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDocumentationPart_IsCfnElement(x interface{}) *bool
- func CfnDocumentationPart_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDocumentationPart_IsConstruct(x interface{}) *bool
- func CfnDocumentationVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDocumentationVersion_IsCfnElement(x interface{}) *bool
- func CfnDocumentationVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDocumentationVersion_IsConstruct(x interface{}) *bool
- func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomainName_IsCfnElement(x interface{}) *bool
- func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDomainName_IsConstruct(x interface{}) *bool
- func CfnGatewayResponse_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGatewayResponse_IsCfnElement(x interface{}) *bool
- func CfnGatewayResponse_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGatewayResponse_IsConstruct(x interface{}) *bool
- func CfnMethod_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMethod_IsCfnElement(x interface{}) *bool
- func CfnMethod_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMethod_IsConstruct(x interface{}) *bool
- func CfnModel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModel_IsCfnElement(x interface{}) *bool
- func CfnModel_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnModel_IsConstruct(x interface{}) *bool
- func CfnRequestValidator_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRequestValidator_IsCfnElement(x interface{}) *bool
- func CfnRequestValidator_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRequestValidator_IsConstruct(x interface{}) *bool
- func CfnResource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResource_IsCfnElement(x interface{}) *bool
- func CfnResource_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResource_IsConstruct(x interface{}) *bool
- func CfnRestApi_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRestApi_IsCfnElement(x interface{}) *bool
- func CfnRestApi_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRestApi_IsConstruct(x interface{}) *bool
- func CfnStage_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStage_IsCfnElement(x interface{}) *bool
- func CfnStage_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnStage_IsConstruct(x interface{}) *bool
- func CfnUsagePlanKey_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUsagePlanKey_IsCfnElement(x interface{}) *bool
- func CfnUsagePlanKey_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnUsagePlanKey_IsConstruct(x interface{}) *bool
- func CfnUsagePlan_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUsagePlan_IsCfnElement(x interface{}) *bool
- func CfnUsagePlan_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnUsagePlan_IsConstruct(x interface{}) *bool
- func CfnVpcLink_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVpcLink_IsCfnElement(x interface{}) *bool
- func CfnVpcLink_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVpcLink_IsConstruct(x interface{}) *bool
- func CognitoUserPoolsAuthorizer_IsAuthorizer(x interface{}) *bool
- func CognitoUserPoolsAuthorizer_IsConstruct(x interface{}) *bool
- func CognitoUserPoolsAuthorizer_IsResource(construct constructs.IConstruct) *bool
- func Cors_ALL_METHODS() *[]*string
- func Cors_ALL_ORIGINS() *[]*string
- func Cors_DEFAULT_HEADERS() *[]*string
- func Deployment_IsConstruct(x interface{}) *bool
- func Deployment_IsResource(construct constructs.IConstruct) *bool
- func DomainName_IsConstruct(x interface{}) *bool
- func DomainName_IsResource(construct constructs.IConstruct) *bool
- func GatewayResponse_IsConstruct(x interface{}) *bool
- func GatewayResponse_IsResource(construct constructs.IConstruct) *bool
- func IdentitySource_Context(context *string) *string
- func IdentitySource_Header(headerName *string) *string
- func IdentitySource_QueryString(queryString *string) *string
- func IdentitySource_StageVariable(stageVariable *string) *string
- func LambdaRestApi_IsConstruct(x interface{}) *bool
- func LambdaRestApi_IsResource(construct constructs.IConstruct) *bool
- func Method_IsConstruct(x interface{}) *bool
- func Method_IsResource(construct constructs.IConstruct) *bool
- func Model_IsConstruct(x interface{}) *bool
- func Model_IsResource(construct constructs.IConstruct) *bool
- func NewAccessLogField_Override(a AccessLogField)
- func NewApiDefinition_Override(a ApiDefinition)
- func NewApiKey_Override(a ApiKey, scope constructs.Construct, id *string, props *ApiKeyProps)
- func NewAssetApiDefinition_Override(a AssetApiDefinition, path *string, options *awss3assets.AssetOptions)
- func NewAuthorizer_Override(a Authorizer, scope constructs.Construct, id *string, ...)
- func NewAwsIntegration_Override(a AwsIntegration, props *AwsIntegrationProps)
- func NewBasePathMapping_Override(b BasePathMapping, scope constructs.Construct, id *string, ...)
- func NewCfnAccount_Override(c CfnAccount, scope constructs.Construct, id *string, props *CfnAccountProps)
- func NewCfnApiKey_Override(c CfnApiKey, scope constructs.Construct, id *string, props *CfnApiKeyProps)
- func NewCfnAuthorizer_Override(c CfnAuthorizer, scope constructs.Construct, id *string, ...)
- func NewCfnBasePathMapping_Override(c CfnBasePathMapping, scope constructs.Construct, id *string, ...)
- func NewCfnClientCertificate_Override(c CfnClientCertificate, scope constructs.Construct, id *string, ...)
- func NewCfnDeployment_Override(c CfnDeployment, scope constructs.Construct, id *string, ...)
- func NewCfnDocumentationPart_Override(c CfnDocumentationPart, scope constructs.Construct, id *string, ...)
- func NewCfnDocumentationVersion_Override(c CfnDocumentationVersion, scope constructs.Construct, id *string, ...)
- func NewCfnDomainName_Override(c CfnDomainName, scope constructs.Construct, id *string, ...)
- func NewCfnGatewayResponse_Override(c CfnGatewayResponse, scope constructs.Construct, id *string, ...)
- func NewCfnMethod_Override(c CfnMethod, scope constructs.Construct, id *string, props *CfnMethodProps)
- func NewCfnModel_Override(c CfnModel, scope constructs.Construct, id *string, props *CfnModelProps)
- func NewCfnRequestValidator_Override(c CfnRequestValidator, scope constructs.Construct, id *string, ...)
- func NewCfnResource_Override(c CfnResource, scope constructs.Construct, id *string, props *CfnResourceProps)
- func NewCfnRestApi_Override(c CfnRestApi, scope constructs.Construct, id *string, props *CfnRestApiProps)
- func NewCfnStage_Override(c CfnStage, scope constructs.Construct, id *string, props *CfnStageProps)
- func NewCfnUsagePlanKey_Override(c CfnUsagePlanKey, scope constructs.Construct, id *string, ...)
- func NewCfnUsagePlan_Override(c CfnUsagePlan, scope constructs.Construct, id *string, ...)
- func NewCfnVpcLink_Override(c CfnVpcLink, scope constructs.Construct, id *string, props *CfnVpcLinkProps)
- func NewCognitoUserPoolsAuthorizer_Override(c CognitoUserPoolsAuthorizer, scope constructs.Construct, id *string, ...)
- func NewDeployment_Override(d Deployment, scope constructs.Construct, id *string, props *DeploymentProps)
- func NewDomainName_Override(d DomainName, scope constructs.Construct, id *string, props *DomainNameProps)
- func NewGatewayResponse_Override(g GatewayResponse, scope constructs.Construct, id *string, ...)
- func NewHttpIntegration_Override(h HttpIntegration, url *string, props *HttpIntegrationProps)
- func NewIdentitySource_Override(i IdentitySource)
- func NewInlineApiDefinition_Override(i InlineApiDefinition, definition interface{})
- func NewIntegration_Override(i Integration, props *IntegrationProps)
- func NewLambdaIntegration_Override(l LambdaIntegration, handler awslambda.IFunction, ...)
- func NewLambdaRestApi_Override(l LambdaRestApi, scope constructs.Construct, id *string, ...)
- func NewLogGroupLogDestination_Override(l LogGroupLogDestination, logGroup awslogs.ILogGroup)
- func NewMethod_Override(m Method, scope constructs.Construct, id *string, props *MethodProps)
- func NewMockIntegration_Override(m MockIntegration, options *IntegrationOptions)
- func NewModel_Override(m Model, scope constructs.Construct, id *string, props *ModelProps)
- func NewProxyResource_Override(p ProxyResource, scope constructs.Construct, id *string, ...)
- func NewRateLimitedApiKey_Override(r RateLimitedApiKey, scope constructs.Construct, id *string, ...)
- func NewRequestAuthorizer_Override(r RequestAuthorizer, scope constructs.Construct, id *string, ...)
- func NewRequestValidator_Override(r RequestValidator, scope constructs.Construct, id *string, ...)
- func NewResourceBase_Override(r ResourceBase, scope constructs.Construct, id *string)
- func NewResource_Override(r Resource, scope constructs.Construct, id *string, props *ResourceProps)
- func NewRestApiBase_Override(r RestApiBase, scope constructs.Construct, id *string, props *RestApiBaseProps)
- func NewRestApi_Override(r RestApi, scope constructs.Construct, id *string, props *RestApiProps)
- func NewS3ApiDefinition_Override(s S3ApiDefinition, bucket awss3.IBucket, key *string, objectVersion *string)
- func NewSpecRestApi_Override(s SpecRestApi, scope constructs.Construct, id *string, props *SpecRestApiProps)
- func NewStage_Override(s Stage, scope constructs.Construct, id *string, props *StageProps)
- func NewTokenAuthorizer_Override(t TokenAuthorizer, scope constructs.Construct, id *string, ...)
- func NewUsagePlan_Override(u UsagePlan, scope constructs.Construct, id *string, props *UsagePlanProps)
- func NewVpcLink_Override(v VpcLink, scope constructs.Construct, id *string, props *VpcLinkProps)
- func ProxyResource_IsConstruct(x interface{}) *bool
- func ProxyResource_IsResource(construct constructs.IConstruct) *bool
- func RateLimitedApiKey_IsConstruct(x interface{}) *bool
- func RateLimitedApiKey_IsResource(construct constructs.IConstruct) *bool
- func RequestAuthorizer_IsAuthorizer(x interface{}) *bool
- func RequestAuthorizer_IsConstruct(x interface{}) *bool
- func RequestAuthorizer_IsResource(construct constructs.IConstruct) *bool
- func RequestValidator_IsConstruct(x interface{}) *bool
- func RequestValidator_IsResource(construct constructs.IConstruct) *bool
- func ResourceBase_IsConstruct(x interface{}) *bool
- func ResourceBase_IsResource(construct constructs.IConstruct) *bool
- func Resource_IsConstruct(x interface{}) *bool
- func Resource_IsResource(construct constructs.IConstruct) *bool
- func RestApiBase_IsConstruct(x interface{}) *bool
- func RestApiBase_IsResource(construct constructs.IConstruct) *bool
- func RestApi_IsConstruct(x interface{}) *bool
- func RestApi_IsResource(construct constructs.IConstruct) *bool
- func SpecRestApi_IsConstruct(x interface{}) *bool
- func SpecRestApi_IsResource(construct constructs.IConstruct) *bool
- func Stage_IsConstruct(x interface{}) *bool
- func Stage_IsResource(construct constructs.IConstruct) *bool
- func TokenAuthorizer_IsAuthorizer(x interface{}) *bool
- func TokenAuthorizer_IsConstruct(x interface{}) *bool
- func TokenAuthorizer_IsResource(construct constructs.IConstruct) *bool
- func UsagePlan_IsConstruct(x interface{}) *bool
- func UsagePlan_IsResource(construct constructs.IConstruct) *bool
- func VpcLink_IsConstruct(x interface{}) *bool
- func VpcLink_IsResource(construct constructs.IConstruct) *bool
- type AccessLogDestinationConfig
- type AccessLogField
- type AccessLogFormat
- type AddApiKeyOptions
- type ApiDefinition
- type ApiDefinitionConfig
- type ApiDefinitionS3Location
- type ApiKey
- type ApiKeyOptions
- type ApiKeyProps
- type ApiKeySourceType
- type AssetApiDefinition
- func ApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
- func AssetApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
- func InlineApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
- func NewAssetApiDefinition(path *string, options *awss3assets.AssetOptions) AssetApiDefinition
- func S3ApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
- type AuthorizationType
- type Authorizer
- type AwsIntegration
- type AwsIntegrationProps
- type BasePathMapping
- type BasePathMappingOptions
- type BasePathMappingProps
- type CfnAccount
- type CfnAccountProps
- type CfnApiKey
- type CfnApiKeyProps
- type CfnApiKey_StageKeyProperty
- type CfnAuthorizer
- type CfnAuthorizerProps
- type CfnBasePathMapping
- type CfnBasePathMappingProps
- type CfnClientCertificate
- type CfnClientCertificateProps
- type CfnDeployment
- type CfnDeploymentProps
- type CfnDeployment_AccessLogSettingProperty
- type CfnDeployment_CanarySettingProperty
- type CfnDeployment_DeploymentCanarySettingsProperty
- type CfnDeployment_MethodSettingProperty
- type CfnDeployment_StageDescriptionProperty
- type CfnDocumentationPart
- type CfnDocumentationPartProps
- type CfnDocumentationPart_LocationProperty
- type CfnDocumentationVersion
- type CfnDocumentationVersionProps
- type CfnDomainName
- type CfnDomainNameProps
- type CfnDomainName_EndpointConfigurationProperty
- type CfnDomainName_MutualTlsAuthenticationProperty
- type CfnGatewayResponse
- type CfnGatewayResponseProps
- type CfnMethod
- type CfnMethodProps
- type CfnMethod_IntegrationProperty
- type CfnMethod_IntegrationResponseProperty
- type CfnMethod_MethodResponseProperty
- type CfnModel
- type CfnModelProps
- type CfnRequestValidator
- type CfnRequestValidatorProps
- type CfnResource
- type CfnResourceProps
- type CfnRestApi
- type CfnRestApiProps
- type CfnRestApi_EndpointConfigurationProperty
- type CfnRestApi_S3LocationProperty
- type CfnStage
- type CfnStageProps
- type CfnStage_AccessLogSettingProperty
- type CfnStage_CanarySettingProperty
- type CfnStage_MethodSettingProperty
- type CfnUsagePlan
- type CfnUsagePlanKey
- type CfnUsagePlanKeyProps
- type CfnUsagePlanProps
- type CfnUsagePlan_ApiStageProperty
- type CfnUsagePlan_QuotaSettingsProperty
- type CfnUsagePlan_ThrottleSettingsProperty
- type CfnVpcLink
- type CfnVpcLinkProps
- type CognitoUserPoolsAuthorizer
- type CognitoUserPoolsAuthorizerProps
- type ConnectionType
- type ContentHandling
- type Cors
- type CorsOptions
- type Deployment
- type DeploymentProps
- type DomainName
- type DomainNameAttributes
- type DomainNameOptions
- type DomainNameProps
- type EndpointConfiguration
- type EndpointType
- type GatewayResponse
- type GatewayResponseOptions
- type GatewayResponseProps
- type HttpIntegration
- type HttpIntegrationProps
- type IAccessLogDestination
- type IApiKey
- type IAuthorizer
- type IDomainName
- type IGatewayResponse
- type IModel
- type IRequestValidator
- type IResource
- type IRestApi
- func LambdaRestApi_FromRestApiAttributes(scope constructs.Construct, id *string, attrs *RestApiAttributes) IRestApi
- func LambdaRestApi_FromRestApiId(scope constructs.Construct, id *string, restApiId *string) IRestApi
- func RestApi_FromRestApiAttributes(scope constructs.Construct, id *string, attrs *RestApiAttributes) IRestApi
- func RestApi_FromRestApiId(scope constructs.Construct, id *string, restApiId *string) IRestApi
- type IStage
- type IUsagePlan
- type IVpcLink
- type IdentitySource
- type InlineApiDefinition
- func ApiDefinition_FromInline(definition interface{}) InlineApiDefinition
- func AssetApiDefinition_FromInline(definition interface{}) InlineApiDefinition
- func InlineApiDefinition_FromInline(definition interface{}) InlineApiDefinition
- func NewInlineApiDefinition(definition interface{}) InlineApiDefinition
- func S3ApiDefinition_FromInline(definition interface{}) InlineApiDefinition
- type Integration
- type IntegrationConfig
- type IntegrationOptions
- type IntegrationProps
- type IntegrationResponse
- type IntegrationType
- type JsonSchema
- type JsonSchemaType
- type JsonSchemaVersion
- type JsonWithStandardFieldProps
- type LambdaAuthorizerProps
- type LambdaIntegration
- type LambdaIntegrationOptions
- type LambdaRestApi
- type LambdaRestApiProps
- type LogGroupLogDestination
- type MTLSConfig
- type Method
- type MethodDeploymentOptions
- type MethodLoggingLevel
- type MethodOptions
- type MethodProps
- type MethodResponse
- type MockIntegration
- type Model
- type ModelOptions
- type ModelProps
- type PassthroughBehavior
- type Period
- type ProxyResource
- type ProxyResourceOptions
- type ProxyResourceProps
- type QuotaSettings
- type RateLimitedApiKey
- type RateLimitedApiKeyProps
- type RequestAuthorizer
- type RequestAuthorizerProps
- type RequestValidator
- type RequestValidatorOptions
- type RequestValidatorProps
- type Resource
- type ResourceAttributes
- type ResourceBase
- type ResourceOptions
- type ResourceProps
- type ResponseType
- func ResponseType_ACCESS_DENIED() ResponseType
- func ResponseType_API_CONFIGURATION_ERROR() ResponseType
- func ResponseType_AUTHORIZER_CONFIGURATION_ERROR() ResponseType
- func ResponseType_AUTHORIZER_FAILURE() ResponseType
- func ResponseType_BAD_REQUEST_BODY() ResponseType
- func ResponseType_BAD_REQUEST_PARAMETERS() ResponseType
- func ResponseType_DEFAULT_4XX() ResponseType
- func ResponseType_DEFAULT_5XX() ResponseType
- func ResponseType_EXPIRED_TOKEN() ResponseType
- func ResponseType_INTEGRATION_FAILURE() ResponseType
- func ResponseType_INTEGRATION_TIMEOUT() ResponseType
- func ResponseType_INVALID_API_KEY() ResponseType
- func ResponseType_INVALID_SIGNATURE() ResponseType
- func ResponseType_MISSING_AUTHENTICATION_TOKEN() ResponseType
- func ResponseType_Of(type_ *string) ResponseType
- func ResponseType_QUOTA_EXCEEDED() ResponseType
- func ResponseType_REQUEST_TOO_LARGE() ResponseType
- func ResponseType_RESOURCE_NOT_FOUND() ResponseType
- func ResponseType_THROTTLED() ResponseType
- func ResponseType_UNAUTHORIZED() ResponseType
- func ResponseType_UNSUPPORTED_MEDIA_TYPE() ResponseType
- func ResponseType_WAF_FILTERED() ResponseType
- type RestApi
- type RestApiAttributes
- type RestApiBase
- type RestApiBaseProps
- type RestApiProps
- type S3ApiDefinition
- func ApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
- func AssetApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
- func InlineApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
- func NewS3ApiDefinition(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
- func S3ApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
- type SecurityPolicy
- type SpecRestApi
- type SpecRestApiProps
- type Stage
- type StageOptions
- type StageProps
- type ThrottleSettings
- type ThrottlingPerMethod
- type TokenAuthorizer
- type TokenAuthorizerProps
- type UsagePlan
- type UsagePlanPerApiStage
- type UsagePlanProps
- type VpcLink
- type VpcLinkProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AccessLogField_ContextAccountId ¶
func AccessLogField_ContextAccountId() *string
The API owner's AWS account ID.
func AccessLogField_ContextApiId ¶
func AccessLogField_ContextApiId() *string
The identifier API Gateway assigns to your API.
func AccessLogField_ContextAuthorizer ¶
The stringified value of the specified key-value pair of the `context` map returned from an API Gateway Lambda authorizer function. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
func AccessLogField_ContextAuthorizerClaims ¶
A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
func AccessLogField_ContextAuthorizerIntegrationLatency ¶
func AccessLogField_ContextAuthorizerIntegrationLatency() *string
The authorizer latency in ms.
func AccessLogField_ContextAuthorizerPrincipalId ¶
func AccessLogField_ContextAuthorizerPrincipalId() *string
The principal user identification associated with the token sent by the client and returned from an API Gateway Lambda authorizer (formerly known as a custom authorizer). See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
func AccessLogField_ContextAwsEndpointRequestId ¶
func AccessLogField_ContextAwsEndpointRequestId() *string
The AWS endpoint's request ID.
func AccessLogField_ContextDomainName ¶
func AccessLogField_ContextDomainName() *string
The full domain name used to invoke the API.
This should be the same as the incoming `Host` header.
func AccessLogField_ContextDomainPrefix ¶
func AccessLogField_ContextDomainPrefix() *string
The first label of the `$context.domainName`. This is often used as a caller/customer identifier.
func AccessLogField_ContextErrorMessage ¶
func AccessLogField_ContextErrorMessage() *string
A string containing an API Gateway error message.
func AccessLogField_ContextErrorMessageString ¶
func AccessLogField_ContextErrorMessageString() *string
The quoted value of $context.error.message, namely "$context.error.message".
func AccessLogField_ContextErrorResponseType ¶
func AccessLogField_ContextErrorResponseType() *string
A type of GatewayResponse.
This variable can only be used for simple variable substitution in a GatewayResponse body-mapping template, which is not processed by the Velocity Template Language engine, and in access logging. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
func AccessLogField_ContextErrorValidationErrorString ¶
func AccessLogField_ContextErrorValidationErrorString() *string
A string containing a detailed validation error message.
func AccessLogField_ContextExtendedRequestId ¶
func AccessLogField_ContextExtendedRequestId() *string
The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.
func AccessLogField_ContextHttpMethod ¶
func AccessLogField_ContextHttpMethod() *string
The HTTP method used.
Valid values include: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, and `PUT`.
func AccessLogField_ContextIdentityAccountId ¶
func AccessLogField_ContextIdentityAccountId() *string
The AWS account ID associated with the request.
func AccessLogField_ContextIdentityApiKey ¶
func AccessLogField_ContextIdentityApiKey() *string
For API methods that require an API key, this variable is the API key associated with the method request.
For methods that don't require an API key, this variable is See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
func AccessLogField_ContextIdentityApiKeyId ¶
func AccessLogField_ContextIdentityApiKeyId() *string
The API key ID associated with an API request that requires an API key.
func AccessLogField_ContextIdentityCaller ¶
func AccessLogField_ContextIdentityCaller() *string
The principal identifier of the caller making the request.
func AccessLogField_ContextIdentityCognitoAuthenticationProvider ¶
func AccessLogField_ContextIdentityCognitoAuthenticationProvider() *string
The Amazon Cognito authentication provider used by the caller making the request.
Available only if the request was signed with Amazon Cognito credentials. See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html
func AccessLogField_ContextIdentityCognitoAuthenticationType ¶
func AccessLogField_ContextIdentityCognitoAuthenticationType() *string
The Amazon Cognito authentication type of the caller making the request.
Available only if the request was signed with Amazon Cognito credentials.
func AccessLogField_ContextIdentityCognitoIdentityId ¶
func AccessLogField_ContextIdentityCognitoIdentityId() *string
The Amazon Cognito identity ID of the caller making the request.
Available only if the request was signed with Amazon Cognito credentials.
func AccessLogField_ContextIdentityCognitoIdentityPoolId ¶
func AccessLogField_ContextIdentityCognitoIdentityPoolId() *string
The Amazon Cognito identity pool ID of the caller making the request.
Available only if the request was signed with Amazon Cognito credentials.
func AccessLogField_ContextIdentityPrincipalOrgId ¶
func AccessLogField_ContextIdentityPrincipalOrgId() *string
The AWS organization ID.
func AccessLogField_ContextIdentitySourceIp ¶
func AccessLogField_ContextIdentitySourceIp() *string
The source IP address of the TCP connection making the request to API Gateway.
Warning: You should not trust this value if there is any chance that the `X-Forwarded-For` header could be forged.
func AccessLogField_ContextIdentityUser ¶
func AccessLogField_ContextIdentityUser() *string
The principal identifier of the user making the request.
Used in Lambda authorizers. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html
func AccessLogField_ContextIdentityUserAgent ¶
func AccessLogField_ContextIdentityUserAgent() *string
The User-Agent header of the API caller.
func AccessLogField_ContextIdentityUserArn ¶
func AccessLogField_ContextIdentityUserArn() *string
The Amazon Resource Name (ARN) of the effective user identified after authentication. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html
func AccessLogField_ContextIntegrationLatency ¶
func AccessLogField_ContextIntegrationLatency() *string
The integration latency in ms.
func AccessLogField_ContextIntegrationStatus ¶
func AccessLogField_ContextIntegrationStatus() *string
For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.
func AccessLogField_ContextPath ¶
func AccessLogField_ContextPath() *string
The request path.
For example, for a non-proxy request URL of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child, this value is /{stage}/root/child.
func AccessLogField_ContextProtocol ¶
func AccessLogField_ContextProtocol() *string
The request protocol, for example, HTTP/1.1.
func AccessLogField_ContextRequestId ¶
func AccessLogField_ContextRequestId() *string
The ID that API Gateway assigns to the API request.
func AccessLogField_ContextRequestOverrideHeader ¶
The request header override.
If this parameter is defined, it contains the headers to be used instead of the HTTP Headers that are defined in the Integration Request pane. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
func AccessLogField_ContextRequestOverridePath ¶
The request path override.
If this parameter is defined, it contains the request path to be used instead of the URL Path Parameters that are defined in the Integration Request pane. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
func AccessLogField_ContextRequestOverrideQuerystring ¶
The request query string override.
If this parameter is defined, it contains the request query strings to be used instead of the URL Query String Parameters that are defined in the Integration Request pane.
func AccessLogField_ContextRequestTime ¶
func AccessLogField_ContextRequestTime() *string
The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
func AccessLogField_ContextRequestTimeEpoch ¶
func AccessLogField_ContextRequestTimeEpoch() *string
The Epoch-formatted request time.
func AccessLogField_ContextResourceId ¶
func AccessLogField_ContextResourceId() *string
The identifier that API Gateway assigns to your resource.
func AccessLogField_ContextResourcePath ¶
func AccessLogField_ContextResourcePath() *string
The path to your resource.
For example, for the non-proxy request URI of `https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child`, The $context.resourcePath value is `/root/child`. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-step-by-step.html
func AccessLogField_ContextResponseLatency ¶
func AccessLogField_ContextResponseLatency() *string
The response latency in ms.
func AccessLogField_ContextResponseLength ¶
func AccessLogField_ContextResponseLength() *string
The response payload length.
func AccessLogField_ContextResponseOverrideHeader ¶
The response header override.
If this parameter is defined, it contains the header to be returned instead of the Response header that is defined as the Default mapping in the Integration Response pane. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
func AccessLogField_ContextResponseOverrideStatus ¶
func AccessLogField_ContextResponseOverrideStatus() *string
The response status code override.
If this parameter is defined, it contains the status code to be returned instead of the Method response status that is defined as the Default mapping in the Integration Response pane. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
func AccessLogField_ContextStage ¶
func AccessLogField_ContextStage() *string
The deployment stage of the API request (for example, `Beta` or `Prod`).
func AccessLogField_ContextStatus ¶
func AccessLogField_ContextStatus() *string
The method response status.
func AccessLogField_ContextWafResponseCode ¶
func AccessLogField_ContextWafResponseCode() *string
The response received from AWS WAF: `WAF_ALLOW` or `WAF_BLOCK`.
Will not be set if the stage is not associated with a web ACL. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html
func AccessLogField_ContextWebaclArn ¶
func AccessLogField_ContextWebaclArn() *string
The complete ARN of the web ACL that is used to decide whether to allow or block the request.
Will not be set if the stage is not associated with a web ACL. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html
func AccessLogField_ContextXrayTraceId ¶
func AccessLogField_ContextXrayTraceId() *string
The trace ID for the X-Ray trace. See: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.html
func ApiKey_IsConstruct ¶
func ApiKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ApiKey_IsResource ¶
func ApiKey_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Authorizer_IsAuthorizer ¶
func Authorizer_IsAuthorizer(x interface{}) *bool
Return whether the given object is an Authorizer.
func Authorizer_IsConstruct ¶
func Authorizer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Authorizer_IsResource ¶
func Authorizer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func BasePathMapping_IsConstruct ¶
func BasePathMapping_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func BasePathMapping_IsResource ¶
func BasePathMapping_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func CfnAccount_CFN_RESOURCE_TYPE_NAME ¶
func CfnAccount_CFN_RESOURCE_TYPE_NAME() *string
func CfnAccount_IsCfnElement ¶
func CfnAccount_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnAccount_IsCfnResource ¶
func CfnAccount_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnAccount_IsConstruct ¶
func CfnAccount_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnApiKey_CFN_RESOURCE_TYPE_NAME ¶
func CfnApiKey_CFN_RESOURCE_TYPE_NAME() *string
func CfnApiKey_IsCfnElement ¶
func CfnApiKey_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApiKey_IsCfnResource ¶
func CfnApiKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApiKey_IsConstruct ¶
func CfnApiKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME ¶
func CfnAuthorizer_CFN_RESOURCE_TYPE_NAME() *string
func CfnAuthorizer_IsCfnElement ¶
func CfnAuthorizer_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnAuthorizer_IsCfnResource ¶
func CfnAuthorizer_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnAuthorizer_IsConstruct ¶
func CfnAuthorizer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnBasePathMapping_CFN_RESOURCE_TYPE_NAME ¶
func CfnBasePathMapping_CFN_RESOURCE_TYPE_NAME() *string
func CfnBasePathMapping_IsCfnElement ¶
func CfnBasePathMapping_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBasePathMapping_IsCfnResource ¶
func CfnBasePathMapping_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnBasePathMapping_IsConstruct ¶
func CfnBasePathMapping_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnClientCertificate_CFN_RESOURCE_TYPE_NAME ¶
func CfnClientCertificate_CFN_RESOURCE_TYPE_NAME() *string
func CfnClientCertificate_IsCfnElement ¶
func CfnClientCertificate_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnClientCertificate_IsCfnResource ¶
func CfnClientCertificate_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnClientCertificate_IsConstruct ¶
func CfnClientCertificate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDeployment_CFN_RESOURCE_TYPE_NAME ¶
func CfnDeployment_CFN_RESOURCE_TYPE_NAME() *string
func CfnDeployment_IsCfnElement ¶
func CfnDeployment_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDeployment_IsCfnResource ¶
func CfnDeployment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDeployment_IsConstruct ¶
func CfnDeployment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDocumentationPart_CFN_RESOURCE_TYPE_NAME ¶
func CfnDocumentationPart_CFN_RESOURCE_TYPE_NAME() *string
func CfnDocumentationPart_IsCfnElement ¶
func CfnDocumentationPart_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDocumentationPart_IsCfnResource ¶
func CfnDocumentationPart_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDocumentationPart_IsConstruct ¶
func CfnDocumentationPart_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDocumentationVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnDocumentationVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnDocumentationVersion_IsCfnElement ¶
func CfnDocumentationVersion_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDocumentationVersion_IsCfnResource ¶
func CfnDocumentationVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDocumentationVersion_IsConstruct ¶
func CfnDocumentationVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnDomainName_CFN_RESOURCE_TYPE_NAME ¶
func CfnDomainName_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainName_IsCfnElement ¶
func CfnDomainName_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomainName_IsCfnResource ¶
func CfnDomainName_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDomainName_IsConstruct ¶
func CfnDomainName_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnGatewayResponse_CFN_RESOURCE_TYPE_NAME ¶
func CfnGatewayResponse_CFN_RESOURCE_TYPE_NAME() *string
func CfnGatewayResponse_IsCfnElement ¶
func CfnGatewayResponse_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGatewayResponse_IsCfnResource ¶
func CfnGatewayResponse_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGatewayResponse_IsConstruct ¶
func CfnGatewayResponse_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnMethod_CFN_RESOURCE_TYPE_NAME ¶
func CfnMethod_CFN_RESOURCE_TYPE_NAME() *string
func CfnMethod_IsCfnElement ¶
func CfnMethod_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMethod_IsCfnResource ¶
func CfnMethod_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnMethod_IsConstruct ¶
func CfnMethod_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnModel_CFN_RESOURCE_TYPE_NAME ¶
func CfnModel_CFN_RESOURCE_TYPE_NAME() *string
func CfnModel_IsCfnElement ¶
func CfnModel_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnModel_IsCfnResource ¶
func CfnModel_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnModel_IsConstruct ¶
func CfnModel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnRequestValidator_CFN_RESOURCE_TYPE_NAME ¶
func CfnRequestValidator_CFN_RESOURCE_TYPE_NAME() *string
func CfnRequestValidator_IsCfnElement ¶
func CfnRequestValidator_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRequestValidator_IsCfnResource ¶
func CfnRequestValidator_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnRequestValidator_IsConstruct ¶
func CfnRequestValidator_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnResource_CFN_RESOURCE_TYPE_NAME ¶
func CfnResource_CFN_RESOURCE_TYPE_NAME() *string
func CfnResource_IsCfnElement ¶
func CfnResource_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnResource_IsCfnResource ¶
func CfnResource_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnResource_IsConstruct ¶
func CfnResource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnRestApi_CFN_RESOURCE_TYPE_NAME ¶
func CfnRestApi_CFN_RESOURCE_TYPE_NAME() *string
func CfnRestApi_IsCfnElement ¶
func CfnRestApi_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRestApi_IsCfnResource ¶
func CfnRestApi_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnRestApi_IsConstruct ¶
func CfnRestApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnStage_CFN_RESOURCE_TYPE_NAME ¶
func CfnStage_CFN_RESOURCE_TYPE_NAME() *string
func CfnStage_IsCfnElement ¶
func CfnStage_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnStage_IsCfnResource ¶
func CfnStage_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnStage_IsConstruct ¶
func CfnStage_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnUsagePlanKey_CFN_RESOURCE_TYPE_NAME ¶
func CfnUsagePlanKey_CFN_RESOURCE_TYPE_NAME() *string
func CfnUsagePlanKey_IsCfnElement ¶
func CfnUsagePlanKey_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUsagePlanKey_IsCfnResource ¶
func CfnUsagePlanKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnUsagePlanKey_IsConstruct ¶
func CfnUsagePlanKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnUsagePlan_CFN_RESOURCE_TYPE_NAME ¶
func CfnUsagePlan_CFN_RESOURCE_TYPE_NAME() *string
func CfnUsagePlan_IsCfnElement ¶
func CfnUsagePlan_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUsagePlan_IsCfnResource ¶
func CfnUsagePlan_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnUsagePlan_IsConstruct ¶
func CfnUsagePlan_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnVpcLink_CFN_RESOURCE_TYPE_NAME ¶
func CfnVpcLink_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcLink_IsCfnElement ¶
func CfnVpcLink_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnVpcLink_IsCfnResource ¶
func CfnVpcLink_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnVpcLink_IsConstruct ¶
func CfnVpcLink_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CognitoUserPoolsAuthorizer_IsAuthorizer ¶
func CognitoUserPoolsAuthorizer_IsAuthorizer(x interface{}) *bool
Return whether the given object is an Authorizer.
func CognitoUserPoolsAuthorizer_IsConstruct ¶
func CognitoUserPoolsAuthorizer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CognitoUserPoolsAuthorizer_IsResource ¶
func CognitoUserPoolsAuthorizer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Cors_ALL_METHODS ¶
func Cors_ALL_METHODS() *[]*string
func Cors_ALL_ORIGINS ¶
func Cors_ALL_ORIGINS() *[]*string
func Cors_DEFAULT_HEADERS ¶
func Cors_DEFAULT_HEADERS() *[]*string
func Deployment_IsConstruct ¶
func Deployment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Deployment_IsResource ¶
func Deployment_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func DomainName_IsConstruct ¶
func DomainName_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func DomainName_IsResource ¶
func DomainName_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func GatewayResponse_IsConstruct ¶
func GatewayResponse_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func GatewayResponse_IsResource ¶
func GatewayResponse_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func IdentitySource_Context ¶
Provides a properly formatted request context identity source.
Returns: a request context identity source.
func IdentitySource_Header ¶
Provides a properly formatted header identity source.
Returns: a header identity source.
func IdentitySource_QueryString ¶
Provides a properly formatted query string identity source.
Returns: a query string identity source.
func IdentitySource_StageVariable ¶
Provides a properly formatted API Gateway stage variable identity source.
Returns: an API Gateway stage variable identity source.
func LambdaRestApi_IsConstruct ¶
func LambdaRestApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func LambdaRestApi_IsResource ¶
func LambdaRestApi_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Method_IsConstruct ¶
func Method_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Method_IsResource ¶
func Method_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Model_IsConstruct ¶
func Model_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Model_IsResource ¶
func Model_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NewAccessLogField_Override ¶
func NewAccessLogField_Override(a AccessLogField)
func NewApiDefinition_Override ¶
func NewApiDefinition_Override(a ApiDefinition)
func NewApiKey_Override ¶
func NewApiKey_Override(a ApiKey, scope constructs.Construct, id *string, props *ApiKeyProps)
func NewAssetApiDefinition_Override ¶
func NewAssetApiDefinition_Override(a AssetApiDefinition, path *string, options *awss3assets.AssetOptions)
func NewAuthorizer_Override ¶
func NewAuthorizer_Override(a Authorizer, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
func NewAwsIntegration_Override ¶
func NewAwsIntegration_Override(a AwsIntegration, props *AwsIntegrationProps)
func NewBasePathMapping_Override ¶
func NewBasePathMapping_Override(b BasePathMapping, scope constructs.Construct, id *string, props *BasePathMappingProps)
func NewCfnAccount_Override ¶
func NewCfnAccount_Override(c CfnAccount, scope constructs.Construct, id *string, props *CfnAccountProps)
Create a new `AWS::ApiGateway::Account`.
func NewCfnApiKey_Override ¶
func NewCfnApiKey_Override(c CfnApiKey, scope constructs.Construct, id *string, props *CfnApiKeyProps)
Create a new `AWS::ApiGateway::ApiKey`.
func NewCfnAuthorizer_Override ¶
func NewCfnAuthorizer_Override(c CfnAuthorizer, scope constructs.Construct, id *string, props *CfnAuthorizerProps)
Create a new `AWS::ApiGateway::Authorizer`.
func NewCfnBasePathMapping_Override ¶
func NewCfnBasePathMapping_Override(c CfnBasePathMapping, scope constructs.Construct, id *string, props *CfnBasePathMappingProps)
Create a new `AWS::ApiGateway::BasePathMapping`.
func NewCfnClientCertificate_Override ¶
func NewCfnClientCertificate_Override(c CfnClientCertificate, scope constructs.Construct, id *string, props *CfnClientCertificateProps)
Create a new `AWS::ApiGateway::ClientCertificate`.
func NewCfnDeployment_Override ¶
func NewCfnDeployment_Override(c CfnDeployment, scope constructs.Construct, id *string, props *CfnDeploymentProps)
Create a new `AWS::ApiGateway::Deployment`.
func NewCfnDocumentationPart_Override ¶
func NewCfnDocumentationPart_Override(c CfnDocumentationPart, scope constructs.Construct, id *string, props *CfnDocumentationPartProps)
Create a new `AWS::ApiGateway::DocumentationPart`.
func NewCfnDocumentationVersion_Override ¶
func NewCfnDocumentationVersion_Override(c CfnDocumentationVersion, scope constructs.Construct, id *string, props *CfnDocumentationVersionProps)
Create a new `AWS::ApiGateway::DocumentationVersion`.
func NewCfnDomainName_Override ¶
func NewCfnDomainName_Override(c CfnDomainName, scope constructs.Construct, id *string, props *CfnDomainNameProps)
Create a new `AWS::ApiGateway::DomainName`.
func NewCfnGatewayResponse_Override ¶
func NewCfnGatewayResponse_Override(c CfnGatewayResponse, scope constructs.Construct, id *string, props *CfnGatewayResponseProps)
Create a new `AWS::ApiGateway::GatewayResponse`.
func NewCfnMethod_Override ¶
func NewCfnMethod_Override(c CfnMethod, scope constructs.Construct, id *string, props *CfnMethodProps)
Create a new `AWS::ApiGateway::Method`.
func NewCfnModel_Override ¶
func NewCfnModel_Override(c CfnModel, scope constructs.Construct, id *string, props *CfnModelProps)
Create a new `AWS::ApiGateway::Model`.
func NewCfnRequestValidator_Override ¶
func NewCfnRequestValidator_Override(c CfnRequestValidator, scope constructs.Construct, id *string, props *CfnRequestValidatorProps)
Create a new `AWS::ApiGateway::RequestValidator`.
func NewCfnResource_Override ¶
func NewCfnResource_Override(c CfnResource, scope constructs.Construct, id *string, props *CfnResourceProps)
Create a new `AWS::ApiGateway::Resource`.
func NewCfnRestApi_Override ¶
func NewCfnRestApi_Override(c CfnRestApi, scope constructs.Construct, id *string, props *CfnRestApiProps)
Create a new `AWS::ApiGateway::RestApi`.
func NewCfnStage_Override ¶
func NewCfnStage_Override(c CfnStage, scope constructs.Construct, id *string, props *CfnStageProps)
Create a new `AWS::ApiGateway::Stage`.
func NewCfnUsagePlanKey_Override ¶
func NewCfnUsagePlanKey_Override(c CfnUsagePlanKey, scope constructs.Construct, id *string, props *CfnUsagePlanKeyProps)
Create a new `AWS::ApiGateway::UsagePlanKey`.
func NewCfnUsagePlan_Override ¶
func NewCfnUsagePlan_Override(c CfnUsagePlan, scope constructs.Construct, id *string, props *CfnUsagePlanProps)
Create a new `AWS::ApiGateway::UsagePlan`.
func NewCfnVpcLink_Override ¶
func NewCfnVpcLink_Override(c CfnVpcLink, scope constructs.Construct, id *string, props *CfnVpcLinkProps)
Create a new `AWS::ApiGateway::VpcLink`.
func NewCognitoUserPoolsAuthorizer_Override ¶
func NewCognitoUserPoolsAuthorizer_Override(c CognitoUserPoolsAuthorizer, scope constructs.Construct, id *string, props *CognitoUserPoolsAuthorizerProps)
func NewDeployment_Override ¶
func NewDeployment_Override(d Deployment, scope constructs.Construct, id *string, props *DeploymentProps)
func NewDomainName_Override ¶
func NewDomainName_Override(d DomainName, scope constructs.Construct, id *string, props *DomainNameProps)
func NewGatewayResponse_Override ¶
func NewGatewayResponse_Override(g GatewayResponse, scope constructs.Construct, id *string, props *GatewayResponseProps)
func NewHttpIntegration_Override ¶
func NewHttpIntegration_Override(h HttpIntegration, url *string, props *HttpIntegrationProps)
func NewIdentitySource_Override ¶
func NewIdentitySource_Override(i IdentitySource)
func NewInlineApiDefinition_Override ¶
func NewInlineApiDefinition_Override(i InlineApiDefinition, definition interface{})
func NewIntegration_Override ¶
func NewIntegration_Override(i Integration, props *IntegrationProps)
func NewLambdaIntegration_Override ¶
func NewLambdaIntegration_Override(l LambdaIntegration, handler awslambda.IFunction, options *LambdaIntegrationOptions)
func NewLambdaRestApi_Override ¶
func NewLambdaRestApi_Override(l LambdaRestApi, scope constructs.Construct, id *string, props *LambdaRestApiProps)
func NewLogGroupLogDestination_Override ¶
func NewLogGroupLogDestination_Override(l LogGroupLogDestination, logGroup awslogs.ILogGroup)
func NewMethod_Override ¶
func NewMethod_Override(m Method, scope constructs.Construct, id *string, props *MethodProps)
func NewMockIntegration_Override ¶
func NewMockIntegration_Override(m MockIntegration, options *IntegrationOptions)
func NewModel_Override ¶
func NewModel_Override(m Model, scope constructs.Construct, id *string, props *ModelProps)
func NewProxyResource_Override ¶
func NewProxyResource_Override(p ProxyResource, scope constructs.Construct, id *string, props *ProxyResourceProps)
func NewRateLimitedApiKey_Override ¶
func NewRateLimitedApiKey_Override(r RateLimitedApiKey, scope constructs.Construct, id *string, props *RateLimitedApiKeyProps)
func NewRequestAuthorizer_Override ¶
func NewRequestAuthorizer_Override(r RequestAuthorizer, scope constructs.Construct, id *string, props *RequestAuthorizerProps)
func NewRequestValidator_Override ¶
func NewRequestValidator_Override(r RequestValidator, scope constructs.Construct, id *string, props *RequestValidatorProps)
func NewResourceBase_Override ¶
func NewResourceBase_Override(r ResourceBase, scope constructs.Construct, id *string)
func NewResource_Override ¶
func NewResource_Override(r Resource, scope constructs.Construct, id *string, props *ResourceProps)
func NewRestApiBase_Override ¶
func NewRestApiBase_Override(r RestApiBase, scope constructs.Construct, id *string, props *RestApiBaseProps)
func NewRestApi_Override ¶
func NewRestApi_Override(r RestApi, scope constructs.Construct, id *string, props *RestApiProps)
func NewS3ApiDefinition_Override ¶
func NewS3ApiDefinition_Override(s S3ApiDefinition, bucket awss3.IBucket, key *string, objectVersion *string)
func NewSpecRestApi_Override ¶
func NewSpecRestApi_Override(s SpecRestApi, scope constructs.Construct, id *string, props *SpecRestApiProps)
func NewStage_Override ¶
func NewStage_Override(s Stage, scope constructs.Construct, id *string, props *StageProps)
func NewTokenAuthorizer_Override ¶
func NewTokenAuthorizer_Override(t TokenAuthorizer, scope constructs.Construct, id *string, props *TokenAuthorizerProps)
func NewUsagePlan_Override ¶
func NewUsagePlan_Override(u UsagePlan, scope constructs.Construct, id *string, props *UsagePlanProps)
func NewVpcLink_Override ¶
func NewVpcLink_Override(v VpcLink, scope constructs.Construct, id *string, props *VpcLinkProps)
func ProxyResource_IsConstruct ¶
func ProxyResource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ProxyResource_IsResource ¶
func ProxyResource_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func RateLimitedApiKey_IsConstruct ¶
func RateLimitedApiKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func RateLimitedApiKey_IsResource ¶
func RateLimitedApiKey_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func RequestAuthorizer_IsAuthorizer ¶
func RequestAuthorizer_IsAuthorizer(x interface{}) *bool
Return whether the given object is an Authorizer.
func RequestAuthorizer_IsConstruct ¶
func RequestAuthorizer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func RequestAuthorizer_IsResource ¶
func RequestAuthorizer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func RequestValidator_IsConstruct ¶
func RequestValidator_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func RequestValidator_IsResource ¶
func RequestValidator_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func ResourceBase_IsConstruct ¶
func ResourceBase_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ResourceBase_IsResource ¶
func ResourceBase_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Resource_IsConstruct ¶
func Resource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Resource_IsResource ¶
func Resource_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func RestApiBase_IsConstruct ¶
func RestApiBase_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func RestApiBase_IsResource ¶
func RestApiBase_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func RestApi_IsConstruct ¶
func RestApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func RestApi_IsResource ¶
func RestApi_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func SpecRestApi_IsConstruct ¶
func SpecRestApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func SpecRestApi_IsResource ¶
func SpecRestApi_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func Stage_IsConstruct ¶
func Stage_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Stage_IsResource ¶
func Stage_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func TokenAuthorizer_IsAuthorizer ¶
func TokenAuthorizer_IsAuthorizer(x interface{}) *bool
Return whether the given object is an Authorizer.
func TokenAuthorizer_IsConstruct ¶
func TokenAuthorizer_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func TokenAuthorizer_IsResource ¶
func TokenAuthorizer_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func UsagePlan_IsConstruct ¶
func UsagePlan_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func UsagePlan_IsResource ¶
func UsagePlan_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func VpcLink_IsConstruct ¶
func VpcLink_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func VpcLink_IsResource ¶
func VpcLink_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
Types ¶
type AccessLogDestinationConfig ¶
type AccessLogDestinationConfig struct {
// The Amazon Resource Name (ARN) of the destination resource.
DestinationArn *string `json:"destinationArn"`
}
Options when binding a log destination to a RestApi Stage.
TODO: EXAMPLE
type AccessLogField ¶
type AccessLogField interface {
}
$context variables that can be used to customize access log pattern.
TODO: EXAMPLE
func NewAccessLogField ¶
func NewAccessLogField() AccessLogField
type AccessLogFormat ¶
type AccessLogFormat interface {
ToString() *string
}
factory methods for access log format.
TODO: EXAMPLE
func AccessLogFormat_Custom ¶
func AccessLogFormat_Custom(format *string) AccessLogFormat
Custom log format.
You can create any log format string. You can easily get the $ context variable by using the methods of AccessLogField.
TODO: EXAMPLE
func AccessLogFormat_JsonWithStandardFields ¶
func AccessLogFormat_JsonWithStandardFields(fields *JsonWithStandardFieldProps) AccessLogFormat
Access log will be produced in the JSON format with a set of fields most useful in the access log.
All fields are turned on by default with the option to turn off specific fields.
type AddApiKeyOptions ¶
type AddApiKeyOptions struct {
// Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.
OverrideLogicalId *string `json:"overrideLogicalId"`
}
Options to the UsagePlan.addApiKey() method.
TODO: EXAMPLE
type ApiDefinition ¶
type ApiDefinition interface {
Bind(scope constructs.Construct) *ApiDefinitionConfig
BindAfterCreate(_scope constructs.Construct, _restApi IRestApi)
}
Represents an OpenAPI definition asset.
TODO: EXAMPLE
type ApiDefinitionConfig ¶
type ApiDefinitionConfig struct {
// Inline specification (mutually exclusive with `s3Location`).
InlineDefinition interface{} `json:"inlineDefinition"`
// The location of the specification in S3 (mutually exclusive with `inlineDefinition`).
S3Location *ApiDefinitionS3Location `json:"s3Location"`
}
Post-Binding Configuration for a CDK construct.
TODO: EXAMPLE
type ApiDefinitionS3Location ¶
type ApiDefinitionS3Location struct {
// The S3 bucket.
Bucket *string `json:"bucket"`
// The S3 key.
Key *string `json:"key"`
// An optional version.
Version *string `json:"version"`
}
S3 location of the API definition file.
TODO: EXAMPLE
type ApiKey ¶
type ApiKey interface {
awscdk.Resource
IApiKey
Env() *awscdk.ResourceEnvironment
KeyArn() *string
KeyId() *string
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
GrantRead(grantee awsiam.IGrantable) awsiam.Grant
GrantReadWrite(grantee awsiam.IGrantable) awsiam.Grant
GrantWrite(grantee awsiam.IGrantable) awsiam.Grant
ToString() *string
}
An API Gateway ApiKey.
An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.
TODO: EXAMPLE
func NewApiKey ¶
func NewApiKey(scope constructs.Construct, id *string, props *ApiKeyProps) ApiKey
type ApiKeyOptions ¶
type ApiKeyOptions struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// A name for the API key.
//
// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
ApiKeyName *string `json:"apiKeyName"`
// A description of the purpose of the API key.
Description *string `json:"description"`
// The value of the API key.
//
// Must be at least 20 characters long.
Value *string `json:"value"`
}
The options for creating an API Key.
TODO: EXAMPLE
type ApiKeyProps ¶
type ApiKeyProps struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// A name for the API key.
//
// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
ApiKeyName *string `json:"apiKeyName"`
// A description of the purpose of the API key.
Description *string `json:"description"`
// The value of the API key.
//
// Must be at least 20 characters long.
Value *string `json:"value"`
// An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
CustomerId *string `json:"customerId"`
// Indicates whether the API key can be used by clients.
Enabled *bool `json:"enabled"`
// Specifies whether the key identifier is distinct from the created API key value.
GenerateDistinctId *bool `json:"generateDistinctId"`
// A list of resources this api key is associated with.
Resources *[]IRestApi `json:"resources"`
}
ApiKey Properties.
TODO: EXAMPLE
type ApiKeySourceType ¶
type ApiKeySourceType string
const ( ApiKeySourceType_HEADER ApiKeySourceType = "HEADER" ApiKeySourceType_AUTHORIZER ApiKeySourceType = "AUTHORIZER" )
type AssetApiDefinition ¶
type AssetApiDefinition interface {
ApiDefinition
Bind(scope constructs.Construct) *ApiDefinitionConfig
BindAfterCreate(scope constructs.Construct, restApi IRestApi)
}
OpenAPI specification from a local file.
TODO: EXAMPLE
func ApiDefinition_FromAsset ¶
func ApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
Loads the API specification from a local disk asset.
func AssetApiDefinition_FromAsset ¶
func AssetApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
Loads the API specification from a local disk asset.
func InlineApiDefinition_FromAsset ¶
func InlineApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
Loads the API specification from a local disk asset.
func NewAssetApiDefinition ¶
func NewAssetApiDefinition(path *string, options *awss3assets.AssetOptions) AssetApiDefinition
func S3ApiDefinition_FromAsset ¶
func S3ApiDefinition_FromAsset(file *string, options *awss3assets.AssetOptions) AssetApiDefinition
Loads the API specification from a local disk asset.
type AuthorizationType ¶
type AuthorizationType string
TODO: EXAMPLE
const ( AuthorizationType_COGNITO AuthorizationType = "COGNITO" AuthorizationType_CUSTOM AuthorizationType = "CUSTOM" AuthorizationType_IAM AuthorizationType = "IAM" AuthorizationType_NONE AuthorizationType = "NONE" )
type Authorizer ¶
type Authorizer interface {
awscdk.Resource
IAuthorizer
AuthorizationType() AuthorizationType
AuthorizerId() *string
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
Base class for all custom authorizers.
type AwsIntegration ¶
type AwsIntegration interface {
Integration
Bind(method Method) *IntegrationConfig
}
This type of integration lets an API expose AWS service actions.
It is intended for calling all AWS service actions, but is not recommended for calling a Lambda function, because the Lambda custom integration is a legacy technology.
TODO: EXAMPLE
func NewAwsIntegration ¶
func NewAwsIntegration(props *AwsIntegrationProps) AwsIntegration
type AwsIntegrationProps ¶
type AwsIntegrationProps struct {
// The name of the integrated AWS service (e.g. `s3`).
Service *string `json:"service"`
// The AWS action to perform in the integration.
//
// Use `actionParams` to specify key-value params for the action.
//
// Mutually exclusive with `path`.
Action *string `json:"action"`
// Parameters for the action.
//
// `action` must be set, and `path` must be undefined.
// The action params will be URL encoded.
ActionParameters *map[string]*string `json:"actionParameters"`
// The integration's HTTP method type.
IntegrationHttpMethod *string `json:"integrationHttpMethod"`
// Integration options, such as content handling, request/response mapping, etc.
Options *IntegrationOptions `json:"options"`
// The path to use for path-base APIs.
//
// For example, for S3 GET, you can set path to `bucket/key`.
// For lambda, you can set path to `2015-03-31/functions/${function-arn}/invocations`
//
// Mutually exclusive with the `action` options.
Path *string `json:"path"`
// Use AWS_PROXY integration.
Proxy *bool `json:"proxy"`
// The region of the integrated AWS service.
Region *string `json:"region"`
// A designated subdomain supported by certain AWS service for fast host-name lookup.
Subdomain *string `json:"subdomain"`
}
TODO: EXAMPLE
type BasePathMapping ¶
type BasePathMapping interface {
awscdk.Resource
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
This resource creates a base path that clients who call your API must use in the invocation URL.
Unless you're importing a domain with `DomainName.fromDomainNameAttributes()`, you can use `DomainName.addBasePathMapping()` to define mappings.
TODO: EXAMPLE
func NewBasePathMapping ¶
func NewBasePathMapping(scope constructs.Construct, id *string, props *BasePathMappingProps) BasePathMapping
type BasePathMappingOptions ¶
type BasePathMappingOptions struct {
// The base path name that callers of the API must provide in the URL after the domain name (e.g. `example.com/base-path`). If you specify this property, it can't be an empty string.
BasePath *string `json:"basePath"`
// The Deployment stage of API [disable-awslint:ref-via-interface].
Stage Stage `json:"stage"`
}
TODO: EXAMPLE
type BasePathMappingProps ¶
type BasePathMappingProps struct {
// The base path name that callers of the API must provide in the URL after the domain name (e.g. `example.com/base-path`). If you specify this property, it can't be an empty string.
BasePath *string `json:"basePath"`
// The Deployment stage of API [disable-awslint:ref-via-interface].
Stage Stage `json:"stage"`
// The DomainName to associate with this base path mapping.
DomainName IDomainName `json:"domainName"`
// The RestApi resource to target.
RestApi IRestApi `json:"restApi"`
}
TODO: EXAMPLE
type CfnAccount ¶
type CfnAccount interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CloudWatchRoleArn() *string
SetCloudWatchRoleArn(val *string)
CreationStack() *[]*string
LogicalId() *string
Node() constructs.Node
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Account`.
TODO: EXAMPLE
func NewCfnAccount ¶
func NewCfnAccount(scope constructs.Construct, id *string, props *CfnAccountProps) CfnAccount
Create a new `AWS::ApiGateway::Account`.
type CfnAccountProps ¶
type CfnAccountProps struct {
// `AWS::ApiGateway::Account.CloudWatchRoleArn`.
CloudWatchRoleArn *string `json:"cloudWatchRoleArn"`
}
Properties for defining a `AWS::ApiGateway::Account`.
TODO: EXAMPLE
type CfnApiKey ¶
type CfnApiKey interface {
awscdk.CfnResource
awscdk.IInspectable
AttrApiKeyId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
CustomerId() *string
SetCustomerId(val *string)
Description() *string
SetDescription(val *string)
Enabled() interface{}
SetEnabled(val interface{})
GenerateDistinctId() interface{}
SetGenerateDistinctId(val interface{})
LogicalId() *string
Name() *string
SetName(val *string)
Node() constructs.Node
Ref() *string
Stack() awscdk.Stack
StageKeys() interface{}
SetStageKeys(val interface{})
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
Value() *string
SetValue(val *string)
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::ApiKey`.
TODO: EXAMPLE
func NewCfnApiKey ¶
func NewCfnApiKey(scope constructs.Construct, id *string, props *CfnApiKeyProps) CfnApiKey
Create a new `AWS::ApiGateway::ApiKey`.
type CfnApiKeyProps ¶
type CfnApiKeyProps struct {
// `AWS::ApiGateway::ApiKey.CustomerId`.
CustomerId *string `json:"customerId"`
// `AWS::ApiGateway::ApiKey.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::ApiKey.Enabled`.
Enabled interface{} `json:"enabled"`
// `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
GenerateDistinctId interface{} `json:"generateDistinctId"`
// `AWS::ApiGateway::ApiKey.Name`.
Name *string `json:"name"`
// `AWS::ApiGateway::ApiKey.StageKeys`.
StageKeys interface{} `json:"stageKeys"`
// `AWS::ApiGateway::ApiKey.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
// `AWS::ApiGateway::ApiKey.Value`.
Value *string `json:"value"`
}
Properties for defining a `AWS::ApiGateway::ApiKey`.
TODO: EXAMPLE
type CfnApiKey_StageKeyProperty ¶
type CfnApiKey_StageKeyProperty struct {
// `CfnApiKey.StageKeyProperty.RestApiId`.
RestApiId *string `json:"restApiId"`
// `CfnApiKey.StageKeyProperty.StageName`.
StageName *string `json:"stageName"`
}
TODO: EXAMPLE
type CfnAuthorizer ¶
type CfnAuthorizer interface {
awscdk.CfnResource
awscdk.IInspectable
AttrAuthorizerId() *string
AuthorizerCredentials() *string
SetAuthorizerCredentials(val *string)
AuthorizerResultTtlInSeconds() *float64
SetAuthorizerResultTtlInSeconds(val *float64)
AuthorizerUri() *string
SetAuthorizerUri(val *string)
AuthType() *string
SetAuthType(val *string)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
IdentitySource() *string
SetIdentitySource(val *string)
IdentityValidationExpression() *string
SetIdentityValidationExpression(val *string)
LogicalId() *string
Name() *string
SetName(val *string)
Node() constructs.Node
ProviderArns() *[]*string
SetProviderArns(val *[]*string)
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
Type() *string
SetType(val *string)
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Authorizer`.
TODO: EXAMPLE
func NewCfnAuthorizer ¶
func NewCfnAuthorizer(scope constructs.Construct, id *string, props *CfnAuthorizerProps) CfnAuthorizer
Create a new `AWS::ApiGateway::Authorizer`.
type CfnAuthorizerProps ¶
type CfnAuthorizerProps struct {
// `AWS::ApiGateway::Authorizer.AuthorizerCredentials`.
AuthorizerCredentials *string `json:"authorizerCredentials"`
// `AWS::ApiGateway::Authorizer.AuthorizerResultTtlInSeconds`.
AuthorizerResultTtlInSeconds *float64 `json:"authorizerResultTtlInSeconds"`
// `AWS::ApiGateway::Authorizer.AuthorizerUri`.
AuthorizerUri *string `json:"authorizerUri"`
// `AWS::ApiGateway::Authorizer.AuthType`.
AuthType *string `json:"authType"`
// `AWS::ApiGateway::Authorizer.IdentitySource`.
IdentitySource *string `json:"identitySource"`
// `AWS::ApiGateway::Authorizer.IdentityValidationExpression`.
IdentityValidationExpression *string `json:"identityValidationExpression"`
// `AWS::ApiGateway::Authorizer.Name`.
Name *string `json:"name"`
// `AWS::ApiGateway::Authorizer.ProviderARNs`.
ProviderArns *[]*string `json:"providerArns"`
// `AWS::ApiGateway::Authorizer.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::Authorizer.Type`.
Type *string `json:"type"`
}
Properties for defining a `AWS::ApiGateway::Authorizer`.
TODO: EXAMPLE
type CfnBasePathMapping ¶
type CfnBasePathMapping interface {
awscdk.CfnResource
awscdk.IInspectable
BasePath() *string
SetBasePath(val *string)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
DomainName() *string
SetDomainName(val *string)
LogicalId() *string
Node() constructs.Node
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
Stage() *string
SetStage(val *string)
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::BasePathMapping`.
TODO: EXAMPLE
func NewCfnBasePathMapping ¶
func NewCfnBasePathMapping(scope constructs.Construct, id *string, props *CfnBasePathMappingProps) CfnBasePathMapping
Create a new `AWS::ApiGateway::BasePathMapping`.
type CfnBasePathMappingProps ¶
type CfnBasePathMappingProps struct {
// `AWS::ApiGateway::BasePathMapping.BasePath`.
BasePath *string `json:"basePath"`
// `AWS::ApiGateway::BasePathMapping.DomainName`.
DomainName *string `json:"domainName"`
// `AWS::ApiGateway::BasePathMapping.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::BasePathMapping.Stage`.
Stage *string `json:"stage"`
}
Properties for defining a `AWS::ApiGateway::BasePathMapping`.
TODO: EXAMPLE
type CfnClientCertificate ¶
type CfnClientCertificate interface {
awscdk.CfnResource
awscdk.IInspectable
AttrClientCertificateId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
LogicalId() *string
Node() constructs.Node
Ref() *string
Stack() awscdk.Stack
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::ClientCertificate`.
TODO: EXAMPLE
func NewCfnClientCertificate ¶
func NewCfnClientCertificate(scope constructs.Construct, id *string, props *CfnClientCertificateProps) CfnClientCertificate
Create a new `AWS::ApiGateway::ClientCertificate`.
type CfnClientCertificateProps ¶
type CfnClientCertificateProps struct {
// `AWS::ApiGateway::ClientCertificate.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::ClientCertificate.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
}
Properties for defining a `AWS::ApiGateway::ClientCertificate`.
TODO: EXAMPLE
type CfnDeployment ¶
type CfnDeployment interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
DeploymentCanarySettings() interface{}
SetDeploymentCanarySettings(val interface{})
Description() *string
SetDescription(val *string)
LogicalId() *string
Node() constructs.Node
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
StageDescription() interface{}
SetStageDescription(val interface{})
StageName() *string
SetStageName(val *string)
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Deployment`.
TODO: EXAMPLE
func NewCfnDeployment ¶
func NewCfnDeployment(scope constructs.Construct, id *string, props *CfnDeploymentProps) CfnDeployment
Create a new `AWS::ApiGateway::Deployment`.
type CfnDeploymentProps ¶
type CfnDeploymentProps struct {
// `AWS::ApiGateway::Deployment.DeploymentCanarySettings`.
DeploymentCanarySettings interface{} `json:"deploymentCanarySettings"`
// `AWS::ApiGateway::Deployment.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::Deployment.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::Deployment.StageDescription`.
StageDescription interface{} `json:"stageDescription"`
// `AWS::ApiGateway::Deployment.StageName`.
StageName *string `json:"stageName"`
}
Properties for defining a `AWS::ApiGateway::Deployment`.
TODO: EXAMPLE
type CfnDeployment_AccessLogSettingProperty ¶
type CfnDeployment_AccessLogSettingProperty struct {
// `CfnDeployment.AccessLogSettingProperty.DestinationArn`.
DestinationArn *string `json:"destinationArn"`
// `CfnDeployment.AccessLogSettingProperty.Format`.
Format *string `json:"format"`
}
TODO: EXAMPLE
type CfnDeployment_CanarySettingProperty ¶
type CfnDeployment_CanarySettingProperty struct {
// `CfnDeployment.CanarySettingProperty.PercentTraffic`.
PercentTraffic *float64 `json:"percentTraffic"`
// `CfnDeployment.CanarySettingProperty.StageVariableOverrides`.
StageVariableOverrides interface{} `json:"stageVariableOverrides"`
// `CfnDeployment.CanarySettingProperty.UseStageCache`.
UseStageCache interface{} `json:"useStageCache"`
}
TODO: EXAMPLE
type CfnDeployment_DeploymentCanarySettingsProperty ¶
type CfnDeployment_DeploymentCanarySettingsProperty struct {
// `CfnDeployment.DeploymentCanarySettingsProperty.PercentTraffic`.
PercentTraffic *float64 `json:"percentTraffic"`
// `CfnDeployment.DeploymentCanarySettingsProperty.StageVariableOverrides`.
StageVariableOverrides interface{} `json:"stageVariableOverrides"`
// `CfnDeployment.DeploymentCanarySettingsProperty.UseStageCache`.
UseStageCache interface{} `json:"useStageCache"`
}
TODO: EXAMPLE
type CfnDeployment_MethodSettingProperty ¶
type CfnDeployment_MethodSettingProperty struct {
// `CfnDeployment.MethodSettingProperty.CacheDataEncrypted`.
CacheDataEncrypted interface{} `json:"cacheDataEncrypted"`
// `CfnDeployment.MethodSettingProperty.CacheTtlInSeconds`.
CacheTtlInSeconds *float64 `json:"cacheTtlInSeconds"`
// `CfnDeployment.MethodSettingProperty.CachingEnabled`.
CachingEnabled interface{} `json:"cachingEnabled"`
// `CfnDeployment.MethodSettingProperty.DataTraceEnabled`.
DataTraceEnabled interface{} `json:"dataTraceEnabled"`
// `CfnDeployment.MethodSettingProperty.HttpMethod`.
HttpMethod *string `json:"httpMethod"`
// `CfnDeployment.MethodSettingProperty.LoggingLevel`.
LoggingLevel *string `json:"loggingLevel"`
// `CfnDeployment.MethodSettingProperty.MetricsEnabled`.
MetricsEnabled interface{} `json:"metricsEnabled"`
// `CfnDeployment.MethodSettingProperty.ResourcePath`.
ResourcePath *string `json:"resourcePath"`
// `CfnDeployment.MethodSettingProperty.ThrottlingBurstLimit`.
ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
// `CfnDeployment.MethodSettingProperty.ThrottlingRateLimit`.
ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
}
TODO: EXAMPLE
type CfnDeployment_StageDescriptionProperty ¶
type CfnDeployment_StageDescriptionProperty struct {
// `CfnDeployment.StageDescriptionProperty.AccessLogSetting`.
AccessLogSetting interface{} `json:"accessLogSetting"`
// `CfnDeployment.StageDescriptionProperty.CacheClusterEnabled`.
CacheClusterEnabled interface{} `json:"cacheClusterEnabled"`
// `CfnDeployment.StageDescriptionProperty.CacheClusterSize`.
CacheClusterSize *string `json:"cacheClusterSize"`
// `CfnDeployment.StageDescriptionProperty.CacheDataEncrypted`.
CacheDataEncrypted interface{} `json:"cacheDataEncrypted"`
// `CfnDeployment.StageDescriptionProperty.CacheTtlInSeconds`.
CacheTtlInSeconds *float64 `json:"cacheTtlInSeconds"`
// `CfnDeployment.StageDescriptionProperty.CachingEnabled`.
CachingEnabled interface{} `json:"cachingEnabled"`
// `CfnDeployment.StageDescriptionProperty.CanarySetting`.
CanarySetting interface{} `json:"canarySetting"`
// `CfnDeployment.StageDescriptionProperty.ClientCertificateId`.
ClientCertificateId *string `json:"clientCertificateId"`
// `CfnDeployment.StageDescriptionProperty.DataTraceEnabled`.
DataTraceEnabled interface{} `json:"dataTraceEnabled"`
// `CfnDeployment.StageDescriptionProperty.Description`.
Description *string `json:"description"`
// `CfnDeployment.StageDescriptionProperty.DocumentationVersion`.
DocumentationVersion *string `json:"documentationVersion"`
// `CfnDeployment.StageDescriptionProperty.LoggingLevel`.
LoggingLevel *string `json:"loggingLevel"`
// `CfnDeployment.StageDescriptionProperty.MethodSettings`.
MethodSettings interface{} `json:"methodSettings"`
// `CfnDeployment.StageDescriptionProperty.MetricsEnabled`.
MetricsEnabled interface{} `json:"metricsEnabled"`
// `CfnDeployment.StageDescriptionProperty.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
// `CfnDeployment.StageDescriptionProperty.ThrottlingBurstLimit`.
ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
// `CfnDeployment.StageDescriptionProperty.ThrottlingRateLimit`.
ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
// `CfnDeployment.StageDescriptionProperty.TracingEnabled`.
TracingEnabled interface{} `json:"tracingEnabled"`
// `CfnDeployment.StageDescriptionProperty.Variables`.
Variables interface{} `json:"variables"`
}
TODO: EXAMPLE
type CfnDocumentationPart ¶
type CfnDocumentationPart interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Location() interface{}
SetLocation(val interface{})
LogicalId() *string
Node() constructs.Node
Properties() *string
SetProperties(val *string)
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::DocumentationPart`.
TODO: EXAMPLE
func NewCfnDocumentationPart ¶
func NewCfnDocumentationPart(scope constructs.Construct, id *string, props *CfnDocumentationPartProps) CfnDocumentationPart
Create a new `AWS::ApiGateway::DocumentationPart`.
type CfnDocumentationPartProps ¶
type CfnDocumentationPartProps struct {
// `AWS::ApiGateway::DocumentationPart.Location`.
Location interface{} `json:"location"`
// `AWS::ApiGateway::DocumentationPart.Properties`.
Properties *string `json:"properties"`
// `AWS::ApiGateway::DocumentationPart.RestApiId`.
RestApiId *string `json:"restApiId"`
}
Properties for defining a `AWS::ApiGateway::DocumentationPart`.
TODO: EXAMPLE
type CfnDocumentationPart_LocationProperty ¶
type CfnDocumentationPart_LocationProperty struct {
// `CfnDocumentationPart.LocationProperty.Method`.
Method *string `json:"method"`
// `CfnDocumentationPart.LocationProperty.Name`.
Name *string `json:"name"`
// `CfnDocumentationPart.LocationProperty.Path`.
Path *string `json:"path"`
// `CfnDocumentationPart.LocationProperty.StatusCode`.
StatusCode *string `json:"statusCode"`
// `CfnDocumentationPart.LocationProperty.Type`.
Type *string `json:"type"`
}
TODO: EXAMPLE
type CfnDocumentationVersion ¶
type CfnDocumentationVersion interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
DocumentationVersion() *string
SetDocumentationVersion(val *string)
LogicalId() *string
Node() constructs.Node
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::DocumentationVersion`.
TODO: EXAMPLE
func NewCfnDocumentationVersion ¶
func NewCfnDocumentationVersion(scope constructs.Construct, id *string, props *CfnDocumentationVersionProps) CfnDocumentationVersion
Create a new `AWS::ApiGateway::DocumentationVersion`.
type CfnDocumentationVersionProps ¶
type CfnDocumentationVersionProps struct {
// `AWS::ApiGateway::DocumentationVersion.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::DocumentationVersion.DocumentationVersion`.
DocumentationVersion *string `json:"documentationVersion"`
// `AWS::ApiGateway::DocumentationVersion.RestApiId`.
RestApiId *string `json:"restApiId"`
}
Properties for defining a `AWS::ApiGateway::DocumentationVersion`.
TODO: EXAMPLE
type CfnDomainName ¶
type CfnDomainName interface {
awscdk.CfnResource
awscdk.IInspectable
AttrDistributionDomainName() *string
AttrDistributionHostedZoneId() *string
AttrRegionalDomainName() *string
AttrRegionalHostedZoneId() *string
CertificateArn() *string
SetCertificateArn(val *string)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
DomainName() *string
SetDomainName(val *string)
EndpointConfiguration() interface{}
SetEndpointConfiguration(val interface{})
LogicalId() *string
MutualTlsAuthentication() interface{}
SetMutualTlsAuthentication(val interface{})
Node() constructs.Node
OwnershipVerificationCertificateArn() *string
SetOwnershipVerificationCertificateArn(val *string)
Ref() *string
RegionalCertificateArn() *string
SetRegionalCertificateArn(val *string)
SecurityPolicy() *string
SetSecurityPolicy(val *string)
Stack() awscdk.Stack
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::DomainName`.
TODO: EXAMPLE
func NewCfnDomainName ¶
func NewCfnDomainName(scope constructs.Construct, id *string, props *CfnDomainNameProps) CfnDomainName
Create a new `AWS::ApiGateway::DomainName`.
type CfnDomainNameProps ¶
type CfnDomainNameProps struct {
// `AWS::ApiGateway::DomainName.CertificateArn`.
CertificateArn *string `json:"certificateArn"`
// `AWS::ApiGateway::DomainName.DomainName`.
DomainName *string `json:"domainName"`
// `AWS::ApiGateway::DomainName.EndpointConfiguration`.
EndpointConfiguration interface{} `json:"endpointConfiguration"`
// `AWS::ApiGateway::DomainName.MutualTlsAuthentication`.
MutualTlsAuthentication interface{} `json:"mutualTlsAuthentication"`
// `AWS::ApiGateway::DomainName.OwnershipVerificationCertificateArn`.
OwnershipVerificationCertificateArn *string `json:"ownershipVerificationCertificateArn"`
// `AWS::ApiGateway::DomainName.RegionalCertificateArn`.
RegionalCertificateArn *string `json:"regionalCertificateArn"`
// `AWS::ApiGateway::DomainName.SecurityPolicy`.
SecurityPolicy *string `json:"securityPolicy"`
// `AWS::ApiGateway::DomainName.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
}
Properties for defining a `AWS::ApiGateway::DomainName`.
TODO: EXAMPLE
type CfnDomainName_EndpointConfigurationProperty ¶
type CfnDomainName_EndpointConfigurationProperty struct {
// `CfnDomainName.EndpointConfigurationProperty.Types`.
Types *[]*string `json:"types"`
}
TODO: EXAMPLE
type CfnDomainName_MutualTlsAuthenticationProperty ¶
type CfnDomainName_MutualTlsAuthenticationProperty struct {
// `CfnDomainName.MutualTlsAuthenticationProperty.TruststoreUri`.
TruststoreUri *string `json:"truststoreUri"`
// `CfnDomainName.MutualTlsAuthenticationProperty.TruststoreVersion`.
TruststoreVersion *string `json:"truststoreVersion"`
}
TODO: EXAMPLE
type CfnGatewayResponse ¶
type CfnGatewayResponse interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Node() constructs.Node
Ref() *string
ResponseParameters() interface{}
SetResponseParameters(val interface{})
ResponseTemplates() interface{}
SetResponseTemplates(val interface{})
ResponseType() *string
SetResponseType(val *string)
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
StatusCode() *string
SetStatusCode(val *string)
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::GatewayResponse`.
TODO: EXAMPLE
func NewCfnGatewayResponse ¶
func NewCfnGatewayResponse(scope constructs.Construct, id *string, props *CfnGatewayResponseProps) CfnGatewayResponse
Create a new `AWS::ApiGateway::GatewayResponse`.
type CfnGatewayResponseProps ¶
type CfnGatewayResponseProps struct {
// `AWS::ApiGateway::GatewayResponse.ResponseParameters`.
ResponseParameters interface{} `json:"responseParameters"`
// `AWS::ApiGateway::GatewayResponse.ResponseTemplates`.
ResponseTemplates interface{} `json:"responseTemplates"`
// `AWS::ApiGateway::GatewayResponse.ResponseType`.
ResponseType *string `json:"responseType"`
// `AWS::ApiGateway::GatewayResponse.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::GatewayResponse.StatusCode`.
StatusCode *string `json:"statusCode"`
}
Properties for defining a `AWS::ApiGateway::GatewayResponse`.
TODO: EXAMPLE
type CfnMethod ¶
type CfnMethod interface {
awscdk.CfnResource
awscdk.IInspectable
ApiKeyRequired() interface{}
SetApiKeyRequired(val interface{})
AuthorizationScopes() *[]*string
SetAuthorizationScopes(val *[]*string)
AuthorizationType() *string
SetAuthorizationType(val *string)
AuthorizerId() *string
SetAuthorizerId(val *string)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
HttpMethod() *string
SetHttpMethod(val *string)
Integration() interface{}
SetIntegration(val interface{})
LogicalId() *string
MethodResponses() interface{}
SetMethodResponses(val interface{})
Node() constructs.Node
OperationName() *string
SetOperationName(val *string)
Ref() *string
RequestModels() interface{}
SetRequestModels(val interface{})
RequestParameters() interface{}
SetRequestParameters(val interface{})
RequestValidatorId() *string
SetRequestValidatorId(val *string)
ResourceId() *string
SetResourceId(val *string)
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Method`.
TODO: EXAMPLE
func NewCfnMethod ¶
func NewCfnMethod(scope constructs.Construct, id *string, props *CfnMethodProps) CfnMethod
Create a new `AWS::ApiGateway::Method`.
type CfnMethodProps ¶
type CfnMethodProps struct {
// `AWS::ApiGateway::Method.ApiKeyRequired`.
ApiKeyRequired interface{} `json:"apiKeyRequired"`
// `AWS::ApiGateway::Method.AuthorizationScopes`.
AuthorizationScopes *[]*string `json:"authorizationScopes"`
// `AWS::ApiGateway::Method.AuthorizationType`.
AuthorizationType *string `json:"authorizationType"`
// `AWS::ApiGateway::Method.AuthorizerId`.
AuthorizerId *string `json:"authorizerId"`
// `AWS::ApiGateway::Method.HttpMethod`.
HttpMethod *string `json:"httpMethod"`
// `AWS::ApiGateway::Method.Integration`.
Integration interface{} `json:"integration"`
// `AWS::ApiGateway::Method.MethodResponses`.
MethodResponses interface{} `json:"methodResponses"`
// `AWS::ApiGateway::Method.OperationName`.
OperationName *string `json:"operationName"`
// `AWS::ApiGateway::Method.RequestModels`.
RequestModels interface{} `json:"requestModels"`
// `AWS::ApiGateway::Method.RequestParameters`.
RequestParameters interface{} `json:"requestParameters"`
// `AWS::ApiGateway::Method.RequestValidatorId`.
RequestValidatorId *string `json:"requestValidatorId"`
// `AWS::ApiGateway::Method.ResourceId`.
ResourceId *string `json:"resourceId"`
// `AWS::ApiGateway::Method.RestApiId`.
RestApiId *string `json:"restApiId"`
}
Properties for defining a `AWS::ApiGateway::Method`.
TODO: EXAMPLE
type CfnMethod_IntegrationProperty ¶
type CfnMethod_IntegrationProperty struct {
// `CfnMethod.IntegrationProperty.CacheKeyParameters`.
CacheKeyParameters *[]*string `json:"cacheKeyParameters"`
// `CfnMethod.IntegrationProperty.CacheNamespace`.
CacheNamespace *string `json:"cacheNamespace"`
// `CfnMethod.IntegrationProperty.ConnectionId`.
ConnectionId *string `json:"connectionId"`
// `CfnMethod.IntegrationProperty.ConnectionType`.
ConnectionType *string `json:"connectionType"`
// `CfnMethod.IntegrationProperty.ContentHandling`.
ContentHandling *string `json:"contentHandling"`
// `CfnMethod.IntegrationProperty.Credentials`.
Credentials *string `json:"credentials"`
// `CfnMethod.IntegrationProperty.IntegrationHttpMethod`.
IntegrationHttpMethod *string `json:"integrationHttpMethod"`
// `CfnMethod.IntegrationProperty.IntegrationResponses`.
IntegrationResponses interface{} `json:"integrationResponses"`
// `CfnMethod.IntegrationProperty.PassthroughBehavior`.
PassthroughBehavior *string `json:"passthroughBehavior"`
// `CfnMethod.IntegrationProperty.RequestParameters`.
RequestParameters interface{} `json:"requestParameters"`
// `CfnMethod.IntegrationProperty.RequestTemplates`.
RequestTemplates interface{} `json:"requestTemplates"`
// `CfnMethod.IntegrationProperty.TimeoutInMillis`.
TimeoutInMillis *float64 `json:"timeoutInMillis"`
// `CfnMethod.IntegrationProperty.Type`.
Type *string `json:"type"`
// `CfnMethod.IntegrationProperty.Uri`.
Uri *string `json:"uri"`
}
TODO: EXAMPLE
type CfnMethod_IntegrationResponseProperty ¶
type CfnMethod_IntegrationResponseProperty struct {
// `CfnMethod.IntegrationResponseProperty.ContentHandling`.
ContentHandling *string `json:"contentHandling"`
// `CfnMethod.IntegrationResponseProperty.ResponseParameters`.
ResponseParameters interface{} `json:"responseParameters"`
// `CfnMethod.IntegrationResponseProperty.ResponseTemplates`.
ResponseTemplates interface{} `json:"responseTemplates"`
// `CfnMethod.IntegrationResponseProperty.SelectionPattern`.
SelectionPattern *string `json:"selectionPattern"`
// `CfnMethod.IntegrationResponseProperty.StatusCode`.
StatusCode *string `json:"statusCode"`
}
TODO: EXAMPLE
type CfnMethod_MethodResponseProperty ¶
type CfnMethod_MethodResponseProperty struct {
// `CfnMethod.MethodResponseProperty.ResponseModels`.
ResponseModels interface{} `json:"responseModels"`
// `CfnMethod.MethodResponseProperty.ResponseParameters`.
ResponseParameters interface{} `json:"responseParameters"`
// `CfnMethod.MethodResponseProperty.StatusCode`.
StatusCode *string `json:"statusCode"`
}
TODO: EXAMPLE
type CfnModel ¶
type CfnModel interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
ContentType() *string
SetContentType(val *string)
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
LogicalId() *string
Name() *string
SetName(val *string)
Node() constructs.Node
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Schema() interface{}
SetSchema(val interface{})
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Model`.
TODO: EXAMPLE
func NewCfnModel ¶
func NewCfnModel(scope constructs.Construct, id *string, props *CfnModelProps) CfnModel
Create a new `AWS::ApiGateway::Model`.
type CfnModelProps ¶
type CfnModelProps struct {
// `AWS::ApiGateway::Model.ContentType`.
ContentType *string `json:"contentType"`
// `AWS::ApiGateway::Model.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::Model.Name`.
Name *string `json:"name"`
// `AWS::ApiGateway::Model.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::Model.Schema`.
Schema interface{} `json:"schema"`
}
Properties for defining a `AWS::ApiGateway::Model`.
TODO: EXAMPLE
type CfnRequestValidator ¶
type CfnRequestValidator interface {
awscdk.CfnResource
awscdk.IInspectable
AttrRequestValidatorId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Name() *string
SetName(val *string)
Node() constructs.Node
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
ValidateRequestBody() interface{}
SetValidateRequestBody(val interface{})
ValidateRequestParameters() interface{}
SetValidateRequestParameters(val interface{})
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::RequestValidator`.
TODO: EXAMPLE
func NewCfnRequestValidator ¶
func NewCfnRequestValidator(scope constructs.Construct, id *string, props *CfnRequestValidatorProps) CfnRequestValidator
Create a new `AWS::ApiGateway::RequestValidator`.
type CfnRequestValidatorProps ¶
type CfnRequestValidatorProps struct {
// `AWS::ApiGateway::RequestValidator.Name`.
Name *string `json:"name"`
// `AWS::ApiGateway::RequestValidator.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::RequestValidator.ValidateRequestBody`.
ValidateRequestBody interface{} `json:"validateRequestBody"`
// `AWS::ApiGateway::RequestValidator.ValidateRequestParameters`.
ValidateRequestParameters interface{} `json:"validateRequestParameters"`
}
Properties for defining a `AWS::ApiGateway::RequestValidator`.
TODO: EXAMPLE
type CfnResource ¶
type CfnResource interface {
awscdk.CfnResource
awscdk.IInspectable
AttrResourceId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Node() constructs.Node
ParentId() *string
SetParentId(val *string)
PathPart() *string
SetPathPart(val *string)
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Resource`.
TODO: EXAMPLE
func NewCfnResource ¶
func NewCfnResource(scope constructs.Construct, id *string, props *CfnResourceProps) CfnResource
Create a new `AWS::ApiGateway::Resource`.
type CfnResourceProps ¶
type CfnResourceProps struct {
// `AWS::ApiGateway::Resource.ParentId`.
ParentId *string `json:"parentId"`
// `AWS::ApiGateway::Resource.PathPart`.
PathPart *string `json:"pathPart"`
// `AWS::ApiGateway::Resource.RestApiId`.
RestApiId *string `json:"restApiId"`
}
Properties for defining a `AWS::ApiGateway::Resource`.
TODO: EXAMPLE
type CfnRestApi ¶
type CfnRestApi interface {
awscdk.CfnResource
awscdk.IInspectable
ApiKeySourceType() *string
SetApiKeySourceType(val *string)
AttrRootResourceId() *string
BinaryMediaTypes() *[]*string
SetBinaryMediaTypes(val *[]*string)
Body() interface{}
SetBody(val interface{})
BodyS3Location() interface{}
SetBodyS3Location(val interface{})
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CloneFrom() *string
SetCloneFrom(val *string)
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
DisableExecuteApiEndpoint() interface{}
SetDisableExecuteApiEndpoint(val interface{})
EndpointConfiguration() interface{}
SetEndpointConfiguration(val interface{})
FailOnWarnings() interface{}
SetFailOnWarnings(val interface{})
LogicalId() *string
MinimumCompressionSize() *float64
SetMinimumCompressionSize(val *float64)
Mode() *string
SetMode(val *string)
Name() *string
SetName(val *string)
Node() constructs.Node
Parameters() interface{}
SetParameters(val interface{})
Policy() interface{}
SetPolicy(val interface{})
Ref() *string
Stack() awscdk.Stack
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::RestApi`.
TODO: EXAMPLE
func NewCfnRestApi ¶
func NewCfnRestApi(scope constructs.Construct, id *string, props *CfnRestApiProps) CfnRestApi
Create a new `AWS::ApiGateway::RestApi`.
type CfnRestApiProps ¶
type CfnRestApiProps struct {
// `AWS::ApiGateway::RestApi.ApiKeySourceType`.
ApiKeySourceType *string `json:"apiKeySourceType"`
// `AWS::ApiGateway::RestApi.BinaryMediaTypes`.
BinaryMediaTypes *[]*string `json:"binaryMediaTypes"`
// `AWS::ApiGateway::RestApi.Body`.
Body interface{} `json:"body"`
// `AWS::ApiGateway::RestApi.BodyS3Location`.
BodyS3Location interface{} `json:"bodyS3Location"`
// `AWS::ApiGateway::RestApi.CloneFrom`.
CloneFrom *string `json:"cloneFrom"`
// `AWS::ApiGateway::RestApi.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::RestApi.DisableExecuteApiEndpoint`.
DisableExecuteApiEndpoint interface{} `json:"disableExecuteApiEndpoint"`
// `AWS::ApiGateway::RestApi.EndpointConfiguration`.
EndpointConfiguration interface{} `json:"endpointConfiguration"`
// `AWS::ApiGateway::RestApi.FailOnWarnings`.
FailOnWarnings interface{} `json:"failOnWarnings"`
// `AWS::ApiGateway::RestApi.MinimumCompressionSize`.
MinimumCompressionSize *float64 `json:"minimumCompressionSize"`
// `AWS::ApiGateway::RestApi.Mode`.
Mode *string `json:"mode"`
// `AWS::ApiGateway::RestApi.Name`.
Name *string `json:"name"`
// `AWS::ApiGateway::RestApi.Parameters`.
Parameters interface{} `json:"parameters"`
// `AWS::ApiGateway::RestApi.Policy`.
Policy interface{} `json:"policy"`
// `AWS::ApiGateway::RestApi.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
}
Properties for defining a `AWS::ApiGateway::RestApi`.
TODO: EXAMPLE
type CfnRestApi_EndpointConfigurationProperty ¶
type CfnRestApi_EndpointConfigurationProperty struct {
// `CfnRestApi.EndpointConfigurationProperty.Types`.
Types *[]*string `json:"types"`
// `CfnRestApi.EndpointConfigurationProperty.VpcEndpointIds`.
VpcEndpointIds *[]*string `json:"vpcEndpointIds"`
}
TODO: EXAMPLE
type CfnRestApi_S3LocationProperty ¶
type CfnRestApi_S3LocationProperty struct {
// `CfnRestApi.S3LocationProperty.Bucket`.
Bucket *string `json:"bucket"`
// `CfnRestApi.S3LocationProperty.ETag`.
ETag *string `json:"eTag"`
// `CfnRestApi.S3LocationProperty.Key`.
Key *string `json:"key"`
// `CfnRestApi.S3LocationProperty.Version`.
Version *string `json:"version"`
}
TODO: EXAMPLE
type CfnStage ¶
type CfnStage interface {
awscdk.CfnResource
awscdk.IInspectable
AccessLogSetting() interface{}
SetAccessLogSetting(val interface{})
CacheClusterEnabled() interface{}
SetCacheClusterEnabled(val interface{})
CacheClusterSize() *string
SetCacheClusterSize(val *string)
CanarySetting() interface{}
SetCanarySetting(val interface{})
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
ClientCertificateId() *string
SetClientCertificateId(val *string)
CreationStack() *[]*string
DeploymentId() *string
SetDeploymentId(val *string)
Description() *string
SetDescription(val *string)
DocumentationVersion() *string
SetDocumentationVersion(val *string)
LogicalId() *string
MethodSettings() interface{}
SetMethodSettings(val interface{})
Node() constructs.Node
Ref() *string
RestApiId() *string
SetRestApiId(val *string)
Stack() awscdk.Stack
StageName() *string
SetStageName(val *string)
Tags() awscdk.TagManager
TracingEnabled() interface{}
SetTracingEnabled(val interface{})
UpdatedProperites() *map[string]interface{}
Variables() interface{}
SetVariables(val interface{})
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::Stage`.
TODO: EXAMPLE
func NewCfnStage ¶
func NewCfnStage(scope constructs.Construct, id *string, props *CfnStageProps) CfnStage
Create a new `AWS::ApiGateway::Stage`.
type CfnStageProps ¶
type CfnStageProps struct {
// `AWS::ApiGateway::Stage.AccessLogSetting`.
AccessLogSetting interface{} `json:"accessLogSetting"`
// `AWS::ApiGateway::Stage.CacheClusterEnabled`.
CacheClusterEnabled interface{} `json:"cacheClusterEnabled"`
// `AWS::ApiGateway::Stage.CacheClusterSize`.
CacheClusterSize *string `json:"cacheClusterSize"`
// `AWS::ApiGateway::Stage.CanarySetting`.
CanarySetting interface{} `json:"canarySetting"`
// `AWS::ApiGateway::Stage.ClientCertificateId`.
ClientCertificateId *string `json:"clientCertificateId"`
// `AWS::ApiGateway::Stage.DeploymentId`.
DeploymentId *string `json:"deploymentId"`
// `AWS::ApiGateway::Stage.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::Stage.DocumentationVersion`.
DocumentationVersion *string `json:"documentationVersion"`
// `AWS::ApiGateway::Stage.MethodSettings`.
MethodSettings interface{} `json:"methodSettings"`
// `AWS::ApiGateway::Stage.RestApiId`.
RestApiId *string `json:"restApiId"`
// `AWS::ApiGateway::Stage.StageName`.
StageName *string `json:"stageName"`
// `AWS::ApiGateway::Stage.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
// `AWS::ApiGateway::Stage.TracingEnabled`.
TracingEnabled interface{} `json:"tracingEnabled"`
// `AWS::ApiGateway::Stage.Variables`.
Variables interface{} `json:"variables"`
}
Properties for defining a `AWS::ApiGateway::Stage`.
TODO: EXAMPLE
type CfnStage_AccessLogSettingProperty ¶
type CfnStage_AccessLogSettingProperty struct {
// `CfnStage.AccessLogSettingProperty.DestinationArn`.
DestinationArn *string `json:"destinationArn"`
// `CfnStage.AccessLogSettingProperty.Format`.
Format *string `json:"format"`
}
TODO: EXAMPLE
type CfnStage_CanarySettingProperty ¶
type CfnStage_CanarySettingProperty struct {
// `CfnStage.CanarySettingProperty.DeploymentId`.
DeploymentId *string `json:"deploymentId"`
// `CfnStage.CanarySettingProperty.PercentTraffic`.
PercentTraffic *float64 `json:"percentTraffic"`
// `CfnStage.CanarySettingProperty.StageVariableOverrides`.
StageVariableOverrides interface{} `json:"stageVariableOverrides"`
// `CfnStage.CanarySettingProperty.UseStageCache`.
UseStageCache interface{} `json:"useStageCache"`
}
TODO: EXAMPLE
type CfnStage_MethodSettingProperty ¶
type CfnStage_MethodSettingProperty struct {
// `CfnStage.MethodSettingProperty.CacheDataEncrypted`.
CacheDataEncrypted interface{} `json:"cacheDataEncrypted"`
// `CfnStage.MethodSettingProperty.CacheTtlInSeconds`.
CacheTtlInSeconds *float64 `json:"cacheTtlInSeconds"`
// `CfnStage.MethodSettingProperty.CachingEnabled`.
CachingEnabled interface{} `json:"cachingEnabled"`
// `CfnStage.MethodSettingProperty.DataTraceEnabled`.
DataTraceEnabled interface{} `json:"dataTraceEnabled"`
// `CfnStage.MethodSettingProperty.HttpMethod`.
HttpMethod *string `json:"httpMethod"`
// `CfnStage.MethodSettingProperty.LoggingLevel`.
LoggingLevel *string `json:"loggingLevel"`
// `CfnStage.MethodSettingProperty.MetricsEnabled`.
MetricsEnabled interface{} `json:"metricsEnabled"`
// `CfnStage.MethodSettingProperty.ResourcePath`.
ResourcePath *string `json:"resourcePath"`
// `CfnStage.MethodSettingProperty.ThrottlingBurstLimit`.
ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
// `CfnStage.MethodSettingProperty.ThrottlingRateLimit`.
ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
}
TODO: EXAMPLE
type CfnUsagePlan ¶
type CfnUsagePlan interface {
awscdk.CfnResource
awscdk.IInspectable
ApiStages() interface{}
SetApiStages(val interface{})
AttrId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
LogicalId() *string
Node() constructs.Node
Quota() interface{}
SetQuota(val interface{})
Ref() *string
Stack() awscdk.Stack
Tags() awscdk.TagManager
Throttle() interface{}
SetThrottle(val interface{})
UpdatedProperites() *map[string]interface{}
UsagePlanName() *string
SetUsagePlanName(val *string)
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::UsagePlan`.
TODO: EXAMPLE
func NewCfnUsagePlan ¶
func NewCfnUsagePlan(scope constructs.Construct, id *string, props *CfnUsagePlanProps) CfnUsagePlan
Create a new `AWS::ApiGateway::UsagePlan`.
type CfnUsagePlanKey ¶
type CfnUsagePlanKey interface {
awscdk.CfnResource
awscdk.IInspectable
AttrId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
KeyId() *string
SetKeyId(val *string)
KeyType() *string
SetKeyType(val *string)
LogicalId() *string
Node() constructs.Node
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
UsagePlanId() *string
SetUsagePlanId(val *string)
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::UsagePlanKey`.
TODO: EXAMPLE
func NewCfnUsagePlanKey ¶
func NewCfnUsagePlanKey(scope constructs.Construct, id *string, props *CfnUsagePlanKeyProps) CfnUsagePlanKey
Create a new `AWS::ApiGateway::UsagePlanKey`.
type CfnUsagePlanKeyProps ¶
type CfnUsagePlanKeyProps struct {
// `AWS::ApiGateway::UsagePlanKey.KeyId`.
KeyId *string `json:"keyId"`
// `AWS::ApiGateway::UsagePlanKey.KeyType`.
KeyType *string `json:"keyType"`
// `AWS::ApiGateway::UsagePlanKey.UsagePlanId`.
UsagePlanId *string `json:"usagePlanId"`
}
Properties for defining a `AWS::ApiGateway::UsagePlanKey`.
TODO: EXAMPLE
type CfnUsagePlanProps ¶
type CfnUsagePlanProps struct {
// `AWS::ApiGateway::UsagePlan.ApiStages`.
ApiStages interface{} `json:"apiStages"`
// `AWS::ApiGateway::UsagePlan.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::UsagePlan.Quota`.
Quota interface{} `json:"quota"`
// `AWS::ApiGateway::UsagePlan.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
// `AWS::ApiGateway::UsagePlan.Throttle`.
Throttle interface{} `json:"throttle"`
// `AWS::ApiGateway::UsagePlan.UsagePlanName`.
UsagePlanName *string `json:"usagePlanName"`
}
Properties for defining a `AWS::ApiGateway::UsagePlan`.
TODO: EXAMPLE
type CfnUsagePlan_ApiStageProperty ¶
type CfnUsagePlan_ApiStageProperty struct {
// `CfnUsagePlan.ApiStageProperty.ApiId`.
ApiId *string `json:"apiId"`
// `CfnUsagePlan.ApiStageProperty.Stage`.
Stage *string `json:"stage"`
// `CfnUsagePlan.ApiStageProperty.Throttle`.
Throttle interface{} `json:"throttle"`
}
TODO: EXAMPLE
type CfnUsagePlan_QuotaSettingsProperty ¶
type CfnUsagePlan_QuotaSettingsProperty struct {
// `CfnUsagePlan.QuotaSettingsProperty.Limit`.
Limit *float64 `json:"limit"`
// `CfnUsagePlan.QuotaSettingsProperty.Offset`.
Offset *float64 `json:"offset"`
// `CfnUsagePlan.QuotaSettingsProperty.Period`.
Period *string `json:"period"`
}
TODO: EXAMPLE
type CfnUsagePlan_ThrottleSettingsProperty ¶
type CfnUsagePlan_ThrottleSettingsProperty struct {
// `CfnUsagePlan.ThrottleSettingsProperty.BurstLimit`.
BurstLimit *float64 `json:"burstLimit"`
// `CfnUsagePlan.ThrottleSettingsProperty.RateLimit`.
RateLimit *float64 `json:"rateLimit"`
}
TODO: EXAMPLE
type CfnVpcLink ¶
type CfnVpcLink interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
LogicalId() *string
Name() *string
SetName(val *string)
Node() constructs.Node
Ref() *string
Stack() awscdk.Stack
Tags() awscdk.TagManager
TargetArns() *[]*string
SetTargetArns(val *[]*string)
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ApiGateway::VpcLink`.
TODO: EXAMPLE
func NewCfnVpcLink ¶
func NewCfnVpcLink(scope constructs.Construct, id *string, props *CfnVpcLinkProps) CfnVpcLink
Create a new `AWS::ApiGateway::VpcLink`.
type CfnVpcLinkProps ¶
type CfnVpcLinkProps struct {
// `AWS::ApiGateway::VpcLink.Description`.
Description *string `json:"description"`
// `AWS::ApiGateway::VpcLink.Name`.
Name *string `json:"name"`
// `AWS::ApiGateway::VpcLink.Tags`.
Tags *[]*awscdk.CfnTag `json:"tags"`
// `AWS::ApiGateway::VpcLink.TargetArns`.
TargetArns *[]*string `json:"targetArns"`
}
Properties for defining a `AWS::ApiGateway::VpcLink`.
TODO: EXAMPLE
type CognitoUserPoolsAuthorizer ¶
type CognitoUserPoolsAuthorizer interface {
Authorizer
IAuthorizer
AuthorizationType() AuthorizationType
AuthorizerArn() *string
AuthorizerId() *string
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
Cognito user pools based custom authorizer.
TODO: EXAMPLE
func NewCognitoUserPoolsAuthorizer ¶
func NewCognitoUserPoolsAuthorizer(scope constructs.Construct, id *string, props *CognitoUserPoolsAuthorizerProps) CognitoUserPoolsAuthorizer
type CognitoUserPoolsAuthorizerProps ¶
type CognitoUserPoolsAuthorizerProps struct {
// The user pools to associate with this authorizer.
CognitoUserPools *[]awscognito.IUserPool `json:"cognitoUserPools"`
// An optional human friendly name for the authorizer.
//
// Note that, this is not the primary identifier of the authorizer.
AuthorizerName *string `json:"authorizerName"`
// The request header mapping expression for the bearer token.
//
// This is typically passed as part of the header, in which case
// this should be `method.request.header.Authorizer` where Authorizer is the header containing the bearer token.
// See: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource
//
IdentitySource *string `json:"identitySource"`
// How long APIGateway should cache the results.
//
// Max 1 hour.
// Disable caching by setting this to 0.
ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl"`
}
Properties for CognitoUserPoolsAuthorizer.
TODO: EXAMPLE
type ConnectionType ¶
type ConnectionType string
TODO: EXAMPLE
const ( ConnectionType_INTERNET ConnectionType = "INTERNET" ConnectionType_VPC_LINK ConnectionType = "VPC_LINK" )
type ContentHandling ¶
type ContentHandling string
TODO: EXAMPLE
const ( ContentHandling_CONVERT_TO_BINARY ContentHandling = "CONVERT_TO_BINARY" ContentHandling_CONVERT_TO_TEXT ContentHandling = "CONVERT_TO_TEXT" )
type CorsOptions ¶
type CorsOptions struct {
// The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to frontend JavaScript code when the request's credentials mode (Request.credentials) is "include".
//
// When a request's credentials mode (Request.credentials) is "include",
// browsers will only expose the response to frontend JavaScript code if the
// Access-Control-Allow-Credentials value is true.
//
// Credentials are cookies, authorization headers or TLS client certificates.
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials
//
AllowCredentials *bool `json:"allowCredentials"`
// The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
//
AllowHeaders *[]*string `json:"allowHeaders"`
// The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.
//
// If `ANY` is specified, it will be expanded to `Cors.ALL_METHODS`.
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
//
AllowMethods *[]*string `json:"allowMethods"`
// Specifies the list of origins that are allowed to make requests to this resource.
//
// If you wish to allow all origins, specify `Cors.ALL_ORIGINS` or
// `[ * ]`.
//
// Responses will include the `Access-Control-Allow-Origin` response header.
// If `Cors.ALL_ORIGINS` is specified, the `Vary: Origin` response header will
// also be included.
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
//
AllowOrigins *[]*string `json:"allowOrigins"`
// Sets Access-Control-Max-Age to -1, which means that caching is disabled.
//
// This option cannot be used with `maxAge`.
DisableCache *bool `json:"disableCache"`
// The Access-Control-Expose-Headers response header indicates which headers can be exposed as part of the response by listing their names.
//
// If you want clients to be able to access other headers, you have to list
// them using the Access-Control-Expose-Headers header.
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers
//
ExposeHeaders *[]*string `json:"exposeHeaders"`
// The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.
//
// To disable caching altogether use `disableCache: true`.
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age
//
MaxAge awscdk.Duration `json:"maxAge"`
// Specifies the response status code returned from the OPTIONS method.
StatusCode *float64 `json:"statusCode"`
}
TODO: EXAMPLE
type Deployment ¶
type Deployment interface {
awscdk.Resource
Api() IRestApi
DeploymentId() *string
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
AddToLogicalId(data interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
A Deployment of a REST API.
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Normally, you don't need to define deployments manually. The RestApi construct manages a Deployment resource that represents the latest model. It can be accessed through `restApi.latestDeployment` (unless `deploy: false` is set when defining the `RestApi`).
If you manually define this resource, you will need to know that since deployments are immutable, as long as the resource's logical ID doesn't change, the deployment will represent the snapshot in time in which the resource was created. This means that if you modify the RestApi model (i.e. add methods or resources), these changes will not be reflected unless a new deployment resource is created.
To achieve this behavior, the method `addToLogicalId(data)` can be used to augment the logical ID generated for the deployment resource such that it will include arbitrary data. This is done automatically for the `restApi.latestDeployment` deployment.
Furthermore, since a deployment does not reference any of the REST API resources and methods, CloudFormation will likely provision it before these resources are created, which means that it will represent a "half-baked" model. Use the `node.addDependency(dep)` method to circumvent that. This is done automatically for the `restApi.latestDeployment` deployment.
TODO: EXAMPLE
func NewDeployment ¶
func NewDeployment(scope constructs.Construct, id *string, props *DeploymentProps) Deployment
type DeploymentProps ¶
type DeploymentProps struct {
// The Rest API to deploy.
Api IRestApi `json:"api"`
// A description of the purpose of the API Gateway deployment.
Description *string `json:"description"`
// When an API Gateway model is updated, a new deployment will automatically be created.
//
// If this is true, the old API Gateway Deployment resource will not be deleted.
// This will allow manually reverting back to a previous deployment in case for example
RetainDeployments *bool `json:"retainDeployments"`
}
TODO: EXAMPLE
type DomainName ¶
type DomainName interface {
awscdk.Resource
IDomainName
DomainName() *string
DomainNameAliasDomainName() *string
DomainNameAliasHostedZoneId() *string
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
AddBasePathMapping(targetApi IRestApi, options *BasePathMappingOptions) BasePathMapping
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
TODO: EXAMPLE
func NewDomainName ¶
func NewDomainName(scope constructs.Construct, id *string, props *DomainNameProps) DomainName
type DomainNameAttributes ¶
type DomainNameAttributes struct {
// The domain name (e.g. `example.com`).
DomainName *string `json:"domainName"`
// The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
DomainNameAliasHostedZoneId *string `json:"domainNameAliasHostedZoneId"`
// The Route53 alias target to use in order to connect a record set to this domain through an alias.
DomainNameAliasTarget *string `json:"domainNameAliasTarget"`
}
TODO: EXAMPLE
type DomainNameOptions ¶
type DomainNameOptions struct {
// The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
//
// For "EDGE" domain names, the certificate
// needs to be in the US East (N. Virginia) region.
Certificate awscertificatemanager.ICertificate `json:"certificate"`
// The custom domain name for your API.
//
// Uppercase letters are not supported.
DomainName *string `json:"domainName"`
// The type of endpoint for this DomainName.
EndpointType EndpointType `json:"endpointType"`
// The mutual TLS authentication configuration for a custom domain name.
Mtls *MTLSConfig `json:"mtls"`
// The Transport Layer Security (TLS) version + cipher suite for this domain name.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
//
SecurityPolicy SecurityPolicy `json:"securityPolicy"`
}
TODO: EXAMPLE
type DomainNameProps ¶
type DomainNameProps struct {
// The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
//
// For "EDGE" domain names, the certificate
// needs to be in the US East (N. Virginia) region.
Certificate awscertificatemanager.ICertificate `json:"certificate"`
// The custom domain name for your API.
//
// Uppercase letters are not supported.
DomainName *string `json:"domainName"`
// The type of endpoint for this DomainName.
EndpointType EndpointType `json:"endpointType"`
// The mutual TLS authentication configuration for a custom domain name.
Mtls *MTLSConfig `json:"mtls"`
// The Transport Layer Security (TLS) version + cipher suite for this domain name.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
//
SecurityPolicy SecurityPolicy `json:"securityPolicy"`
// If specified, all requests to this domain will be mapped to the production deployment of this API.
//
// If you wish to map this domain to multiple APIs
// with different base paths, don't specify this option and use
// `addBasePathMapping`.
Mapping IRestApi `json:"mapping"`
}
TODO: EXAMPLE
type EndpointConfiguration ¶
type EndpointConfiguration struct {
// A list of endpoint types of an API or its custom domain name.
Types *[]EndpointType `json:"types"`
// A list of VPC Endpoints against which to create Route53 ALIASes.
VpcEndpoints *[]awsec2.IVpcEndpoint `json:"vpcEndpoints"`
}
The endpoint configuration of a REST API, including VPCs and endpoint types.
EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
TODO: EXAMPLE
type EndpointType ¶
type EndpointType string
TODO: EXAMPLE
const ( EndpointType_EDGE EndpointType = "EDGE" EndpointType_PRIVATE EndpointType = "PRIVATE" EndpointType_REGIONAL EndpointType = "REGIONAL" )
type GatewayResponse ¶
type GatewayResponse interface {
awscdk.Resource
IGatewayResponse
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
Configure the response received by clients, produced from the API Gateway backend.
TODO: EXAMPLE
func NewGatewayResponse ¶
func NewGatewayResponse(scope constructs.Construct, id *string, props *GatewayResponseProps) GatewayResponse
type GatewayResponseOptions ¶
type GatewayResponseOptions struct {
// Custom headers parameters for response.
ResponseHeaders *map[string]*string `json:"responseHeaders"`
// Http status code for response.
StatusCode *string `json:"statusCode"`
// Custom templates to get mapped as response.
Templates *map[string]*string `json:"templates"`
// Response type to associate with gateway response.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
//
Type ResponseType `json:"type"`
}
Options to add gateway response.
TODO: EXAMPLE
type GatewayResponseProps ¶
type GatewayResponseProps struct {
// Custom headers parameters for response.
ResponseHeaders *map[string]*string `json:"responseHeaders"`
// Http status code for response.
StatusCode *string `json:"statusCode"`
// Custom templates to get mapped as response.
Templates *map[string]*string `json:"templates"`
// Response type to associate with gateway response.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
//
Type ResponseType `json:"type"`
// Rest api resource to target.
RestApi IRestApi `json:"restApi"`
}
Properties for a new gateway response.
TODO: EXAMPLE
type HttpIntegration ¶
type HttpIntegration interface {
Integration
Bind(_method Method) *IntegrationConfig
}
You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.
With the proxy integration, the setup is simple. You only need to set the HTTP method and the HTTP endpoint URI, according to the backend requirements, if you are not concerned with content encoding or caching.
With the custom integration, the setup is more involved. In addition to the proxy integration setup steps, you need to specify how the incoming request data is mapped to the integration request and how the resulting integration response data is mapped to the method response.
TODO: EXAMPLE
func NewHttpIntegration ¶
func NewHttpIntegration(url *string, props *HttpIntegrationProps) HttpIntegration
type HttpIntegrationProps ¶
type HttpIntegrationProps struct {
// HTTP method to use when invoking the backend URL.
HttpMethod *string `json:"httpMethod"`
// Integration options, such as request/resopnse mapping, content handling, etc.
Options *IntegrationOptions `json:"options"`
// Determines whether to use proxy integration or custom integration.
Proxy *bool `json:"proxy"`
}
TODO: EXAMPLE
type IAccessLogDestination ¶
type IAccessLogDestination interface {
// Binds this destination to the RestApi Stage.
Bind(stage IStage) *AccessLogDestinationConfig
}
Access log destination for a RestApi Stage.
type IApiKey ¶
type IApiKey interface {
awscdk.IResource
// The API key ARN.
KeyArn() *string
// The API key ID.
KeyId() *string
}
API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.
func ApiKey_FromApiKeyId ¶
Import an ApiKey by its Id.
type IAuthorizer ¶
type IAuthorizer interface {
// The authorization type of this authorizer.
AuthorizationType() AuthorizationType
// The authorizer ID.
AuthorizerId() *string
}
Represents an API Gateway authorizer.
type IDomainName ¶
type IDomainName interface {
awscdk.IResource
// The domain name (e.g. `example.com`).
DomainName() *string
// The Route53 alias target to use in order to connect a record set to this domain through an alias.
DomainNameAliasDomainName() *string
// The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
DomainNameAliasHostedZoneId() *string
}
func DomainName_FromDomainNameAttributes ¶
func DomainName_FromDomainNameAttributes(scope constructs.Construct, id *string, attrs *DomainNameAttributes) IDomainName
Imports an existing domain name.
type IGatewayResponse ¶
type IGatewayResponse interface {
awscdk.IResource
}
Represents gateway response resource.
type IModel ¶
type IModel interface {
// Returns the model name, such as 'myModel'.
ModelId() *string
}
func Model_EMPTY_MODEL ¶
func Model_EMPTY_MODEL() IModel
func Model_ERROR_MODEL ¶
func Model_ERROR_MODEL() IModel
func Model_FromModelName ¶
type IRequestValidator ¶
type IRequestValidator interface {
awscdk.IResource
// ID of the request validator, such as abc123.
RequestValidatorId() *string
}
func RequestValidator_FromRequestValidatorId ¶
func RequestValidator_FromRequestValidatorId(scope constructs.Construct, id *string, requestValidatorId *string) IRequestValidator
type IResource ¶
type IResource interface {
awscdk.IResource
// Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.
//
// Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional
// HTTP headers to tell browsers to give a web application running at one
// origin, access to selected resources from a different origin. A web
// application executes a cross-origin HTTP request when it requests a
// resource that has a different origin (domain, protocol, or port) from its
// own.
//
// Returns: a `Method` object
// See: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
//
AddCorsPreflight(options *CorsOptions) Method
// Defines a new method for this resource.
//
// Returns: The newly created `Method` object.
AddMethod(httpMethod *string, target Integration, options *MethodOptions) Method
// Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
AddProxy(options *ProxyResourceOptions) ProxyResource
// Defines a new child resource where this resource is the parent.
//
// Returns: A Resource object
AddResource(pathPart *string, options *ResourceOptions) Resource
// Retrieves a child resource by path part.
//
// Returns: the child resource or undefined if not found
GetResource(pathPart *string) IResource
// Gets or create all resources leading up to the specified path.
//
// - Path may only start with "/" if this method is called on the root resource.
// - All resources are created using default options.
//
// Returns: a new or existing resource.
ResourceForPath(path *string) Resource
// The rest API that this resource is part of.
//
// The reason we need the RestApi object itself and not just the ID is because the model
// is being tracked by the top-level RestApi object for the purpose of calculating it's
// hash to determine the ID of the deployment. This allows us to automatically update
// the deployment when the model of the REST API changes.
Api() IRestApi
// Default options for CORS preflight OPTIONS method.
DefaultCorsPreflightOptions() *CorsOptions
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration() Integration
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions() *MethodOptions
// The parent of this resource or undefined for the root resource.
ParentResource() IResource
// The full path of this resource.
Path() *string
// The ID of the resource.
ResourceId() *string
}
func ProxyResource_FromResourceAttributes ¶
func ProxyResource_FromResourceAttributes(scope constructs.Construct, id *string, attrs *ResourceAttributes) IResource
Import an existing resource.
func Resource_FromResourceAttributes ¶
func Resource_FromResourceAttributes(scope constructs.Construct, id *string, attrs *ResourceAttributes) IResource
Import an existing resource.
type IRestApi ¶
type IRestApi interface {
awscdk.IResource
// Gets the "execute-api" ARN.
//
// Returns: The "execute-api" ARN.
ArnForExecuteApi(method *string, path *string, stage *string) *string
// API Gateway stage that points to the latest deployment (if defined).
DeploymentStage() Stage
// API Gateway stage that points to the latest deployment (if defined).
SetDeploymentStage(d Stage)
// API Gateway deployment that represents the latest changes of the API.
//
// This resource will be automatically updated every time the REST API model changes.
// `undefined` when no deployment is configured.
LatestDeployment() Deployment
// The ID of this API Gateway RestApi.
RestApiId() *string
// The resource ID of the root resource.
RestApiRootResourceId() *string
// Represents the root resource ("/") of this API. Use it to define the API model:.
//
// api.root.addMethod('ANY', redirectToHomePage); // "ANY /"
// api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"
Root() IResource
}
func LambdaRestApi_FromRestApiAttributes ¶
func LambdaRestApi_FromRestApiAttributes(scope constructs.Construct, id *string, attrs *RestApiAttributes) IRestApi
Import an existing RestApi that can be configured with additional Methods and Resources.
func LambdaRestApi_FromRestApiId ¶
func LambdaRestApi_FromRestApiId(scope constructs.Construct, id *string, restApiId *string) IRestApi
Import an existing RestApi.
func RestApi_FromRestApiAttributes ¶
func RestApi_FromRestApiAttributes(scope constructs.Construct, id *string, attrs *RestApiAttributes) IRestApi
Import an existing RestApi that can be configured with additional Methods and Resources.
func RestApi_FromRestApiId ¶
Import an existing RestApi.
type IStage ¶
type IStage interface {
awscdk.IResource
// RestApi to which this stage is associated.
RestApi() IRestApi
// Name of this stage.
StageName() *string
}
Represents an APIGateway Stage.
type IUsagePlan ¶
type IUsagePlan interface {
awscdk.IResource
// Adds an ApiKey.
AddApiKey(apiKey IApiKey, options *AddApiKeyOptions)
// Id of the usage plan.
UsagePlanId() *string
}
A UsagePlan, either managed by this CDK app, or imported.
func UsagePlan_FromUsagePlanId ¶
func UsagePlan_FromUsagePlanId(scope constructs.Construct, id *string, usagePlanId *string) IUsagePlan
Import an externally defined usage plan using its ARN.
type IVpcLink ¶
type IVpcLink interface {
awscdk.IResource
// Physical ID of the VpcLink resource.
VpcLinkId() *string
}
Represents an API Gateway VpcLink.
func VpcLink_FromVpcLinkId ¶
Import a VPC Link by its Id.
type IdentitySource ¶
type IdentitySource interface {
}
Represents an identity source.
The source can be specified either as a literal value (e.g: `Auth`) which cannot be blank, or as an unresolved string token.
TODO: EXAMPLE
func NewIdentitySource ¶
func NewIdentitySource() IdentitySource
type InlineApiDefinition ¶
type InlineApiDefinition interface {
ApiDefinition
Bind(_scope constructs.Construct) *ApiDefinitionConfig
BindAfterCreate(_scope constructs.Construct, _restApi IRestApi)
}
OpenAPI specification from an inline JSON object.
TODO: EXAMPLE
func ApiDefinition_FromInline ¶
func ApiDefinition_FromInline(definition interface{}) InlineApiDefinition
Create an API definition from an inline object.
The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0
TODO: EXAMPLE
func AssetApiDefinition_FromInline ¶
func AssetApiDefinition_FromInline(definition interface{}) InlineApiDefinition
Create an API definition from an inline object.
The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0
TODO: EXAMPLE
func InlineApiDefinition_FromInline ¶
func InlineApiDefinition_FromInline(definition interface{}) InlineApiDefinition
Create an API definition from an inline object.
The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0
TODO: EXAMPLE
func NewInlineApiDefinition ¶
func NewInlineApiDefinition(definition interface{}) InlineApiDefinition
func S3ApiDefinition_FromInline ¶
func S3ApiDefinition_FromInline(definition interface{}) InlineApiDefinition
Create an API definition from an inline object.
The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0
TODO: EXAMPLE
type Integration ¶
type Integration interface {
Bind(_method Method) *IntegrationConfig
}
Base class for backend integrations for an API Gateway method.
Use one of the concrete classes such as `MockIntegration`, `AwsIntegration`, `LambdaIntegration` or implement on your own by specifying the set of props.
TODO: EXAMPLE
func NewIntegration ¶
func NewIntegration(props *IntegrationProps) Integration
type IntegrationConfig ¶
type IntegrationConfig struct {
// This value is included in computing the Deployment's fingerprint.
//
// When the fingerprint
// changes, a new deployment is triggered.
// This property should contain values associated with the Integration that upon changing
// should trigger a fresh the Deployment needs to be refreshed.
DeploymentToken *string `json:"deploymentToken"`
// The integration's HTTP method type.
IntegrationHttpMethod *string `json:"integrationHttpMethod"`
// Integration options.
Options *IntegrationOptions `json:"options"`
// Specifies an API method integration type.
Type IntegrationType `json:"type"`
// The Uniform Resource Identifier (URI) for the integration.
// See: https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri
//
Uri *string `json:"uri"`
}
Result of binding an Integration to a Method.
TODO: EXAMPLE
type IntegrationOptions ¶
type IntegrationOptions struct {
// A list of request parameters whose values are to be cached.
//
// It determines
// request parameters that will make it into the cache key.
CacheKeyParameters *[]*string `json:"cacheKeyParameters"`
// An API-specific tag group of related cached parameters.
CacheNamespace *string `json:"cacheNamespace"`
// The type of network connection to the integration endpoint.
ConnectionType ConnectionType `json:"connectionType"`
// Specifies how to handle request payload content type conversions.
ContentHandling ContentHandling `json:"contentHandling"`
// Requires that the caller's identity be passed through from the request.
CredentialsPassthrough *bool `json:"credentialsPassthrough"`
// An IAM role that API Gateway assumes.
//
// Mutually exclusive with `credentialsPassThrough`.
CredentialsRole awsiam.IRole `json:"credentialsRole"`
// The response that API Gateway provides after a method's backend completes processing a request.
//
// API Gateway intercepts the response from the
// backend so that you can control how API Gateway surfaces backend
// responses. For example, you can map the backend status codes to codes
// that you define.
IntegrationResponses *[]*IntegrationResponse `json:"integrationResponses"`
// Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
//
// There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
// NEVER.
PassthroughBehavior PassthroughBehavior `json:"passthroughBehavior"`
// The request parameters that API Gateway sends with the backend request.
//
// Specify request parameters as key-value pairs (string-to-string
// mappings), with a destination as the key and a source as the value.
//
// Specify the destination by using the following pattern
// integration.request.location.name, where location is querystring, path,
// or header, and name is a valid, unique parameter name.
//
// The source must be an existing method request parameter or a static
// value. You must enclose static values in single quotation marks and
// pre-encode these values based on their destination in the request.
RequestParameters *map[string]*string `json:"requestParameters"`
// A map of Apache Velocity templates that are applied on the request payload.
//
// The template that API Gateway uses is based on the value of the
// Content-Type header that's sent by the client. The content type value is
// the key, and the template is the value (specified as a string), such as
// the following snippet:
//
// “`
// { "application/json": "{ \"statusCode\": 200 }" }
// “`
// See: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
//
RequestTemplates *map[string]*string `json:"requestTemplates"`
// The maximum amount of time an integration will run before it returns without a response.
//
// Must be between 50 milliseconds and 29 seconds.
Timeout awscdk.Duration `json:"timeout"`
// The VpcLink used for the integration.
//
// Required if connectionType is VPC_LINK
VpcLink IVpcLink `json:"vpcLink"`
}
TODO: EXAMPLE
type IntegrationProps ¶
type IntegrationProps struct {
// The integration's HTTP method type.
//
// Required unless you use a MOCK integration.
IntegrationHttpMethod *string `json:"integrationHttpMethod"`
// Integration options.
Options *IntegrationOptions `json:"options"`
// Specifies an API method integration type.
Type IntegrationType `json:"type"`
// The Uniform Resource Identifier (URI) for the integration.
//
// - If you specify HTTP for the `type` property, specify the API endpoint URL.
// - If you specify MOCK for the `type` property, don't specify this property.
// - If you specify AWS for the `type` property, specify an AWS service that
// follows this form: `arn:partition:apigateway:region:subdomain.service|service:path|action/service_api.`
// For example, a Lambda function URI follows this form:
// arn:partition:apigateway:region:lambda:path/path. The path is usually in the
// form /2015-03-31/functions/LambdaFunctionARN/invocations.
// See: https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri
//
Uri interface{} `json:"uri"`
}
TODO: EXAMPLE
type IntegrationResponse ¶
type IntegrationResponse struct {
// Specifies how to handle request payload content type conversions.
ContentHandling ContentHandling `json:"contentHandling"`
// The response parameters from the backend response that API Gateway sends to the method response.
//
// Use the destination as the key and the source as the value:
//
// - The destination must be an existing response parameter in the
// MethodResponse property.
// - The source must be an existing method request parameter or a static
// value. You must enclose static values in single quotation marks and
// pre-encode these values based on the destination specified in the
// request.
// See: http://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html
//
ResponseParameters *map[string]*string `json:"responseParameters"`
// The templates that are used to transform the integration response body.
//
// Specify templates as key-value pairs, with a content type as the key and
// a template as the value.
// See: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
//
ResponseTemplates *map[string]*string `json:"responseTemplates"`
// Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
//
// For example, if the success response returns nothing and the error response returns some string, you
// could use the “.+“ regex to match error response. However, make sure that the error response does not contain any
// newline (“\n“) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error
// header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-integration-settings-integration-response.html
//
SelectionPattern *string `json:"selectionPattern"`
// The status code that API Gateway uses to map the integration response to a MethodResponse status code.
StatusCode *string `json:"statusCode"`
}
TODO: EXAMPLE
type IntegrationType ¶
type IntegrationType string
TODO: EXAMPLE
const ( IntegrationType_AWS IntegrationType = "AWS" IntegrationType_AWS_PROXY IntegrationType = "AWS_PROXY" IntegrationType_HTTP IntegrationType = "HTTP" IntegrationType_HTTP_PROXY IntegrationType = "HTTP_PROXY" IntegrationType_MOCK IntegrationType = "MOCK" )
type JsonSchema ¶
type JsonSchema struct {
AdditionalItems *[]*JsonSchema `json:"additionalItems"`
AdditionalProperties interface{} `json:"additionalProperties"`
AllOf *[]*JsonSchema `json:"allOf"`
AnyOf *[]*JsonSchema `json:"anyOf"`
Contains interface{} `json:"contains"`
// The default value if you use an enum.
Default interface{} `json:"default"`
Definitions *map[string]*JsonSchema `json:"definitions"`
Dependencies *map[string]interface{} `json:"dependencies"`
Description *string `json:"description"`
Enum *[]interface{} `json:"enum"`
ExclusiveMaximum *bool `json:"exclusiveMaximum"`
ExclusiveMinimum *bool `json:"exclusiveMinimum"`
Format *string `json:"format"`
Id *string `json:"id"`
Items interface{} `json:"items"`
Maximum *float64 `json:"maximum"`
MaxItems *float64 `json:"maxItems"`
MaxLength *float64 `json:"maxLength"`
MaxProperties *float64 `json:"maxProperties"`
Minimum *float64 `json:"minimum"`
MinItems *float64 `json:"minItems"`
MinLength *float64 `json:"minLength"`
MinProperties *float64 `json:"minProperties"`
MultipleOf *float64 `json:"multipleOf"`
Not **JsonSchema `json:"not"`
OneOf *[]*JsonSchema `json:"oneOf"`
Pattern *string `json:"pattern"`
PatternProperties *map[string]*JsonSchema `json:"patternProperties"`
Properties *map[string]*JsonSchema `json:"properties"`
PropertyNames **JsonSchema `json:"propertyNames"`
Ref *string `json:"ref"`
Required *[]*string `json:"required"`
Schema JsonSchemaVersion `json:"schema"`
Title *string `json:"title"`
Type interface{} `json:"type"`
UniqueItems *bool `json:"uniqueItems"`
}
Represents a JSON schema definition of the structure of a REST API model.
Copied from npm module jsonschema.
TODO: EXAMPLE
type JsonSchemaType ¶
type JsonSchemaType string
TODO: EXAMPLE
const ( JsonSchemaType_ARRAY JsonSchemaType = "ARRAY" JsonSchemaType_BOOLEAN JsonSchemaType = "BOOLEAN" JsonSchemaType_INTEGER JsonSchemaType = "INTEGER" JsonSchemaType_NULL JsonSchemaType = "NULL" JsonSchemaType_NUMBER JsonSchemaType = "NUMBER" JsonSchemaType_OBJECT JsonSchemaType = "OBJECT" JsonSchemaType_STRING JsonSchemaType = "STRING" )
type JsonSchemaVersion ¶
type JsonSchemaVersion string
TODO: EXAMPLE
const ( JsonSchemaVersion_DRAFT4 JsonSchemaVersion = "DRAFT4" JsonSchemaVersion_DRAFT7 JsonSchemaVersion = "DRAFT7" )
type JsonWithStandardFieldProps ¶
type JsonWithStandardFieldProps struct {
// If this flag is enabled, the principal identifier of the caller will be output to the log.
Caller *bool `json:"caller"`
// If this flag is enabled, the http method will be output to the log.
HttpMethod *bool `json:"httpMethod"`
// If this flag is enabled, the source IP of request will be output to the log.
Ip *bool `json:"ip"`
// If this flag is enabled, the request protocol will be output to the log.
Protocol *bool `json:"protocol"`
// If this flag is enabled, the CLF-formatted request time((dd/MMM/yyyy:HH:mm:ss +-hhmm) will be output to the log.
RequestTime *bool `json:"requestTime"`
// If this flag is enabled, the path to your resource will be output to the log.
ResourcePath *bool `json:"resourcePath"`
// If this flag is enabled, the response payload length will be output to the log.
ResponseLength *bool `json:"responseLength"`
// If this flag is enabled, the method response status will be output to the log.
Status *bool `json:"status"`
// If this flag is enabled, the principal identifier of the user will be output to the log.
User *bool `json:"user"`
}
Properties for controlling items output in JSON standard format.
TODO: EXAMPLE
type LambdaAuthorizerProps ¶
type LambdaAuthorizerProps struct {
// An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer.
//
// The IAM role must be
// assumable by 'apigateway.amazonaws.com'.
AssumeRole awsiam.IRole `json:"assumeRole"`
// An optional human friendly name for the authorizer.
//
// Note that, this is not the primary identifier of the authorizer.
AuthorizerName *string `json:"authorizerName"`
// The handler for the authorizer lambda function.
//
// The handler must follow a very specific protocol on the input it receives and the output it needs to produce.
// API Gateway has documented the handler's input specification
// {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification
// {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.
Handler awslambda.IFunction `json:"handler"`
// How long APIGateway should cache the results.
//
// Max 1 hour.
// Disable caching by setting this to 0.
ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl"`
}
Base properties for all lambda authorizers.
TODO: EXAMPLE
type LambdaIntegration ¶
type LambdaIntegration interface {
AwsIntegration
Bind(method Method) *IntegrationConfig
}
Integrates an AWS Lambda function to an API Gateway method.
TODO: EXAMPLE
func NewLambdaIntegration ¶
func NewLambdaIntegration(handler awslambda.IFunction, options *LambdaIntegrationOptions) LambdaIntegration
type LambdaIntegrationOptions ¶
type LambdaIntegrationOptions struct {
// A list of request parameters whose values are to be cached.
//
// It determines
// request parameters that will make it into the cache key.
CacheKeyParameters *[]*string `json:"cacheKeyParameters"`
// An API-specific tag group of related cached parameters.
CacheNamespace *string `json:"cacheNamespace"`
// The type of network connection to the integration endpoint.
ConnectionType ConnectionType `json:"connectionType"`
// Specifies how to handle request payload content type conversions.
ContentHandling ContentHandling `json:"contentHandling"`
// Requires that the caller's identity be passed through from the request.
CredentialsPassthrough *bool `json:"credentialsPassthrough"`
// An IAM role that API Gateway assumes.
//
// Mutually exclusive with `credentialsPassThrough`.
CredentialsRole awsiam.IRole `json:"credentialsRole"`
// The response that API Gateway provides after a method's backend completes processing a request.
//
// API Gateway intercepts the response from the
// backend so that you can control how API Gateway surfaces backend
// responses. For example, you can map the backend status codes to codes
// that you define.
IntegrationResponses *[]*IntegrationResponse `json:"integrationResponses"`
// Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
//
// There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
// NEVER.
PassthroughBehavior PassthroughBehavior `json:"passthroughBehavior"`
// The request parameters that API Gateway sends with the backend request.
//
// Specify request parameters as key-value pairs (string-to-string
// mappings), with a destination as the key and a source as the value.
//
// Specify the destination by using the following pattern
// integration.request.location.name, where location is querystring, path,
// or header, and name is a valid, unique parameter name.
//
// The source must be an existing method request parameter or a static
// value. You must enclose static values in single quotation marks and
// pre-encode these values based on their destination in the request.
RequestParameters *map[string]*string `json:"requestParameters"`
// A map of Apache Velocity templates that are applied on the request payload.
//
// The template that API Gateway uses is based on the value of the
// Content-Type header that's sent by the client. The content type value is
// the key, and the template is the value (specified as a string), such as
// the following snippet:
//
// “`
// { "application/json": "{ \"statusCode\": 200 }" }
// “`
// See: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
//
RequestTemplates *map[string]*string `json:"requestTemplates"`
// The maximum amount of time an integration will run before it returns without a response.
//
// Must be between 50 milliseconds and 29 seconds.
Timeout awscdk.Duration `json:"timeout"`
// The VpcLink used for the integration.
//
// Required if connectionType is VPC_LINK
VpcLink IVpcLink `json:"vpcLink"`
// Allow invoking method from AWS Console UI (for testing purposes).
//
// This will add another permission to the AWS Lambda resource policy which
// will allow the `test-invoke-stage` stage to invoke this handler. If this
// is set to `false`, the function will only be usable from the deployment
// endpoint.
AllowTestInvoke *bool `json:"allowTestInvoke"`
// Use proxy integration or normal (request/response mapping) integration.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
//
Proxy *bool `json:"proxy"`
}
TODO: EXAMPLE
type LambdaRestApi ¶
type LambdaRestApi interface {
RestApi
DeploymentStage() Stage
SetDeploymentStage(val Stage)
DomainName() DomainName
Env() *awscdk.ResourceEnvironment
LatestDeployment() Deployment
Methods() *[]Method
Node() constructs.Node
PhysicalName() *string
RestApiId() *string
RestApiName() *string
RestApiRootResourceId() *string
Root() IResource
Stack() awscdk.Stack
Url() *string
AddApiKey(id *string, options *ApiKeyOptions) IApiKey
AddDomainName(id *string, options *DomainNameOptions) DomainName
AddGatewayResponse(id *string, options *GatewayResponseOptions) GatewayResponse
AddModel(id *string, props *ModelOptions) Model
AddRequestValidator(id *string, props *RequestValidatorOptions) RequestValidator
AddUsagePlan(id *string, props *UsagePlanProps) UsagePlan
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
ArnForExecuteApi(method *string, path *string, stage *string) *string
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheHitCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheMissCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
ToString() *string
UrlForPath(path *string) *string
}
Defines an API Gateway REST API with AWS Lambda proxy integration.
Use the `proxy` property to define a greedy proxy ("{proxy+}") and "ANY" method from the specified path. If not defined, you will need to explicity add resources and methods to the API.
TODO: EXAMPLE
func NewLambdaRestApi ¶
func NewLambdaRestApi(scope constructs.Construct, id *string, props *LambdaRestApiProps) LambdaRestApi
type LambdaRestApiProps ¶
type LambdaRestApiProps struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// Automatically configure an AWS CloudWatch role for API Gateway.
CloudWatchRole *bool `json:"cloudWatchRole"`
// Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
//
// Since API Gateway deployments are immutable, When this option is enabled
// (by default), an AWS::ApiGateway::Deployment resource will automatically
// created with a logical ID that hashes the API model (methods, resources
// and options). This means that when the model changes, the logical ID of
// this CloudFormation resource will change, and a new deployment will be
// created.
//
// If this is set, `latestDeployment` will refer to the `Deployment` object
// and `deploymentStage` will refer to a `Stage` that points to this
// deployment. To customize the stage options, use the `deployOptions`
// property.
//
// A CloudFormation Output will also be defined with the root URL endpoint
// of this REST API.
Deploy *bool `json:"deploy"`
// Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
//
// If `deploy` is disabled,
// this value cannot be set.
DeployOptions *StageOptions `json:"deployOptions"`
// Specifies whether clients can invoke the API using the default execute-api endpoint.
//
// To require that clients use a custom domain name to invoke the
// API, disable the default endpoint.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
//
DisableExecuteApiEndpoint *bool `json:"disableExecuteApiEndpoint"`
// Configure a custom domain name and map it to this API.
DomainName *DomainNameOptions `json:"domainName"`
// Export name for the CfnOutput containing the API endpoint.
EndpointExportName *string `json:"endpointExportName"`
// A list of the endpoint types of the API.
//
// Use this property when creating
// an API.
EndpointTypes *[]EndpointType `json:"endpointTypes"`
// Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
FailOnWarnings *bool `json:"failOnWarnings"`
// Custom header parameters for the request.
// See: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
//
Parameters *map[string]*string `json:"parameters"`
// A policy document that contains the permissions for this RestApi.
Policy awsiam.PolicyDocument `json:"policy"`
// A name for the API Gateway RestApi resource.
RestApiName *string `json:"restApiName"`
// Retains old deployment resources when the API changes.
//
// This allows
// manually reverting stages to point to old deployments via the AWS
// Console.
RetainDeployments *bool `json:"retainDeployments"`
// The source of the API key for metering requests according to a usage plan.
ApiKeySourceType ApiKeySourceType `json:"apiKeySourceType"`
// The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
BinaryMediaTypes *[]*string `json:"binaryMediaTypes"`
// The ID of the API Gateway RestApi resource that you want to clone.
CloneFrom IRestApi `json:"cloneFrom"`
// A description of the purpose of this API Gateway RestApi resource.
Description *string `json:"description"`
// The EndpointConfiguration property type specifies the endpoint types of a REST API.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
//
EndpointConfiguration *EndpointConfiguration `json:"endpointConfiguration"`
// A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
//
// When compression is enabled, compression or
// decompression is not applied on the payload if the payload size is
// smaller than this value. Setting it to zero allows compression for any
// payload size.
MinimumCompressionSize *float64 `json:"minimumCompressionSize"`
// The default Lambda function that handles all requests from this API.
//
// This handler will be used as a the default integration for all methods in
// this API, unless specified otherwise in `addMethod`.
Handler awslambda.IFunction `json:"handler"`
// If true, route all requests to the Lambda Function.
//
// If set to false, you will need to explicitly define the API model using
// `addResource` and `addMethod` (or `addProxy`).
Proxy *bool `json:"proxy"`
}
TODO: EXAMPLE
type LogGroupLogDestination ¶
type LogGroupLogDestination interface {
IAccessLogDestination
Bind(_stage IStage) *AccessLogDestinationConfig
}
Use CloudWatch Logs as a custom access log destination for API Gateway.
TODO: EXAMPLE
func NewLogGroupLogDestination ¶
func NewLogGroupLogDestination(logGroup awslogs.ILogGroup) LogGroupLogDestination
type MTLSConfig ¶
type MTLSConfig struct {
// The bucket that the trust store is hosted in.
Bucket awss3.IBucket `json:"bucket"`
// The key in S3 to look at for the trust store.
Key *string `json:"key"`
// The version of the S3 object that contains your truststore.
//
// To specify a version, you must have versioning enabled for the S3 bucket.
Version *string `json:"version"`
}
The mTLS authentication configuration for a custom domain name.
TODO: EXAMPLE
type Method ¶
type Method interface {
awscdk.Resource
Api() IRestApi
Env() *awscdk.ResourceEnvironment
HttpMethod() *string
MethodArn() *string
MethodId() *string
Node() constructs.Node
PhysicalName() *string
Resource() IResource
Stack() awscdk.Stack
TestMethodArn() *string
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
TODO: EXAMPLE
func NewMethod ¶
func NewMethod(scope constructs.Construct, id *string, props *MethodProps) Method
type MethodDeploymentOptions ¶
type MethodDeploymentOptions struct {
// Indicates whether the cached responses are encrypted.
CacheDataEncrypted *bool `json:"cacheDataEncrypted"`
// Specifies the time to live (TTL), in seconds, for cached responses.
//
// The
// higher the TTL, the longer the response will be cached.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
//
CacheTtl awscdk.Duration `json:"cacheTtl"`
// Specifies whether responses should be cached and returned for requests.
//
// A
// cache cluster must be enabled on the stage for responses to be cached.
CachingEnabled *bool `json:"cachingEnabled"`
// Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
DataTraceEnabled *bool `json:"dataTraceEnabled"`
// Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
LoggingLevel MethodLoggingLevel `json:"loggingLevel"`
// Specifies whether Amazon CloudWatch metrics are enabled for this method.
MetricsEnabled *bool `json:"metricsEnabled"`
// Specifies the throttling burst limit.
//
// The total rate of all requests in your AWS account is limited to 5,000 requests.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
//
ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
// Specifies the throttling rate limit.
//
// The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
//
ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
}
TODO: EXAMPLE
type MethodLoggingLevel ¶
type MethodLoggingLevel string
TODO: EXAMPLE
const ( MethodLoggingLevel_ERROR MethodLoggingLevel = "ERROR" MethodLoggingLevel_INFO MethodLoggingLevel = "INFO" MethodLoggingLevel_OFF MethodLoggingLevel = "OFF" )
type MethodOptions ¶
type MethodOptions struct {
// Indicates whether the method requires clients to submit a valid API key.
ApiKeyRequired *bool `json:"apiKeyRequired"`
// A list of authorization scopes configured on the method.
//
// The scopes are used with
// a COGNITO_USER_POOLS authorizer to authorize the method invocation.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
//
AuthorizationScopes *[]*string `json:"authorizationScopes"`
// Method authorization. If the value is set of `Custom`, an `authorizer` must also be specified.
//
// If you're using one of the authorizers that are available via the {@link Authorizer} class, such as {@link Authorizer#token()},
// it is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type.
// However, specifying an authorization type using this property that conflicts with what is expected by the {@link Authorizer}
// will result in an error.
AuthorizationType AuthorizationType `json:"authorizationType"`
// If `authorizationType` is `Custom`, this specifies the ID of the method authorizer resource.
//
// If specified, the value of `authorizationType` must be set to `Custom`
Authorizer IAuthorizer `json:"authorizer"`
// The responses that can be sent to the client who calls the method.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-response.html
//
MethodResponses *[]*MethodResponse `json:"methodResponses"`
// A friendly operation name for the method.
//
// For example, you can assign the
// OperationName of ListPets for the GET /pets method.
OperationName *string `json:"operationName"`
// The models which describe data structure of request payload.
//
// When
// combined with `requestValidator` or `requestValidatorOptions`, the service
// will validate the API request payload before it reaches the API's Integration (including proxies).
// Specify `requestModels` as key-value pairs, with a content type
// (e.g. `'application/json'`) as the key and an API Gateway Model as the value.
//
// TODO: EXAMPLE
//
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-request-model
//
RequestModels *map[string]IModel `json:"requestModels"`
// The request parameters that API Gateway accepts.
//
// Specify request parameters
// as key-value pairs (string-to-Boolean mapping), with a source as the key and
// a Boolean as the value. The Boolean specifies whether a parameter is required.
// A source must match the format method.request.location.name, where the location
// is querystring, path, or header, and name is a valid, unique parameter name.
RequestParameters *map[string]*bool `json:"requestParameters"`
// The ID of the associated request validator.
//
// Only one of `requestValidator` or `requestValidatorOptions` must be specified.
// Works together with `requestModels` or `requestParameters` to validate
// the request before it reaches integration like Lambda Proxy Integration.
RequestValidator IRequestValidator `json:"requestValidator"`
// Request validator options to create new validator Only one of `requestValidator` or `requestValidatorOptions` must be specified.
//
// Works together with `requestModels` or `requestParameters` to validate
// the request before it reaches integration like Lambda Proxy Integration.
RequestValidatorOptions *RequestValidatorOptions `json:"requestValidatorOptions"`
}
TODO: EXAMPLE
type MethodProps ¶
type MethodProps struct {
// The HTTP method ("GET", "POST", "PUT", ...) that clients use to call this method.
HttpMethod *string `json:"httpMethod"`
// The backend system that the method calls when it receives a request.
Integration Integration `json:"integration"`
// Method options.
Options *MethodOptions `json:"options"`
// The resource this method is associated with.
//
// For root resource methods,
// specify the `RestApi` object.
Resource IResource `json:"resource"`
}
TODO: EXAMPLE
type MethodResponse ¶
type MethodResponse struct {
// The resources used for the response's content type.
//
// Specify response models as
// key-value pairs (string-to-string maps), with a content type as the key and a Model
// resource name as the value.
ResponseModels *map[string]IModel `json:"responseModels"`
// Response parameters that API Gateway sends to the client that called a method.
//
// Specify response parameters as key-value pairs (string-to-Boolean maps), with
// a destination as the key and a Boolean as the value. Specify the destination
// using the following pattern: method.response.header.name, where the name is a
// valid, unique header name. The Boolean specifies whether a parameter is required.
ResponseParameters *map[string]*bool `json:"responseParameters"`
// The method response's status code, which you map to an IntegrationResponse.
//
// Required.
StatusCode *string `json:"statusCode"`
}
TODO: EXAMPLE
type MockIntegration ¶
type MockIntegration interface {
Integration
Bind(_method Method) *IntegrationConfig
}
This type of integration lets API Gateway return a response without sending the request further to the backend.
This is useful for API testing because it can be used to test the integration set up without incurring charges for using the backend and to enable collaborative development of an API. In collaborative development, a team can isolate their development effort by setting up simulations of API components owned by other teams by using the MOCK integrations. It is also used to return CORS-related headers to ensure that the API method permits CORS access. In fact, the API Gateway console integrates the OPTIONS method to support CORS with a mock integration. Gateway responses are other examples of mock integrations.
TODO: EXAMPLE
func NewMockIntegration ¶
func NewMockIntegration(options *IntegrationOptions) MockIntegration
type Model ¶
type Model interface {
awscdk.Resource
IModel
Env() *awscdk.ResourceEnvironment
ModelId() *string
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
TODO: EXAMPLE
func NewModel ¶
func NewModel(scope constructs.Construct, id *string, props *ModelProps) Model
type ModelOptions ¶
type ModelOptions struct {
// The content type for the model.
//
// You can also force a
// content type in the request or response model mapping.
ContentType *string `json:"contentType"`
// A description that identifies this model.
Description *string `json:"description"`
// A name for the model.
//
// Important
// If you specify a name, you cannot perform updates that
// require replacement of this resource. You can perform
// updates that require no or some interruption. If you
// must replace the resource, specify a new name.
ModelName *string `json:"modelName"`
// The schema to use to transform data to one or more output formats.
//
// Specify null ({}) if you don't want to specify a schema.
Schema *JsonSchema `json:"schema"`
}
TODO: EXAMPLE
type ModelProps ¶
type ModelProps struct {
// The content type for the model.
//
// You can also force a
// content type in the request or response model mapping.
ContentType *string `json:"contentType"`
// A description that identifies this model.
Description *string `json:"description"`
// A name for the model.
//
// Important
// If you specify a name, you cannot perform updates that
// require replacement of this resource. You can perform
// updates that require no or some interruption. If you
// must replace the resource, specify a new name.
ModelName *string `json:"modelName"`
// The schema to use to transform data to one or more output formats.
//
// Specify null ({}) if you don't want to specify a schema.
Schema *JsonSchema `json:"schema"`
// The rest API that this model is part of.
//
// The reason we need the RestApi object itself and not just the ID is because the model
// is being tracked by the top-level RestApi object for the purpose of calculating it's
// hash to determine the ID of the deployment. This allows us to automatically update
// the deployment when the model of the REST API changes.
RestApi IRestApi `json:"restApi"`
}
TODO: EXAMPLE
type PassthroughBehavior ¶
type PassthroughBehavior string
TODO: EXAMPLE
const ( PassthroughBehavior_NEVER PassthroughBehavior = "NEVER" PassthroughBehavior_WHEN_NO_MATCH PassthroughBehavior = "WHEN_NO_MATCH" PassthroughBehavior_WHEN_NO_TEMPLATES PassthroughBehavior = "WHEN_NO_TEMPLATES" )
type ProxyResource ¶
type ProxyResource interface {
Resource
AnyMethod() Method
Api() IRestApi
DefaultCorsPreflightOptions() *CorsOptions
DefaultIntegration() Integration
DefaultMethodOptions() *MethodOptions
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
ParentResource() IResource
Path() *string
PhysicalName() *string
ResourceId() *string
Stack() awscdk.Stack
AddCorsPreflight(options *CorsOptions) Method
AddMethod(httpMethod *string, integration Integration, options *MethodOptions) Method
AddProxy(options *ProxyResourceOptions) ProxyResource
AddResource(pathPart *string, options *ResourceOptions) Resource
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResource(pathPart *string) IResource
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ResourceForPath(path *string) Resource
ToString() *string
}
Defines a {proxy+} greedy resource and an ANY method on a route.
TODO: EXAMPLE
See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html
func NewProxyResource ¶
func NewProxyResource(scope constructs.Construct, id *string, props *ProxyResourceProps) ProxyResource
type ProxyResourceOptions ¶
type ProxyResourceOptions struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// Adds an "ANY" method to this resource.
//
// If set to `false`, you will have to explicitly
// add methods to this resource after it's created.
AnyMethod *bool `json:"anyMethod"`
}
TODO: EXAMPLE
type ProxyResourceProps ¶
type ProxyResourceProps struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// Adds an "ANY" method to this resource.
//
// If set to `false`, you will have to explicitly
// add methods to this resource after it's created.
AnyMethod *bool `json:"anyMethod"`
// The parent resource of this resource.
//
// You can either pass another
// `Resource` object or a `RestApi` object here.
Parent IResource `json:"parent"`
}
TODO: EXAMPLE
type QuotaSettings ¶
type QuotaSettings struct {
// The maximum number of requests that users can make within the specified time period.
Limit *float64 `json:"limit"`
// For the initial time period, the number of requests to subtract from the specified limit.
Offset *float64 `json:"offset"`
// The time period for which the maximum limit of requests applies.
Period Period `json:"period"`
}
Specifies the maximum number of requests that clients can make to API Gateway APIs.
TODO: EXAMPLE
type RateLimitedApiKey ¶
type RateLimitedApiKey interface {
awscdk.Resource
IApiKey
Env() *awscdk.ResourceEnvironment
KeyArn() *string
KeyId() *string
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
GrantRead(grantee awsiam.IGrantable) awsiam.Grant
GrantReadWrite(grantee awsiam.IGrantable) awsiam.Grant
GrantWrite(grantee awsiam.IGrantable) awsiam.Grant
ToString() *string
}
An API Gateway ApiKey, for which a rate limiting configuration can be specified.
TODO: EXAMPLE
func NewRateLimitedApiKey ¶
func NewRateLimitedApiKey(scope constructs.Construct, id *string, props *RateLimitedApiKeyProps) RateLimitedApiKey
type RateLimitedApiKeyProps ¶
type RateLimitedApiKeyProps struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// A name for the API key.
//
// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
ApiKeyName *string `json:"apiKeyName"`
// A description of the purpose of the API key.
Description *string `json:"description"`
// The value of the API key.
//
// Must be at least 20 characters long.
Value *string `json:"value"`
// An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
CustomerId *string `json:"customerId"`
// Indicates whether the API key can be used by clients.
Enabled *bool `json:"enabled"`
// Specifies whether the key identifier is distinct from the created API key value.
GenerateDistinctId *bool `json:"generateDistinctId"`
// A list of resources this api key is associated with.
Resources *[]IRestApi `json:"resources"`
// API Stages to be associated with the RateLimitedApiKey.
ApiStages *[]*UsagePlanPerApiStage `json:"apiStages"`
// Number of requests clients can make in a given time period.
Quota *QuotaSettings `json:"quota"`
// Overall throttle settings for the API.
Throttle *ThrottleSettings `json:"throttle"`
}
RateLimitedApiKey properties.
TODO: EXAMPLE
type RequestAuthorizer ¶
type RequestAuthorizer interface {
Authorizer
IAuthorizer
AuthorizationType() AuthorizationType
AuthorizerArn() *string
AuthorizerId() *string
Env() *awscdk.ResourceEnvironment
Handler() awslambda.IFunction
Node() constructs.Node
PhysicalName() *string
RestApiId() *string
SetRestApiId(val *string)
Role() awsiam.IRole
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
LazyRestApiId() *string
SetupPermissions()
ToString() *string
}
Request-based lambda authorizer that recognizes the caller's identity via request parameters, such as headers, paths, query strings, stage variables, or context variables.
Based on the request, authorization is performed by a lambda function.
TODO: EXAMPLE
func NewRequestAuthorizer ¶
func NewRequestAuthorizer(scope constructs.Construct, id *string, props *RequestAuthorizerProps) RequestAuthorizer
type RequestAuthorizerProps ¶
type RequestAuthorizerProps struct {
// An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer.
//
// The IAM role must be
// assumable by 'apigateway.amazonaws.com'.
AssumeRole awsiam.IRole `json:"assumeRole"`
// An optional human friendly name for the authorizer.
//
// Note that, this is not the primary identifier of the authorizer.
AuthorizerName *string `json:"authorizerName"`
// The handler for the authorizer lambda function.
//
// The handler must follow a very specific protocol on the input it receives and the output it needs to produce.
// API Gateway has documented the handler's input specification
// {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification
// {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.
Handler awslambda.IFunction `json:"handler"`
// How long APIGateway should cache the results.
//
// Max 1 hour.
// Disable caching by setting this to 0.
ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl"`
// An array of request header mapping expressions for identities.
//
// Supported parameter types are
// Header, Query String, Stage Variable, and Context. For instance, extracting an authorization
// token from a header would use the identity source `IdentitySource.header('Authorizer')`.
//
// Note: API Gateway uses the specified identity sources as the request authorizer caching key. When caching is
// enabled, API Gateway calls the authorizer's Lambda function only after successfully verifying that all the
// specified identity sources are present at runtime. If a specified identify source is missing, null, or empty,
// API Gateway returns a 401 Unauthorized response without calling the authorizer Lambda function.
// See: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource
//
IdentitySources *[]*string `json:"identitySources"`
}
Properties for RequestAuthorizer.
TODO: EXAMPLE
type RequestValidator ¶
type RequestValidator interface {
awscdk.Resource
IRequestValidator
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
RequestValidatorId() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
TODO: EXAMPLE
func NewRequestValidator ¶
func NewRequestValidator(scope constructs.Construct, id *string, props *RequestValidatorProps) RequestValidator
type RequestValidatorOptions ¶
type RequestValidatorOptions struct {
// The name of this request validator.
RequestValidatorName *string `json:"requestValidatorName"`
// Indicates whether to validate the request body according to the configured schema for the targeted API and method.
ValidateRequestBody *bool `json:"validateRequestBody"`
// Indicates whether to validate request parameters.
ValidateRequestParameters *bool `json:"validateRequestParameters"`
}
TODO: EXAMPLE
type RequestValidatorProps ¶
type RequestValidatorProps struct {
// The name of this request validator.
RequestValidatorName *string `json:"requestValidatorName"`
// Indicates whether to validate the request body according to the configured schema for the targeted API and method.
ValidateRequestBody *bool `json:"validateRequestBody"`
// Indicates whether to validate request parameters.
ValidateRequestParameters *bool `json:"validateRequestParameters"`
// The rest API that this model is part of.
//
// The reason we need the RestApi object itself and not just the ID is because the model
// is being tracked by the top-level RestApi object for the purpose of calculating it's
// hash to determine the ID of the deployment. This allows us to automatically update
// the deployment when the model of the REST API changes.
RestApi IRestApi `json:"restApi"`
}
TODO: EXAMPLE
type Resource ¶
type Resource interface {
ResourceBase
Api() IRestApi
DefaultCorsPreflightOptions() *CorsOptions
DefaultIntegration() Integration
DefaultMethodOptions() *MethodOptions
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
ParentResource() IResource
Path() *string
PhysicalName() *string
ResourceId() *string
Stack() awscdk.Stack
AddCorsPreflight(options *CorsOptions) Method
AddMethod(httpMethod *string, integration Integration, options *MethodOptions) Method
AddProxy(options *ProxyResourceOptions) ProxyResource
AddResource(pathPart *string, options *ResourceOptions) Resource
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResource(pathPart *string) IResource
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ResourceForPath(path *string) Resource
ToString() *string
}
TODO: EXAMPLE
func NewResource ¶
func NewResource(scope constructs.Construct, id *string, props *ResourceProps) Resource
type ResourceAttributes ¶
type ResourceAttributes struct {
// The full path of this resource.
Path *string `json:"path"`
// The ID of the resource.
ResourceId *string `json:"resourceId"`
// The rest API that this resource is part of.
RestApi IRestApi `json:"restApi"`
}
Attributes that can be specified when importing a Resource.
TODO: EXAMPLE
type ResourceBase ¶
type ResourceBase interface {
awscdk.Resource
IResource
Api() IRestApi
DefaultCorsPreflightOptions() *CorsOptions
DefaultIntegration() Integration
DefaultMethodOptions() *MethodOptions
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
ParentResource() IResource
Path() *string
PhysicalName() *string
ResourceId() *string
Stack() awscdk.Stack
AddCorsPreflight(options *CorsOptions) Method
AddMethod(httpMethod *string, integration Integration, options *MethodOptions) Method
AddProxy(options *ProxyResourceOptions) ProxyResource
AddResource(pathPart *string, options *ResourceOptions) Resource
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResource(pathPart *string) IResource
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ResourceForPath(path *string) Resource
ToString() *string
}
type ResourceOptions ¶
type ResourceOptions struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
}
TODO: EXAMPLE
type ResourceProps ¶
type ResourceProps struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// The parent resource of this resource.
//
// You can either pass another
// `Resource` object or a `RestApi` object here.
Parent IResource `json:"parent"`
// A path name for the resource.
PathPart *string `json:"pathPart"`
}
TODO: EXAMPLE
type ResponseType ¶
type ResponseType interface {
ResponseType() *string
}
Supported types of gateway responses.
TODO: EXAMPLE
See: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
func ResponseType_ACCESS_DENIED ¶
func ResponseType_ACCESS_DENIED() ResponseType
func ResponseType_API_CONFIGURATION_ERROR ¶
func ResponseType_API_CONFIGURATION_ERROR() ResponseType
func ResponseType_AUTHORIZER_CONFIGURATION_ERROR ¶
func ResponseType_AUTHORIZER_CONFIGURATION_ERROR() ResponseType
func ResponseType_AUTHORIZER_FAILURE ¶
func ResponseType_AUTHORIZER_FAILURE() ResponseType
func ResponseType_BAD_REQUEST_BODY ¶
func ResponseType_BAD_REQUEST_BODY() ResponseType
func ResponseType_BAD_REQUEST_PARAMETERS ¶
func ResponseType_BAD_REQUEST_PARAMETERS() ResponseType
func ResponseType_DEFAULT_4XX ¶
func ResponseType_DEFAULT_4XX() ResponseType
func ResponseType_DEFAULT_5XX ¶
func ResponseType_DEFAULT_5XX() ResponseType
func ResponseType_EXPIRED_TOKEN ¶
func ResponseType_EXPIRED_TOKEN() ResponseType
func ResponseType_INTEGRATION_FAILURE ¶
func ResponseType_INTEGRATION_FAILURE() ResponseType
func ResponseType_INTEGRATION_TIMEOUT ¶
func ResponseType_INTEGRATION_TIMEOUT() ResponseType
func ResponseType_INVALID_API_KEY ¶
func ResponseType_INVALID_API_KEY() ResponseType
func ResponseType_INVALID_SIGNATURE ¶
func ResponseType_INVALID_SIGNATURE() ResponseType
func ResponseType_MISSING_AUTHENTICATION_TOKEN ¶
func ResponseType_MISSING_AUTHENTICATION_TOKEN() ResponseType
func ResponseType_Of ¶
func ResponseType_Of(type_ *string) ResponseType
A custom response type to support future cases.
func ResponseType_QUOTA_EXCEEDED ¶
func ResponseType_QUOTA_EXCEEDED() ResponseType
func ResponseType_REQUEST_TOO_LARGE ¶
func ResponseType_REQUEST_TOO_LARGE() ResponseType
func ResponseType_RESOURCE_NOT_FOUND ¶
func ResponseType_RESOURCE_NOT_FOUND() ResponseType
func ResponseType_THROTTLED ¶
func ResponseType_THROTTLED() ResponseType
func ResponseType_UNAUTHORIZED ¶
func ResponseType_UNAUTHORIZED() ResponseType
func ResponseType_UNSUPPORTED_MEDIA_TYPE ¶
func ResponseType_UNSUPPORTED_MEDIA_TYPE() ResponseType
func ResponseType_WAF_FILTERED ¶
func ResponseType_WAF_FILTERED() ResponseType
type RestApi ¶
type RestApi interface {
RestApiBase
DeploymentStage() Stage
SetDeploymentStage(val Stage)
DomainName() DomainName
Env() *awscdk.ResourceEnvironment
LatestDeployment() Deployment
Methods() *[]Method
Node() constructs.Node
PhysicalName() *string
RestApiId() *string
RestApiName() *string
RestApiRootResourceId() *string
Root() IResource
Stack() awscdk.Stack
Url() *string
AddApiKey(id *string, options *ApiKeyOptions) IApiKey
AddDomainName(id *string, options *DomainNameOptions) DomainName
AddGatewayResponse(id *string, options *GatewayResponseOptions) GatewayResponse
AddModel(id *string, props *ModelOptions) Model
AddRequestValidator(id *string, props *RequestValidatorOptions) RequestValidator
AddUsagePlan(id *string, props *UsagePlanProps) UsagePlan
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
ArnForExecuteApi(method *string, path *string, stage *string) *string
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheHitCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheMissCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
ToString() *string
UrlForPath(path *string) *string
}
Represents a REST API in Amazon API Gateway.
Use `addResource` and `addMethod` to configure the API model.
By default, the API will automatically be deployed and accessible from a public endpoint.
TODO: EXAMPLE
func NewRestApi ¶
func NewRestApi(scope constructs.Construct, id *string, props *RestApiProps) RestApi
type RestApiAttributes ¶
type RestApiAttributes struct {
// The ID of the API Gateway RestApi.
RestApiId *string `json:"restApiId"`
// The resource ID of the root resource.
RootResourceId *string `json:"rootResourceId"`
}
Attributes that can be specified when importing a RestApi.
TODO: EXAMPLE
type RestApiBase ¶
type RestApiBase interface {
awscdk.Resource
IRestApi
DeploymentStage() Stage
SetDeploymentStage(val Stage)
DomainName() DomainName
Env() *awscdk.ResourceEnvironment
LatestDeployment() Deployment
Node() constructs.Node
PhysicalName() *string
RestApiId() *string
RestApiName() *string
RestApiRootResourceId() *string
Root() IResource
Stack() awscdk.Stack
AddApiKey(id *string, options *ApiKeyOptions) IApiKey
AddDomainName(id *string, options *DomainNameOptions) DomainName
AddGatewayResponse(id *string, options *GatewayResponseOptions) GatewayResponse
AddUsagePlan(id *string, props *UsagePlanProps) UsagePlan
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
ArnForExecuteApi(method *string, path *string, stage *string) *string
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheHitCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheMissCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
ToString() *string
UrlForPath(path *string) *string
}
Base implementation that are common to various implementations of IRestApi.
TODO: EXAMPLE
type RestApiBaseProps ¶
type RestApiBaseProps struct {
// Automatically configure an AWS CloudWatch role for API Gateway.
CloudWatchRole *bool `json:"cloudWatchRole"`
// Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
//
// Since API Gateway deployments are immutable, When this option is enabled
// (by default), an AWS::ApiGateway::Deployment resource will automatically
// created with a logical ID that hashes the API model (methods, resources
// and options). This means that when the model changes, the logical ID of
// this CloudFormation resource will change, and a new deployment will be
// created.
//
// If this is set, `latestDeployment` will refer to the `Deployment` object
// and `deploymentStage` will refer to a `Stage` that points to this
// deployment. To customize the stage options, use the `deployOptions`
// property.
//
// A CloudFormation Output will also be defined with the root URL endpoint
// of this REST API.
Deploy *bool `json:"deploy"`
// Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
//
// If `deploy` is disabled,
// this value cannot be set.
DeployOptions *StageOptions `json:"deployOptions"`
// Specifies whether clients can invoke the API using the default execute-api endpoint.
//
// To require that clients use a custom domain name to invoke the
// API, disable the default endpoint.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
//
DisableExecuteApiEndpoint *bool `json:"disableExecuteApiEndpoint"`
// Configure a custom domain name and map it to this API.
DomainName *DomainNameOptions `json:"domainName"`
// Export name for the CfnOutput containing the API endpoint.
EndpointExportName *string `json:"endpointExportName"`
// A list of the endpoint types of the API.
//
// Use this property when creating
// an API.
EndpointTypes *[]EndpointType `json:"endpointTypes"`
// Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
FailOnWarnings *bool `json:"failOnWarnings"`
// Custom header parameters for the request.
// See: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
//
Parameters *map[string]*string `json:"parameters"`
// A policy document that contains the permissions for this RestApi.
Policy awsiam.PolicyDocument `json:"policy"`
// A name for the API Gateway RestApi resource.
RestApiName *string `json:"restApiName"`
// Retains old deployment resources when the API changes.
//
// This allows
// manually reverting stages to point to old deployments via the AWS
// Console.
RetainDeployments *bool `json:"retainDeployments"`
}
Represents the props that all Rest APIs share.
TODO: EXAMPLE
type RestApiProps ¶
type RestApiProps struct {
// Adds a CORS preflight OPTIONS method to this resource and all child resources.
//
// You can add CORS at the resource-level using `addCorsPreflight`.
DefaultCorsPreflightOptions *CorsOptions `json:"defaultCorsPreflightOptions"`
// An integration to use as a default for all methods created within this API unless an integration is specified.
DefaultIntegration Integration `json:"defaultIntegration"`
// Method options to use as a default for all methods created within this API unless custom options are specified.
DefaultMethodOptions *MethodOptions `json:"defaultMethodOptions"`
// Automatically configure an AWS CloudWatch role for API Gateway.
CloudWatchRole *bool `json:"cloudWatchRole"`
// Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
//
// Since API Gateway deployments are immutable, When this option is enabled
// (by default), an AWS::ApiGateway::Deployment resource will automatically
// created with a logical ID that hashes the API model (methods, resources
// and options). This means that when the model changes, the logical ID of
// this CloudFormation resource will change, and a new deployment will be
// created.
//
// If this is set, `latestDeployment` will refer to the `Deployment` object
// and `deploymentStage` will refer to a `Stage` that points to this
// deployment. To customize the stage options, use the `deployOptions`
// property.
//
// A CloudFormation Output will also be defined with the root URL endpoint
// of this REST API.
Deploy *bool `json:"deploy"`
// Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
//
// If `deploy` is disabled,
// this value cannot be set.
DeployOptions *StageOptions `json:"deployOptions"`
// Specifies whether clients can invoke the API using the default execute-api endpoint.
//
// To require that clients use a custom domain name to invoke the
// API, disable the default endpoint.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
//
DisableExecuteApiEndpoint *bool `json:"disableExecuteApiEndpoint"`
// Configure a custom domain name and map it to this API.
DomainName *DomainNameOptions `json:"domainName"`
// Export name for the CfnOutput containing the API endpoint.
EndpointExportName *string `json:"endpointExportName"`
// A list of the endpoint types of the API.
//
// Use this property when creating
// an API.
EndpointTypes *[]EndpointType `json:"endpointTypes"`
// Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
FailOnWarnings *bool `json:"failOnWarnings"`
// Custom header parameters for the request.
// See: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
//
Parameters *map[string]*string `json:"parameters"`
// A policy document that contains the permissions for this RestApi.
Policy awsiam.PolicyDocument `json:"policy"`
// A name for the API Gateway RestApi resource.
RestApiName *string `json:"restApiName"`
// Retains old deployment resources when the API changes.
//
// This allows
// manually reverting stages to point to old deployments via the AWS
// Console.
RetainDeployments *bool `json:"retainDeployments"`
// The source of the API key for metering requests according to a usage plan.
ApiKeySourceType ApiKeySourceType `json:"apiKeySourceType"`
// The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
BinaryMediaTypes *[]*string `json:"binaryMediaTypes"`
// The ID of the API Gateway RestApi resource that you want to clone.
CloneFrom IRestApi `json:"cloneFrom"`
// A description of the purpose of this API Gateway RestApi resource.
Description *string `json:"description"`
// The EndpointConfiguration property type specifies the endpoint types of a REST API.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
//
EndpointConfiguration *EndpointConfiguration `json:"endpointConfiguration"`
// A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
//
// When compression is enabled, compression or
// decompression is not applied on the payload if the payload size is
// smaller than this value. Setting it to zero allows compression for any
// payload size.
MinimumCompressionSize *float64 `json:"minimumCompressionSize"`
}
Props to create a new instance of RestApi.
TODO: EXAMPLE
type S3ApiDefinition ¶
type S3ApiDefinition interface {
ApiDefinition
Bind(_scope constructs.Construct) *ApiDefinitionConfig
BindAfterCreate(_scope constructs.Construct, _restApi IRestApi)
}
OpenAPI specification from an S3 archive.
TODO: EXAMPLE
func ApiDefinition_FromBucket ¶
func ApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
Creates an API definition from a specification file in an S3 bucket.
func AssetApiDefinition_FromBucket ¶
func AssetApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
Creates an API definition from a specification file in an S3 bucket.
func InlineApiDefinition_FromBucket ¶
func InlineApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
Creates an API definition from a specification file in an S3 bucket.
func NewS3ApiDefinition ¶
func NewS3ApiDefinition(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
func S3ApiDefinition_FromBucket ¶
func S3ApiDefinition_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3ApiDefinition
Creates an API definition from a specification file in an S3 bucket.
type SecurityPolicy ¶
type SecurityPolicy string
The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.
TODO: EXAMPLE
const ( SecurityPolicy_TLS_1_0 SecurityPolicy = "TLS_1_0" SecurityPolicy_TLS_1_2 SecurityPolicy = "TLS_1_2" )
type SpecRestApi ¶
type SpecRestApi interface {
RestApiBase
DeploymentStage() Stage
SetDeploymentStage(val Stage)
DomainName() DomainName
Env() *awscdk.ResourceEnvironment
LatestDeployment() Deployment
Node() constructs.Node
PhysicalName() *string
RestApiId() *string
RestApiName() *string
RestApiRootResourceId() *string
Root() IResource
Stack() awscdk.Stack
AddApiKey(id *string, options *ApiKeyOptions) IApiKey
AddDomainName(id *string, options *DomainNameOptions) DomainName
AddGatewayResponse(id *string, options *GatewayResponseOptions) GatewayResponse
AddUsagePlan(id *string, props *UsagePlanProps) UsagePlan
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
ArnForExecuteApi(method *string, path *string, stage *string) *string
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheHitCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCacheMissCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
ToString() *string
UrlForPath(path *string) *string
}
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
Some properties normally accessible on @see {@link RestApi} - such as the description - must be declared in the specification. All Resources and Methods need to be defined as part of the OpenAPI specification file, and cannot be added via the CDK.
By default, the API will automatically be deployed and accessible from a public endpoint.
TODO: EXAMPLE
func NewSpecRestApi ¶
func NewSpecRestApi(scope constructs.Construct, id *string, props *SpecRestApiProps) SpecRestApi
type SpecRestApiProps ¶
type SpecRestApiProps struct {
// Automatically configure an AWS CloudWatch role for API Gateway.
CloudWatchRole *bool `json:"cloudWatchRole"`
// Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
//
// Since API Gateway deployments are immutable, When this option is enabled
// (by default), an AWS::ApiGateway::Deployment resource will automatically
// created with a logical ID that hashes the API model (methods, resources
// and options). This means that when the model changes, the logical ID of
// this CloudFormation resource will change, and a new deployment will be
// created.
//
// If this is set, `latestDeployment` will refer to the `Deployment` object
// and `deploymentStage` will refer to a `Stage` that points to this
// deployment. To customize the stage options, use the `deployOptions`
// property.
//
// A CloudFormation Output will also be defined with the root URL endpoint
// of this REST API.
Deploy *bool `json:"deploy"`
// Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
//
// If `deploy` is disabled,
// this value cannot be set.
DeployOptions *StageOptions `json:"deployOptions"`
// Specifies whether clients can invoke the API using the default execute-api endpoint.
//
// To require that clients use a custom domain name to invoke the
// API, disable the default endpoint.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
//
DisableExecuteApiEndpoint *bool `json:"disableExecuteApiEndpoint"`
// Configure a custom domain name and map it to this API.
DomainName *DomainNameOptions `json:"domainName"`
// Export name for the CfnOutput containing the API endpoint.
EndpointExportName *string `json:"endpointExportName"`
// A list of the endpoint types of the API.
//
// Use this property when creating
// an API.
EndpointTypes *[]EndpointType `json:"endpointTypes"`
// Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
FailOnWarnings *bool `json:"failOnWarnings"`
// Custom header parameters for the request.
// See: https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
//
Parameters *map[string]*string `json:"parameters"`
// A policy document that contains the permissions for this RestApi.
Policy awsiam.PolicyDocument `json:"policy"`
// A name for the API Gateway RestApi resource.
RestApiName *string `json:"restApiName"`
// Retains old deployment resources when the API changes.
//
// This allows
// manually reverting stages to point to old deployments via the AWS
// Console.
RetainDeployments *bool `json:"retainDeployments"`
// An OpenAPI definition compatible with API Gateway.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html
//
ApiDefinition ApiDefinition `json:"apiDefinition"`
}
Props to instantiate a new SpecRestApi.
TODO: EXAMPLE
type Stage ¶
type Stage interface {
awscdk.Resource
IStage
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
RestApi() IRestApi
Stack() awscdk.Stack
StageName() *string
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
UrlForPath(path *string) *string
}
TODO: EXAMPLE
func NewStage ¶
func NewStage(scope constructs.Construct, id *string, props *StageProps) Stage
type StageOptions ¶
type StageOptions struct {
// Indicates whether the cached responses are encrypted.
CacheDataEncrypted *bool `json:"cacheDataEncrypted"`
// Specifies the time to live (TTL), in seconds, for cached responses.
//
// The
// higher the TTL, the longer the response will be cached.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
//
CacheTtl awscdk.Duration `json:"cacheTtl"`
// Specifies whether responses should be cached and returned for requests.
//
// A
// cache cluster must be enabled on the stage for responses to be cached.
CachingEnabled *bool `json:"cachingEnabled"`
// Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
DataTraceEnabled *bool `json:"dataTraceEnabled"`
// Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
LoggingLevel MethodLoggingLevel `json:"loggingLevel"`
// Specifies whether Amazon CloudWatch metrics are enabled for this method.
MetricsEnabled *bool `json:"metricsEnabled"`
// Specifies the throttling burst limit.
//
// The total rate of all requests in your AWS account is limited to 5,000 requests.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
//
ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
// Specifies the throttling rate limit.
//
// The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
//
ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
// The CloudWatch Logs log group.
AccessLogDestination IAccessLogDestination `json:"accessLogDestination"`
// A single line format of access logs of data, as specified by selected $content variables.
//
// The format must include at least `AccessLogFormat.contextRequestId()`.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
//
AccessLogFormat AccessLogFormat `json:"accessLogFormat"`
// Indicates whether cache clustering is enabled for the stage.
CacheClusterEnabled *bool `json:"cacheClusterEnabled"`
// The stage's cache cluster size.
CacheClusterSize *string `json:"cacheClusterSize"`
// The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
ClientCertificateId *string `json:"clientCertificateId"`
// A description of the purpose of the stage.
Description *string `json:"description"`
// The version identifier of the API documentation snapshot.
DocumentationVersion *string `json:"documentationVersion"`
// Method deployment options for specific resources/methods.
//
// These will
// override common options defined in `StageOptions#methodOptions`.
MethodOptions *map[string]*MethodDeploymentOptions `json:"methodOptions"`
// The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
StageName *string `json:"stageName"`
// Specifies whether Amazon X-Ray tracing is enabled for this method.
TracingEnabled *bool `json:"tracingEnabled"`
// A map that defines the stage variables.
//
// Variable names must consist of
// alphanumeric characters, and the values must match the following regular
// expression: [A-Za-z0-9-._~:/?#&=,]+.
Variables *map[string]*string `json:"variables"`
}
TODO: EXAMPLE
type StageProps ¶
type StageProps struct {
// Indicates whether the cached responses are encrypted.
CacheDataEncrypted *bool `json:"cacheDataEncrypted"`
// Specifies the time to live (TTL), in seconds, for cached responses.
//
// The
// higher the TTL, the longer the response will be cached.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
//
CacheTtl awscdk.Duration `json:"cacheTtl"`
// Specifies whether responses should be cached and returned for requests.
//
// A
// cache cluster must be enabled on the stage for responses to be cached.
CachingEnabled *bool `json:"cachingEnabled"`
// Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
DataTraceEnabled *bool `json:"dataTraceEnabled"`
// Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
LoggingLevel MethodLoggingLevel `json:"loggingLevel"`
// Specifies whether Amazon CloudWatch metrics are enabled for this method.
MetricsEnabled *bool `json:"metricsEnabled"`
// Specifies the throttling burst limit.
//
// The total rate of all requests in your AWS account is limited to 5,000 requests.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
//
ThrottlingBurstLimit *float64 `json:"throttlingBurstLimit"`
// Specifies the throttling rate limit.
//
// The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
//
ThrottlingRateLimit *float64 `json:"throttlingRateLimit"`
// The CloudWatch Logs log group.
AccessLogDestination IAccessLogDestination `json:"accessLogDestination"`
// A single line format of access logs of data, as specified by selected $content variables.
//
// The format must include at least `AccessLogFormat.contextRequestId()`.
// See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
//
AccessLogFormat AccessLogFormat `json:"accessLogFormat"`
// Indicates whether cache clustering is enabled for the stage.
CacheClusterEnabled *bool `json:"cacheClusterEnabled"`
// The stage's cache cluster size.
CacheClusterSize *string `json:"cacheClusterSize"`
// The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
ClientCertificateId *string `json:"clientCertificateId"`
// A description of the purpose of the stage.
Description *string `json:"description"`
// The version identifier of the API documentation snapshot.
DocumentationVersion *string `json:"documentationVersion"`
// Method deployment options for specific resources/methods.
//
// These will
// override common options defined in `StageOptions#methodOptions`.
MethodOptions *map[string]*MethodDeploymentOptions `json:"methodOptions"`
// The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
StageName *string `json:"stageName"`
// Specifies whether Amazon X-Ray tracing is enabled for this method.
TracingEnabled *bool `json:"tracingEnabled"`
// A map that defines the stage variables.
//
// Variable names must consist of
// alphanumeric characters, and the values must match the following regular
// expression: [A-Za-z0-9-._~:/?#&=,]+.
Variables *map[string]*string `json:"variables"`
// The deployment that this stage points to [disable-awslint:ref-via-interface].
Deployment Deployment `json:"deployment"`
}
TODO: EXAMPLE
type ThrottleSettings ¶
type ThrottleSettings struct {
// The maximum API request rate limit over a time ranging from one to a few seconds.
BurstLimit *float64 `json:"burstLimit"`
// The API request steady-state rate limit (average requests per second over an extended period of time).
RateLimit *float64 `json:"rateLimit"`
}
Container for defining throttling parameters to API stages or methods.
TODO: EXAMPLE
type ThrottlingPerMethod ¶
type ThrottlingPerMethod struct {
// [disable-awslint:ref-via-interface] The method for which you specify the throttling settings.
Method Method `json:"method"`
// Specifies the overall request rate (average requests per second) and burst capacity.
Throttle *ThrottleSettings `json:"throttle"`
}
Represents per-method throttling for a resource.
TODO: EXAMPLE
type TokenAuthorizer ¶
type TokenAuthorizer interface {
Authorizer
IAuthorizer
AuthorizationType() AuthorizationType
AuthorizerArn() *string
AuthorizerId() *string
Env() *awscdk.ResourceEnvironment
Handler() awslambda.IFunction
Node() constructs.Node
PhysicalName() *string
RestApiId() *string
SetRestApiId(val *string)
Role() awsiam.IRole
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
LazyRestApiId() *string
SetupPermissions()
ToString() *string
}
Token based lambda authorizer that recognizes the caller's identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token.
Based on the token, authorization is performed by a lambda function.
TODO: EXAMPLE
func NewTokenAuthorizer ¶
func NewTokenAuthorizer(scope constructs.Construct, id *string, props *TokenAuthorizerProps) TokenAuthorizer
type TokenAuthorizerProps ¶
type TokenAuthorizerProps struct {
// An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer.
//
// The IAM role must be
// assumable by 'apigateway.amazonaws.com'.
AssumeRole awsiam.IRole `json:"assumeRole"`
// An optional human friendly name for the authorizer.
//
// Note that, this is not the primary identifier of the authorizer.
AuthorizerName *string `json:"authorizerName"`
// The handler for the authorizer lambda function.
//
// The handler must follow a very specific protocol on the input it receives and the output it needs to produce.
// API Gateway has documented the handler's input specification
// {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification
// {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.
Handler awslambda.IFunction `json:"handler"`
// How long APIGateway should cache the results.
//
// Max 1 hour.
// Disable caching by setting this to 0.
ResultsCacheTtl awscdk.Duration `json:"resultsCacheTtl"`
// The request header mapping expression for the bearer token.
//
// This is typically passed as part of the header, in which case
// this should be `method.request.header.Authorizer` where Authorizer is the header containing the bearer token.
// See: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource
//
IdentitySource *string `json:"identitySource"`
// An optional regex to be matched against the authorization token.
//
// When matched the authorizer lambda is invoked,
// otherwise a 401 Unauthorized is returned to the client.
ValidationRegex *string `json:"validationRegex"`
}
Properties for TokenAuthorizer.
TODO: EXAMPLE
type UsagePlan ¶
type UsagePlan interface {
awscdk.Resource
IUsagePlan
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
UsagePlanId() *string
AddApiKey(apiKey IApiKey, options *AddApiKeyOptions)
AddApiStage(apiStage *UsagePlanPerApiStage)
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
TODO: EXAMPLE
func NewUsagePlan ¶
func NewUsagePlan(scope constructs.Construct, id *string, props *UsagePlanProps) UsagePlan
type UsagePlanPerApiStage ¶
type UsagePlanPerApiStage struct {
Api IRestApi `json:"api"`
// [disable-awslint:ref-via-interface].
Stage Stage `json:"stage"`
Throttle *[]*ThrottlingPerMethod `json:"throttle"`
}
Represents the API stages that a usage plan applies to.
TODO: EXAMPLE
type UsagePlanProps ¶
type UsagePlanProps struct {
// API Stages to be associated with the usage plan.
ApiStages *[]*UsagePlanPerApiStage `json:"apiStages"`
// Represents usage plan purpose.
Description *string `json:"description"`
// Name for this usage plan.
Name *string `json:"name"`
// Number of requests clients can make in a given time period.
Quota *QuotaSettings `json:"quota"`
// Overall throttle settings for the API.
Throttle *ThrottleSettings `json:"throttle"`
}
TODO: EXAMPLE
type VpcLink ¶
type VpcLink interface {
awscdk.Resource
IVpcLink
Env() *awscdk.ResourceEnvironment
Node() constructs.Node
PhysicalName() *string
Stack() awscdk.Stack
VpcLinkId() *string
AddTargets(targets ...awselasticloadbalancingv2.INetworkLoadBalancer)
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
ToString() *string
}
Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
TODO: EXAMPLE
func NewVpcLink ¶
func NewVpcLink(scope constructs.Construct, id *string, props *VpcLinkProps) VpcLink
type VpcLinkProps ¶
type VpcLinkProps struct {
// The description of the VPC link.
Description *string `json:"description"`
// The network load balancers of the VPC targeted by the VPC link.
//
// The network load balancers must be owned by the same AWS account of the API owner.
Targets *[]awselasticloadbalancingv2.INetworkLoadBalancer `json:"targets"`
// The name used to label and identify the VPC link.
VpcLinkName *string `json:"vpcLinkName"`
}
Properties for a VpcLink.
TODO: EXAMPLE