@aws-cdk/resources¶
Low-level AWS CloudFormation Resources Library¶
The @aws-cdk/resources
library is automatically generated from the
CloudFormation Resource specification.
It provides access to all resource types CloudFormation supports, in a low-level API. You should prefer depending on
higher level construct libraries (such as aws-cdk-ec2
, aws-cdk-s3
, …) as they will offer more expressive APIs and in many cases will
also provide additional validations.
Usage¶
The library bundles each AWS service resources in a dedicated namespace. Simply import the namespaces you need and work with the classes it defines:
import { Construct } from '@aws-cdk/core';
import { kms, s3 } from '@aws-cdk/resources';
/**
* The Bucket class in the aws-cdk-s3 library provides much better
* functionality than what is presented in this toy example.
*/
export class EncryptedBucket extends Construct {
public readonly bucketArn: BucketArn;
constructor(parent: Construct, name: string) {
super(parent, name);
const kmsKey = new kms.KeyResource(parent, 'BucketEncryption', {
enableKeyRotation: true,
keyPolicy
});
const bucket = new s3.BucketResource(parent, 'BucketName', {
bucketEncryption: {
serverSideEncryptionConfiguration: {
serverSideEncryptionByDefault: {
kmsMasterKeyId: kmsKey.keyArn,
sseAlgorithm: 'aws:kms'
}
}
}
});
this.bucketArn = bucket.bucketArn;
}
}
Reference¶
PropertySpecification (interface)¶
ResourceClass (interface)¶
apigateway¶
AccountResource¶
-
class
_aws-cdk_resources.apigateway.
AccountResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AccountResource is a part of - name (string) –
- props (
AccountResourceProps
or None) – the properties of this AccountResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
AccountResourceProps (interface)¶
ApiKeyResource¶
-
class
_aws-cdk_resources.apigateway.
ApiKeyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApiKeyResource is a part of - name (string) –
- props (
ApiKeyResourceProps
or None) – the properties of this ApiKeyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
StageKeyProperty
¶ -
restApiId
¶ ApiKeyResource.StageKeyProperty.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid
Type: string or Token
or None
-
stageName
¶ ApiKeyResource.StageKeyProperty.StageName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename
Type: string or Token
or None
-
- parent (
ApiKeyResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
ApiKeyResourceProps
¶ -
customerId
¶ AWS::ApiGateway::ApiKey.CustomerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid
Type: string or Token
or None
-
description
¶ AWS::ApiGateway::ApiKey.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description
Type: string or Token
or None
-
enabled
¶ AWS::ApiGateway::ApiKey.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled
Type: boolean or Token
or None
-
generateDistinctId
¶ AWS::ApiGateway::ApiKey.GenerateDistinctId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid
Type: boolean or Token
or None
-
apiKeyName
¶ AWS::ApiGateway::ApiKey.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
Type: string or Token
or None
-
stageKeys
¶ AWS::ApiGateway::ApiKey.StageKeys http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys
Type: Token
orToken
orStageKeyProperty
or None
-
AuthorizerResource¶
-
class
_aws-cdk_resources.apigateway.
AuthorizerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AuthorizerResource is a part of - name (string) –
- props (
AuthorizerResourceProps
or None) – the properties of this AuthorizerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
AuthorizerResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
AuthorizerResourceProps
¶ -
authType
¶ AWS::ApiGateway::Authorizer.AuthType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype
Type: string or Token
or None
AWS::ApiGateway::Authorizer.AuthorizerCredentials http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials
Type: string or Token
or None
AWS::ApiGateway::Authorizer.AuthorizerResultTtlInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds
Type: number or Token
or None
AWS::ApiGateway::Authorizer.AuthorizerUri http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri
Type: string or Token
or None
-
identitySource
¶ AWS::ApiGateway::Authorizer.IdentitySource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource
Type: string or Token
or None
-
identityValidationExpression
¶ AWS::ApiGateway::Authorizer.IdentityValidationExpression http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression
Type: string or Token
or None
AWS::ApiGateway::Authorizer.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name
Type: string or Token
or None
-
providerArns
¶ AWS::ApiGateway::Authorizer.ProviderARNs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns
Type: Token
or string orToken
or None
-
restApiId
¶ AWS::ApiGateway::Authorizer.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid
Type: string or Token
-
type
¶ AWS::ApiGateway::Authorizer.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
Type: string or Token
or None
-
BasePathMappingResource¶
-
class
_aws-cdk_resources.apigateway.
BasePathMappingResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this BasePathMappingResource is a part of - name (string) –
- props (
BasePathMappingResourceProps
or None) – the properties of this BasePathMappingResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
BasePathMappingResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
BasePathMappingResourceProps
¶ -
basePath
¶ AWS::ApiGateway::BasePathMapping.BasePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath
Type: string or Token
or None
-
domainName
¶ AWS::ApiGateway::BasePathMapping.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname
Type: string or Token
-
restApiId
¶ AWS::ApiGateway::BasePathMapping.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid
Type: string or Token
or None
-
stage
¶ AWS::ApiGateway::BasePathMapping.Stage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage
Type: string or Token
or None
-
ClientCertificateResource¶
-
class
_aws-cdk_resources.apigateway.
ClientCertificateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClientCertificateResource is a part of - name (string) –
- props (
ClientCertificateResourceProps
or None) – the properties of this ClientCertificateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ClientCertificateResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
ClientCertificateResourceProps
¶ -
description
¶ AWS::ApiGateway::ClientCertificate.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description
Type: string or Token
or None
-
DeploymentResource¶
-
class
_aws-cdk_resources.apigateway.
DeploymentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DeploymentResource is a part of - name (string) –
- props (
DeploymentResourceProps
or None) – the properties of this DeploymentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
MethodSettingProperty
¶ -
cacheDataEncrypted
¶ DeploymentResource.MethodSettingProperty.CacheDataEncrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachedataencrypted
Type: boolean or Token
or None
-
cacheTtlInSeconds
¶ DeploymentResource.MethodSettingProperty.CacheTtlInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachettlinseconds
Type: number or Token
or None
-
cachingEnabled
¶ DeploymentResource.MethodSettingProperty.CachingEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachingenabled
Type: boolean or Token
or None
-
dataTraceEnabled
¶ DeploymentResource.MethodSettingProperty.DataTraceEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-datatraceenabled
Type: boolean or Token
or None
-
httpMethod
¶ DeploymentResource.MethodSettingProperty.HttpMethod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-httpmethod
Type: string or Token
or None
-
loggingLevel
¶ DeploymentResource.MethodSettingProperty.LoggingLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-logginglevel
Type: string or Token
or None
-
metricsEnabled
¶ DeploymentResource.MethodSettingProperty.MetricsEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-metricsenabled
Type: boolean or Token
or None
-
resourcePath
¶ DeploymentResource.MethodSettingProperty.ResourcePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-resourcepath
Type: string or Token
or None
-
throttlingBurstLimit
¶ DeploymentResource.MethodSettingProperty.ThrottlingBurstLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-throttlingburstlimit
Type: number or Token
or None
-
throttlingRateLimit
¶ DeploymentResource.MethodSettingProperty.ThrottlingRateLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-throttlingratelimit
Type: number or Token
or None
-
-
class
StageDescriptionProperty
¶ -
cacheClusterEnabled
¶ DeploymentResource.StageDescriptionProperty.CacheClusterEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled
Type: boolean or Token
or None
-
cacheClusterSize
¶ DeploymentResource.StageDescriptionProperty.CacheClusterSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize
Type: string or Token
or None
-
cacheDataEncrypted
¶ DeploymentResource.StageDescriptionProperty.CacheDataEncrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted
Type: boolean or Token
or None
-
cacheTtlInSeconds
¶ DeploymentResource.StageDescriptionProperty.CacheTtlInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds
Type: number or Token
or None
-
cachingEnabled
¶ DeploymentResource.StageDescriptionProperty.CachingEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled
Type: boolean or Token
or None
-
clientCertificateId
¶ DeploymentResource.StageDescriptionProperty.ClientCertificateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid
Type: string or Token
or None
-
dataTraceEnabled
¶ DeploymentResource.StageDescriptionProperty.DataTraceEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled
Type: boolean or Token
or None
-
description
¶ DeploymentResource.StageDescriptionProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description
Type: string or Token
or None
-
documentationVersion
¶ DeploymentResource.StageDescriptionProperty.DocumentationVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion
Type: string or Token
or None
-
loggingLevel
¶ DeploymentResource.StageDescriptionProperty.LoggingLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel
Type: string or Token
or None
-
methodSettings
¶ DeploymentResource.StageDescriptionProperty.MethodSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings
Type: Token
orToken
orMethodSettingProperty
or None
-
metricsEnabled
¶ DeploymentResource.StageDescriptionProperty.MetricsEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled
Type: boolean or Token
or None
-
throttlingBurstLimit
¶ DeploymentResource.StageDescriptionProperty.ThrottlingBurstLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit
Type: number or Token
or None
-
throttlingRateLimit
¶ DeploymentResource.StageDescriptionProperty.ThrottlingRateLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit
Type: number or Token
or None
-
variables
¶ DeploymentResource.StageDescriptionProperty.Variables http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables
Type: Token
or string orToken
or None
-
- parent (
DeploymentResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
DeploymentResourceProps
¶ -
description
¶ AWS::ApiGateway::Deployment.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description
Type: string or Token
or None
-
restApiId
¶ AWS::ApiGateway::Deployment.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid
Type: string or Token
-
stageDescription
¶ AWS::ApiGateway::Deployment.StageDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription
Type: Token
orStageDescriptionProperty
or None
-
stageName
¶ AWS::ApiGateway::Deployment.StageName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename
Type: string or Token
or None
-
DocumentationPartResource¶
-
class
_aws-cdk_resources.apigateway.
DocumentationPartResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DocumentationPartResource is a part of - name (string) –
- props (
DocumentationPartResourceProps
or None) – the properties of this DocumentationPartResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
LocationProperty
¶ -
method
¶ DocumentationPartResource.LocationProperty.Method http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method
Type: string or Token
or None
-
name
¶ DocumentationPartResource.LocationProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name
Type: string or Token
or None
-
path
¶ DocumentationPartResource.LocationProperty.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path
Type: string or Token
or None
-
statusCode
¶ DocumentationPartResource.LocationProperty.StatusCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode
Type: string or Token
or None
-
type
¶ DocumentationPartResource.LocationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type
Type: string or Token
or None
-
- parent (
DocumentationPartResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
DocumentationPartResourceProps
¶ -
location
¶ AWS::ApiGateway::DocumentationPart.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location
Type: Token
orLocationProperty
-
properties
¶ AWS::ApiGateway::DocumentationPart.Properties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties
Type: string or Token
-
restApiId
¶ AWS::ApiGateway::DocumentationPart.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid
Type: string or Token
-
DocumentationVersionResource¶
-
class
_aws-cdk_resources.apigateway.
DocumentationVersionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DocumentationVersionResource is a part of - name (string) –
- props (
DocumentationVersionResourceProps
or None) – the properties of this DocumentationVersionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DocumentationVersionResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
DocumentationVersionResourceProps
¶ -
description
¶ AWS::ApiGateway::DocumentationVersion.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description
Type: string or Token
or None
-
documentationVersion
¶ AWS::ApiGateway::DocumentationVersion.DocumentationVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion
Type: string or Token
-
restApiId
¶ AWS::ApiGateway::DocumentationVersion.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid
Type: string or Token
-
DomainNameDistributionDomainName¶
DomainNameDistributionHostedZoneId¶
DomainNameRegionalDomainName¶
DomainNameRegionalHostedZoneId¶
DomainNameResource¶
-
class
_aws-cdk_resources.apigateway.
DomainNameResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DomainNameResource is a part of - name (string) –
- props (
DomainNameResourceProps
or None) – the properties of this DomainNameResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
domainNameDistributionDomainName
¶ Type: DomainNameDistributionDomainName
(readonly)
-
domainNameDistributionHostedZoneId
¶ Type: DomainNameDistributionHostedZoneId
(readonly)
-
domainNameRegionalDomainName
¶ Type: DomainNameRegionalDomainName
(readonly)
-
domainNameRegionalHostedZoneId
¶ Type: DomainNameRegionalHostedZoneId
(readonly)
-
class
EndpointConfigurationProperty
¶ -
types
¶ DomainNameResource.EndpointConfigurationProperty.Types http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types
Type: Token
or string orToken
or None
-
- parent (
DomainNameResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
DomainNameResourceProps
¶ -
certificateArn
¶ AWS::ApiGateway::DomainName.CertificateArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn
Type: string or Token
or None
-
domainName
¶ AWS::ApiGateway::DomainName.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname
Type: string or Token
-
endpointConfiguration
¶ AWS::ApiGateway::DomainName.EndpointConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
Type: Token
orEndpointConfigurationProperty
or None
-
regionalCertificateArn
¶ AWS::ApiGateway::DomainName.RegionalCertificateArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn
Type: string or Token
or None
-
GatewayResponseResource¶
-
class
_aws-cdk_resources.apigateway.
GatewayResponseResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this GatewayResponseResource is a part of - name (string) –
- props (
GatewayResponseResourceProps
or None) – the properties of this GatewayResponseResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
GatewayResponseResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
GatewayResponseResourceProps
¶ -
responseParameters
¶ AWS::ApiGateway::GatewayResponse.ResponseParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters
Type: Token
or string orToken
or None
-
responseTemplates
¶ AWS::ApiGateway::GatewayResponse.ResponseTemplates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates
Type: Token
or string orToken
or None
-
responseType
¶ AWS::ApiGateway::GatewayResponse.ResponseType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype
Type: string or Token
-
restApiId
¶ AWS::ApiGateway::GatewayResponse.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid
Type: string or Token
-
statusCode
¶ AWS::ApiGateway::GatewayResponse.StatusCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode
Type: string or Token
or None
-
MethodResource¶
-
class
_aws-cdk_resources.apigateway.
MethodResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MethodResource is a part of - name (string) –
- props (
MethodResourceProps
or None) – the properties of this MethodResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
IntegrationProperty
¶ -
cacheKeyParameters
¶ MethodResource.IntegrationProperty.CacheKeyParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters
Type: Token
or string orToken
or None
-
cacheNamespace
¶ MethodResource.IntegrationProperty.CacheNamespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace
Type: string or Token
or None
-
contentHandling
¶ MethodResource.IntegrationProperty.ContentHandling http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling
Type: string or Token
or None
-
credentials
¶ MethodResource.IntegrationProperty.Credentials http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials
Type: string or Token
or None
-
integrationHttpMethod
¶ MethodResource.IntegrationProperty.IntegrationHttpMethod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod
Type: string or Token
or None
-
integrationResponses
¶ MethodResource.IntegrationProperty.IntegrationResponses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses
Type: Token
orToken
orIntegrationResponseProperty
or None
-
passthroughBehavior
¶ MethodResource.IntegrationProperty.PassthroughBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior
Type: string or Token
or None
-
requestParameters
¶ MethodResource.IntegrationProperty.RequestParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters
Type: Token
or string orToken
or None
-
requestTemplates
¶ MethodResource.IntegrationProperty.RequestTemplates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates
Type: Token
or string orToken
or None
-
type
¶ MethodResource.IntegrationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type
Type: string or Token
or None
-
uri
¶ MethodResource.IntegrationProperty.Uri http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri
Type: string or Token
or None
-
-
class
IntegrationResponseProperty
¶ -
contentHandling
¶ MethodResource.IntegrationResponseProperty.ContentHandling http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling
Type: string or Token
or None
-
responseParameters
¶ MethodResource.IntegrationResponseProperty.ResponseParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters
Type: Token
or string orToken
or None
-
responseTemplates
¶ MethodResource.IntegrationResponseProperty.ResponseTemplates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates
Type: Token
or string orToken
or None
-
selectionPattern
¶ MethodResource.IntegrationResponseProperty.SelectionPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern
Type: string or Token
or None
-
statusCode
¶ MethodResource.IntegrationResponseProperty.StatusCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode
Type: string or Token
-
-
class
MethodResponseProperty
¶ -
responseModels
¶ MethodResource.MethodResponseProperty.ResponseModels http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels
Type: Token
or string orToken
or None
-
responseParameters
¶ MethodResource.MethodResponseProperty.ResponseParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters
Type: Token
or boolean orToken
or None
-
statusCode
¶ MethodResource.MethodResponseProperty.StatusCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode
Type: string or Token
-
- parent (
MethodResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
MethodResourceProps
¶ -
apiKeyRequired
¶ AWS::ApiGateway::Method.ApiKeyRequired http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
Type: boolean or Token
or None
AWS::ApiGateway::Method.AuthorizationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
Type: string or Token
or None
AWS::ApiGateway::Method.AuthorizerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
Type: string or Token
or None
-
httpMethod
¶ AWS::ApiGateway::Method.HttpMethod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
Type: string or Token
-
integration
¶ AWS::ApiGateway::Method.Integration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
Type: Token
orIntegrationProperty
or None
-
methodResponses
¶ AWS::ApiGateway::Method.MethodResponses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
Type: Token
orToken
orMethodResponseProperty
or None
-
operationName
¶ AWS::ApiGateway::Method.OperationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
Type: string or Token
or None
-
requestModels
¶ AWS::ApiGateway::Method.RequestModels http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
Type: Token
or string orToken
or None
-
requestParameters
¶ AWS::ApiGateway::Method.RequestParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
Type: Token
or boolean orToken
or None
-
requestValidatorId
¶ AWS::ApiGateway::Method.RequestValidatorId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
Type: string or Token
or None
-
resourceId
¶ AWS::ApiGateway::Method.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
Type: string or Token
-
restApiId
¶ AWS::ApiGateway::Method.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
Type: string or Token
-
ModelResource¶
-
class
_aws-cdk_resources.apigateway.
ModelResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ModelResource is a part of - name (string) –
- props (
ModelResourceProps
or None) – the properties of this ModelResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ModelResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
ModelResourceProps
¶ -
contentType
¶ AWS::ApiGateway::Model.ContentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype
Type: string or Token
or None
-
description
¶ AWS::ApiGateway::Model.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description
Type: string or Token
or None
-
modelName
¶ AWS::ApiGateway::Model.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name
Type: string or Token
or None
-
restApiId
¶ AWS::ApiGateway::Model.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid
Type: string or Token
-
schema
¶ AWS::ApiGateway::Model.Schema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema
Type: json or Token
or None
-
RequestValidatorResource¶
-
class
_aws-cdk_resources.apigateway.
RequestValidatorResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RequestValidatorResource is a part of - name (string) –
- props (
RequestValidatorResourceProps
or None) – the properties of this RequestValidatorResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
RequestValidatorResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
RequestValidatorResourceProps
¶ -
requestValidatorName
¶ AWS::ApiGateway::RequestValidator.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name
Type: string or Token
or None
-
restApiId
¶ AWS::ApiGateway::RequestValidator.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid
Type: string or Token
-
validateRequestBody
¶ AWS::ApiGateway::RequestValidator.ValidateRequestBody http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody
Type: boolean or Token
or None
-
validateRequestParameters
¶ AWS::ApiGateway::RequestValidator.ValidateRequestParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters
Type: boolean or Token
or None
-
Resource¶
-
class
_aws-cdk_resources.apigateway.
Resource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this Resource is a part of - name (string) –
- props (
ResourceProps
or None) – the properties of this Resource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
ResourceProps
¶ -
parentId
¶ AWS::ApiGateway::Resource.ParentId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid
Type: string or Token
-
pathPart
¶ AWS::ApiGateway::Resource.PathPart http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart
Type: string or Token
-
restApiId
¶ AWS::ApiGateway::Resource.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid
Type: string or Token
-
RestApiResource¶
-
class
_aws-cdk_resources.apigateway.
RestApiResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RestApiResource is a part of - name (string) –
- props (
RestApiResourceProps
or None) – the properties of this RestApiResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
restApiRootResourceId
¶ Type: RestApiRootResourceId
(readonly)
-
class
EndpointConfigurationProperty
¶ -
types
¶ RestApiResource.EndpointConfigurationProperty.Types http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types
Type: Token
or string orToken
or None
-
-
class
S3LocationProperty
¶ -
bucket
¶ RestApiResource.S3LocationProperty.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket
Type: string or Token
or None
-
eTag
¶ RestApiResource.S3LocationProperty.ETag http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag
Type: string or Token
or None
-
key
¶ RestApiResource.S3LocationProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key
Type: string or Token
or None
-
version
¶ RestApiResource.S3LocationProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version
Type: string or Token
or None
-
- parent (
RestApiResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
RestApiResourceProps
¶ -
apiKeySourceType
¶ AWS::ApiGateway::RestApi.ApiKeySourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
Type: string or Token
or None
-
binaryMediaTypes
¶ AWS::ApiGateway::RestApi.BinaryMediaTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes
Type: Token
or string orToken
or None
-
body
¶ AWS::ApiGateway::RestApi.Body http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body
Type: json or Token
or None
-
bodyS3Location
¶ AWS::ApiGateway::RestApi.BodyS3Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location
Type: Token
orS3LocationProperty
or None
-
cloneFrom
¶ AWS::ApiGateway::RestApi.CloneFrom http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
Type: string or Token
or None
-
description
¶ AWS::ApiGateway::RestApi.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description
Type: string or Token
or None
-
endpointConfiguration
¶ AWS::ApiGateway::RestApi.EndpointConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration
Type: Token
orEndpointConfigurationProperty
or None
-
failOnWarnings
¶ AWS::ApiGateway::RestApi.FailOnWarnings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings
Type: boolean or Token
or None
-
minimumCompressionSize
¶ AWS::ApiGateway::RestApi.MinimumCompressionSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize
Type: number or Token
or None
-
restApiName
¶ AWS::ApiGateway::RestApi.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
Type: string or Token
or None
-
parameters
¶ AWS::ApiGateway::RestApi.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters
Type: Token
or string orToken
or None
-
policy
¶ AWS::ApiGateway::RestApi.Policy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy
Type: json or Token
or None
-
RestApiRootResourceId¶
StageResource¶
-
class
_aws-cdk_resources.apigateway.
StageResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StageResource is a part of - name (string) –
- props (
StageResourceProps
or None) – the properties of this StageResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
MethodSettingProperty
¶ -
cacheDataEncrypted
¶ StageResource.MethodSettingProperty.CacheDataEncrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted
Type: boolean or Token
or None
-
cacheTtlInSeconds
¶ StageResource.MethodSettingProperty.CacheTtlInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds
Type: number or Token
or None
-
cachingEnabled
¶ StageResource.MethodSettingProperty.CachingEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled
Type: boolean or Token
or None
-
dataTraceEnabled
¶ StageResource.MethodSettingProperty.DataTraceEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled
Type: boolean or Token
or None
-
httpMethod
¶ StageResource.MethodSettingProperty.HttpMethod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod
Type: string or Token
or None
-
loggingLevel
¶ StageResource.MethodSettingProperty.LoggingLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel
Type: string or Token
or None
-
metricsEnabled
¶ StageResource.MethodSettingProperty.MetricsEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled
Type: boolean or Token
or None
-
resourcePath
¶ StageResource.MethodSettingProperty.ResourcePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath
Type: string or Token
or None
-
throttlingBurstLimit
¶ StageResource.MethodSettingProperty.ThrottlingBurstLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit
Type: number or Token
or None
-
throttlingRateLimit
¶ StageResource.MethodSettingProperty.ThrottlingRateLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit
Type: number or Token
or None
-
- parent (
StageResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
StageResourceProps
¶ -
cacheClusterEnabled
¶ AWS::ApiGateway::Stage.CacheClusterEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled
Type: boolean or Token
or None
-
cacheClusterSize
¶ AWS::ApiGateway::Stage.CacheClusterSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize
Type: string or Token
or None
-
clientCertificateId
¶ AWS::ApiGateway::Stage.ClientCertificateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid
Type: string or Token
or None
-
deploymentId
¶ AWS::ApiGateway::Stage.DeploymentId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid
Type: string or Token
or None
-
description
¶ AWS::ApiGateway::Stage.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description
Type: string or Token
or None
-
documentationVersion
¶ AWS::ApiGateway::Stage.DocumentationVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion
Type: string or Token
or None
-
methodSettings
¶ AWS::ApiGateway::Stage.MethodSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings
Type: Token
orToken
orMethodSettingProperty
or None
-
restApiId
¶ AWS::ApiGateway::Stage.RestApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid
Type: string or Token
-
stageName
¶ AWS::ApiGateway::Stage.StageName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename
Type: string or Token
or None
-
variables
¶ AWS::ApiGateway::Stage.Variables http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables
Type: Token
or string orToken
or None
-
UsagePlanKeyResource¶
-
class
_aws-cdk_resources.apigateway.
UsagePlanKeyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UsagePlanKeyResource is a part of - name (string) –
- props (
UsagePlanKeyResourceProps
or None) – the properties of this UsagePlanKeyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
UsagePlanKeyResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
UsagePlanKeyResourceProps
¶ -
keyId
¶ AWS::ApiGateway::UsagePlanKey.KeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid
Type: string or Token
-
keyType
¶ AWS::ApiGateway::UsagePlanKey.KeyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype
Type: string or Token
-
usagePlanId
¶ AWS::ApiGateway::UsagePlanKey.UsagePlanId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid
Type: string or Token
-
UsagePlanResource¶
-
class
_aws-cdk_resources.apigateway.
UsagePlanResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UsagePlanResource is a part of - name (string) –
- props (
UsagePlanResourceProps
or None) – the properties of this UsagePlanResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ApiStageProperty
¶ -
apiId
¶ UsagePlanResource.ApiStageProperty.ApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid
Type: string or Token
or None
-
stage
¶ UsagePlanResource.ApiStageProperty.Stage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage
Type: string or Token
or None
-
-
class
QuotaSettingsProperty
¶ -
limit
¶ UsagePlanResource.QuotaSettingsProperty.Limit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit
Type: number or Token
or None
-
offset
¶ UsagePlanResource.QuotaSettingsProperty.Offset http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset
Type: number or Token
or None
-
period
¶ UsagePlanResource.QuotaSettingsProperty.Period http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period
Type: string or Token
or None
-
-
class
ThrottleSettingsProperty
¶ -
burstLimit
¶ UsagePlanResource.ThrottleSettingsProperty.BurstLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit
Type: number or Token
or None
-
rateLimit
¶ UsagePlanResource.ThrottleSettingsProperty.RateLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit
Type: number or Token
or None
-
- parent (
UsagePlanResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
UsagePlanResourceProps
¶ -
apiStages
¶ AWS::ApiGateway::UsagePlan.ApiStages http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages
Type: Token
orToken
orApiStageProperty
or None
-
description
¶ AWS::ApiGateway::UsagePlan.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description
Type: string or Token
or None
-
quota
¶ AWS::ApiGateway::UsagePlan.Quota http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota
Type: Token
orQuotaSettingsProperty
or None
-
throttle
¶ AWS::ApiGateway::UsagePlan.Throttle http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle
Type: Token
orThrottleSettingsProperty
or None
-
usagePlanName
¶ AWS::ApiGateway::UsagePlan.UsagePlanName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname
Type: string or Token
or None
-
VpcLinkResource¶
-
class
_aws-cdk_resources.apigateway.
VpcLinkResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VpcLinkResource is a part of - name (string) –
- props (
VpcLinkResourceProps
or None) – the properties of this VpcLinkResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VpcLinkResourceProps (interface)¶
-
class
_aws-cdk_resources.apigateway.
VpcLinkResourceProps
¶ -
description
¶ AWS::ApiGateway::VpcLink.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description
Type: string or Token
or None
-
targetArns
¶ AWS::ApiGateway::VpcLink.TargetArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns
Type: Token
or string orToken
-
vpcLinkName
¶ AWS::ApiGateway::VpcLink.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name
Type: string or Token
-
applicationautoscaling¶
ScalableTargetResource¶
-
class
_aws-cdk_resources.applicationautoscaling.
ScalableTargetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ScalableTargetResource is a part of - name (string) –
- props (
ScalableTargetResourceProps
or None) – the properties of this ScalableTargetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ScalableTargetActionProperty
¶ -
maxCapacity
¶ ScalableTargetResource.ScalableTargetActionProperty.MaxCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html#cfn-applicationautoscaling-scalabletarget-scalabletargetaction-maxcapacity
Type: number or Token
or None
-
minCapacity
¶ ScalableTargetResource.ScalableTargetActionProperty.MinCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scalabletargetaction.html#cfn-applicationautoscaling-scalabletarget-scalabletargetaction-mincapacity
Type: number or Token
or None
-
-
class
ScheduledActionProperty
¶ -
endTime
¶ ScalableTargetResource.ScheduledActionProperty.EndTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-endtime
Type: Token
or date or None
-
scalableTargetAction
¶ ScalableTargetResource.ScheduledActionProperty.ScalableTargetAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scalabletargetaction
Type: Token
orScalableTargetActionProperty
or None
-
schedule
¶ ScalableTargetResource.ScheduledActionProperty.Schedule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-schedule
Type: string or Token
-
scheduledActionName
¶ ScalableTargetResource.ScheduledActionProperty.ScheduledActionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-scheduledactionname
Type: string or Token
-
startTime
¶ ScalableTargetResource.ScheduledActionProperty.StartTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-starttime
Type: Token
or date or None
-
- parent (
ScalableTargetResourceProps (interface)¶
-
class
_aws-cdk_resources.applicationautoscaling.
ScalableTargetResourceProps
¶ -
maxCapacity
¶ AWS::ApplicationAutoScaling::ScalableTarget.MaxCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-maxcapacity
Type: number or Token
-
minCapacity
¶ AWS::ApplicationAutoScaling::ScalableTarget.MinCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-mincapacity
Type: number or Token
-
resourceId
¶ AWS::ApplicationAutoScaling::ScalableTarget.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-resourceid
Type: string or Token
-
roleArn
¶ AWS::ApplicationAutoScaling::ScalableTarget.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-rolearn
Type: string or Token
-
scalableDimension
¶ AWS::ApplicationAutoScaling::ScalableTarget.ScalableDimension http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scalabledimension
Type: string or Token
-
scheduledActions
¶ AWS::ApplicationAutoScaling::ScalableTarget.ScheduledActions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-scheduledactions
Type: Token
orToken
orScheduledActionProperty
or None
-
serviceNamespace
¶ AWS::ApplicationAutoScaling::ScalableTarget.ServiceNamespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html#cfn-applicationautoscaling-scalabletarget-servicenamespace
Type: string or Token
-
ScalingPolicyResource¶
-
class
_aws-cdk_resources.applicationautoscaling.
ScalingPolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ScalingPolicyResource is a part of - name (string) –
- props (
ScalingPolicyResourceProps
or None) – the properties of this ScalingPolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
CustomizedMetricSpecificationProperty
¶ -
dimensions
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Dimensions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-dimensions
Type: Token
orToken
orMetricDimensionProperty
or None
-
metricName
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-metricname
Type: string or Token
-
namespace
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-namespace
Type: string or Token
-
statistic
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Statistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-statistic
Type: string or Token
-
unit
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-customizedmetricspecification-unit
Type: string or Token
or None
-
-
class
MetricDimensionProperty
¶ -
name
¶ ScalingPolicyResource.MetricDimensionProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html#cfn-applicationautoscaling-scalingpolicy-metricdimension-name
Type: string or Token
-
value
¶ ScalingPolicyResource.MetricDimensionProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-metricdimension.html#cfn-applicationautoscaling-scalingpolicy-metricdimension-value
Type: string or Token
-
-
class
PredefinedMetricSpecificationProperty
¶ -
predefinedMetricType
¶ ScalingPolicyResource.PredefinedMetricSpecificationProperty.PredefinedMetricType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype
Type: string or Token
-
resourceLabel
¶ ScalingPolicyResource.PredefinedMetricSpecificationProperty.ResourceLabel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-applicationautoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel
Type: string or Token
or None
-
-
class
StepAdjustmentProperty
¶ -
metricIntervalLowerBound
¶ ScalingPolicyResource.StepAdjustmentProperty.MetricIntervalLowerBound http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment-metricintervallowerbound
Type: number or Token
or None
-
metricIntervalUpperBound
¶ ScalingPolicyResource.StepAdjustmentProperty.MetricIntervalUpperBound http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment-metricintervalupperbound
Type: number or Token
or None
-
scalingAdjustment
¶ ScalingPolicyResource.StepAdjustmentProperty.ScalingAdjustment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustment-scalingadjustment
Type: number or Token
-
-
class
StepScalingPolicyConfigurationProperty
¶ -
adjustmentType
¶ ScalingPolicyResource.StepScalingPolicyConfigurationProperty.AdjustmentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-adjustmenttype
Type: string or Token
or None
-
cooldown
¶ ScalingPolicyResource.StepScalingPolicyConfigurationProperty.Cooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-cooldown
Type: number or Token
or None
-
metricAggregationType
¶ ScalingPolicyResource.StepScalingPolicyConfigurationProperty.MetricAggregationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-metricaggregationtype
Type: string or Token
or None
-
minAdjustmentMagnitude
¶ ScalingPolicyResource.StepScalingPolicyConfigurationProperty.MinAdjustmentMagnitude http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-minadjustmentmagnitude
Type: number or Token
or None
-
stepAdjustments
¶ ScalingPolicyResource.StepScalingPolicyConfigurationProperty.StepAdjustments http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration-stepadjustments
Type: Token
orToken
orStepAdjustmentProperty
or None
-
-
class
TargetTrackingScalingPolicyConfigurationProperty
¶ -
customizedMetricSpecification
¶ ScalingPolicyResource.TargetTrackingScalingPolicyConfigurationProperty.CustomizedMetricSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-customizedmetricspecification
Type: Token
orCustomizedMetricSpecificationProperty
or None
-
disableScaleIn
¶ ScalingPolicyResource.TargetTrackingScalingPolicyConfigurationProperty.DisableScaleIn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-disablescalein
Type: boolean or Token
or None
-
predefinedMetricSpecification
¶ ScalingPolicyResource.TargetTrackingScalingPolicyConfigurationProperty.PredefinedMetricSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-predefinedmetricspecification
Type: Token
orPredefinedMetricSpecificationProperty
or None
-
scaleInCooldown
¶ ScalingPolicyResource.TargetTrackingScalingPolicyConfigurationProperty.ScaleInCooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleincooldown
Type: number or Token
or None
-
scaleOutCooldown
¶ ScalingPolicyResource.TargetTrackingScalingPolicyConfigurationProperty.ScaleOutCooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-scaleoutcooldown
Type: number or Token
or None
-
targetValue
¶ ScalingPolicyResource.TargetTrackingScalingPolicyConfigurationProperty.TargetValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration-targetvalue
Type: number or Token
-
- parent (
ScalingPolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.applicationautoscaling.
ScalingPolicyResourceProps
¶ -
policyName
¶ AWS::ApplicationAutoScaling::ScalingPolicy.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policyname
Type: string or Token
-
policyType
¶ AWS::ApplicationAutoScaling::ScalingPolicy.PolicyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-policytype
Type: string or Token
-
resourceId
¶ AWS::ApplicationAutoScaling::ScalingPolicy.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-resourceid
Type: string or Token
or None
-
scalableDimension
¶ AWS::ApplicationAutoScaling::ScalingPolicy.ScalableDimension http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalabledimension
Type: string or Token
or None
-
scalingTargetId
¶ AWS::ApplicationAutoScaling::ScalingPolicy.ScalingTargetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-scalingtargetid
Type: string or Token
or None
-
serviceNamespace
¶ AWS::ApplicationAutoScaling::ScalingPolicy.ServiceNamespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-servicenamespace
Type: string or Token
or None
-
stepScalingPolicyConfiguration
¶ AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration
Type: Token
orStepScalingPolicyConfigurationProperty
or None
-
targetTrackingScalingPolicyConfiguration
¶ AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#cfn-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration
Type: Token
orTargetTrackingScalingPolicyConfigurationProperty
or None
-
appsync¶
ApiKey¶
ApiKeyArn¶
ApiKeyResource¶
-
class
_aws-cdk_resources.appsync.
ApiKeyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApiKeyResource is a part of - name (string) –
- props (
ApiKeyResourceProps
or None) – the properties of this ApiKeyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
apiKey
¶ Type: ApiKey
(readonly)
-
apiKeyArn
¶ Type: ApiKeyArn
(readonly)
- parent (
ApiKeyResourceProps (interface)¶
-
class
_aws-cdk_resources.appsync.
ApiKeyResourceProps
¶ -
description
¶ AWS::AppSync::ApiKey.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description
Type: string or Token
or None
-
expires
¶ AWS::AppSync::ApiKey.Expires http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires
Type: number or Token
or None
-
apiId
¶ AWS::AppSync::ApiKey.ApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid
Type: string or Token
-
DataSourceArn¶
DataSourceName¶
DataSourceResource¶
-
class
_aws-cdk_resources.appsync.
DataSourceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DataSourceResource is a part of - name (string) –
- props (
DataSourceResourceProps
or None) – the properties of this DataSourceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
dataSourceArn
¶ Type: DataSourceArn
(readonly)
-
dataSourceName
¶ Type: DataSourceName
(readonly)
-
class
DynamoDBConfigProperty
¶ -
tableName
¶ DataSourceResource.DynamoDBConfigProperty.TableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-tablename
Type: string or Token
-
awsRegion
¶ DataSourceResource.DynamoDBConfigProperty.AwsRegion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-awsregion
Type: string or Token
-
useCallerCredentials
¶ DataSourceResource.DynamoDBConfigProperty.UseCallerCredentials http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-usecallercredentials
Type: boolean or Token
or None
-
-
class
ElasticsearchConfigProperty
¶ -
awsRegion
¶ DataSourceResource.ElasticsearchConfigProperty.AwsRegion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html#cfn-appsync-datasource-elasticsearchconfig-awsregion
Type: string or Token
-
endpoint
¶ DataSourceResource.ElasticsearchConfigProperty.Endpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-elasticsearchconfig.html#cfn-appsync-datasource-elasticsearchconfig-endpoint
Type: string or Token
-
-
class
LambdaConfigProperty
¶ -
lambdaFunctionArn
¶ DataSourceResource.LambdaConfigProperty.LambdaFunctionArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-lambdaconfig.html#cfn-appsync-datasource-lambdaconfig-lambdafunctionarn
Type: string or Token
-
- parent (
DataSourceResourceProps (interface)¶
-
class
_aws-cdk_resources.appsync.
DataSourceResourceProps
¶ -
type
¶ AWS::AppSync::DataSource.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type
Type: string or Token
-
description
¶ AWS::AppSync::DataSource.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description
Type: string or Token
or None
-
serviceRoleArn
¶ AWS::AppSync::DataSource.ServiceRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn
Type: string or Token
or None
-
lambdaConfig
¶ AWS::AppSync::DataSource.LambdaConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-lambdaconfig
Type: Token
orLambdaConfigProperty
or None
-
apiId
¶ AWS::AppSync::DataSource.ApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-apiid
Type: string or Token
-
dataSourceName
¶ AWS::AppSync::DataSource.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name
Type: string or Token
-
dynamoDbConfig
¶ AWS::AppSync::DataSource.DynamoDBConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-dynamodbconfig
Type: Token
orDynamoDBConfigProperty
or None
-
elasticsearchConfig
¶ AWS::AppSync::DataSource.ElasticsearchConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-elasticsearchconfig
Type: Token
orElasticsearchConfigProperty
or None
-
GraphQLApiApiId¶
GraphQLApiArn¶
GraphQLApiGraphQlUrl¶
GraphQLApiResource¶
-
class
_aws-cdk_resources.appsync.
GraphQLApiResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this GraphQLApiResource is a part of - name (string) –
- props (
GraphQLApiResourceProps
or None) – the properties of this GraphQLApiResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
graphQlApiGraphQlUrl
¶ Type: GraphQLApiGraphQlUrl
(readonly)
-
graphQlApiArn
¶ Type: GraphQLApiArn
(readonly)
-
graphQlApiApiId
¶ Type: GraphQLApiApiId
(readonly)
-
class
LogConfigProperty
¶ -
cloudWatchLogsRoleArn
¶ GraphQLApiResource.LogConfigProperty.CloudWatchLogsRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-cloudwatchlogsrolearn
Type: string or Token
or None
-
fieldLogLevel
¶ GraphQLApiResource.LogConfigProperty.FieldLogLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-fieldloglevel
Type: string or Token
or None
-
-
class
OpenIDConnectConfigProperty
¶ -
issuer
¶ GraphQLApiResource.OpenIDConnectConfigProperty.Issuer http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-issuer
Type: string or Token
or None
-
clientId
¶ GraphQLApiResource.OpenIDConnectConfigProperty.ClientId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-clientid
Type: string or Token
or None
-
authTtl
¶ GraphQLApiResource.OpenIDConnectConfigProperty.AuthTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-authttl
Type: number or Token
or None
-
iatTtl
¶ GraphQLApiResource.OpenIDConnectConfigProperty.IatTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html#cfn-appsync-graphqlapi-openidconnectconfig-iatttl
Type: number or Token
or None
-
-
class
UserPoolConfigProperty
¶ -
appIdClientRegex
¶ GraphQLApiResource.UserPoolConfigProperty.AppIdClientRegex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-appidclientregex
Type: string or Token
or None
-
userPoolId
¶ GraphQLApiResource.UserPoolConfigProperty.UserPoolId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-userpoolid
Type: string or Token
or None
-
awsRegion
¶ GraphQLApiResource.UserPoolConfigProperty.AwsRegion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-awsregion
Type: string or Token
or None
-
defaultAction
¶ GraphQLApiResource.UserPoolConfigProperty.DefaultAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html#cfn-appsync-graphqlapi-userpoolconfig-defaultaction
Type: string or Token
or None
-
- parent (
GraphQLApiResourceProps (interface)¶
-
class
_aws-cdk_resources.appsync.
GraphQLApiResourceProps
¶ -
openIdConnectConfig
¶ AWS::AppSync::GraphQLApi.OpenIDConnectConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig
Type: Token
orOpenIDConnectConfigProperty
or None
-
userPoolConfig
¶ AWS::AppSync::GraphQLApi.UserPoolConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig
Type: Token
orUserPoolConfigProperty
or None
-
graphQlApiName
¶ AWS::AppSync::GraphQLApi.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name
Type: string or Token
-
authenticationType
¶ AWS::AppSync::GraphQLApi.AuthenticationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype
Type: string or Token
-
logConfig
¶ AWS::AppSync::GraphQLApi.LogConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig
Type: Token
orLogConfigProperty
or None
-
GraphQLSchemaResource¶
-
class
_aws-cdk_resources.appsync.
GraphQLSchemaResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this GraphQLSchemaResource is a part of - name (string) –
- props (
GraphQLSchemaResourceProps
or None) – the properties of this GraphQLSchemaResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
GraphQLSchemaResourceProps (interface)¶
-
class
_aws-cdk_resources.appsync.
GraphQLSchemaResourceProps
¶ -
definition
¶ AWS::AppSync::GraphQLSchema.Definition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition
Type: string or Token
or None
-
definitionS3Location
¶ AWS::AppSync::GraphQLSchema.DefinitionS3Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location
Type: string or Token
or None
-
apiId
¶ AWS::AppSync::GraphQLSchema.ApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-apiid
Type: string or Token
-
ResolverArn¶
ResolverFieldName¶
ResolverResource¶
-
class
_aws-cdk_resources.appsync.
ResolverResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ResolverResource is a part of - name (string) –
- props (
ResolverResourceProps
or None) – the properties of this ResolverResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
resolverTypeName
¶ Type: ResolverTypeName
(readonly)
-
resolverArn
¶ Type: ResolverArn
(readonly)
-
resolverFieldName
¶ Type: ResolverFieldName
(readonly)
- parent (
ResolverResourceProps (interface)¶
-
class
_aws-cdk_resources.appsync.
ResolverResourceProps
¶ -
responseMappingTemplateS3Location
¶ AWS::AppSync::Resolver.ResponseMappingTemplateS3Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplates3location
Type: string or Token
or None
-
typeName
¶ AWS::AppSync::Resolver.TypeName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-typename
Type: string or Token
-
dataSourceName
¶ AWS::AppSync::Resolver.DataSourceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-datasourcename
Type: string or Token
-
requestMappingTemplate
¶ AWS::AppSync::Resolver.RequestMappingTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplate
Type: string or Token
or None
-
responseMappingTemplate
¶ AWS::AppSync::Resolver.ResponseMappingTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-responsemappingtemplate
Type: string or Token
or None
-
requestMappingTemplateS3Location
¶ AWS::AppSync::Resolver.RequestMappingTemplateS3Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-requestmappingtemplates3location
Type: string or Token
or None
-
apiId
¶ AWS::AppSync::Resolver.ApiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-apiid
Type: string or Token
-
fieldName
¶ AWS::AppSync::Resolver.FieldName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-fieldname
Type: string or Token
-
athena¶
NamedQueryResource¶
-
class
_aws-cdk_resources.athena.
NamedQueryResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NamedQueryResource is a part of - name (string) –
- props (
NamedQueryResourceProps
or None) – the properties of this NamedQueryResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
NamedQueryResourceProps (interface)¶
-
class
_aws-cdk_resources.athena.
NamedQueryResourceProps
¶ -
description
¶ AWS::Athena::NamedQuery.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-description
Type: string or Token
or None
-
queryString
¶ AWS::Athena::NamedQuery.QueryString http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-querystring
Type: string or Token
-
database
¶ AWS::Athena::NamedQuery.Database http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-database
Type: string or Token
-
namedQueryName
¶ AWS::Athena::NamedQuery.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-namedquery.html#cfn-athena-namedquery-name
Type: string or Token
or None
-
autoscaling¶
AutoScalingGroupResource¶
-
class
_aws-cdk_resources.autoscaling.
AutoScalingGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AutoScalingGroupResource is a part of - name (string) –
- props (
AutoScalingGroupResourceProps
or None) – the properties of this AutoScalingGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
LifecycleHookSpecificationProperty
¶ -
defaultResult
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.DefaultResult http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-defaultresult
Type: string or Token
or None
-
heartbeatTimeout
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.HeartbeatTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-heartbeattimeout
Type: number or Token
or None
-
lifecycleHookName
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.LifecycleHookName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecyclehookname
Type: string or Token
-
lifecycleTransition
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.LifecycleTransition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-lifecycletransition
Type: string or Token
-
notificationMetadata
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.NotificationMetadata http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationmetadata
Type: string or Token
or None
-
notificationTargetArn
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.NotificationTargetARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-notificationtargetarn
Type: string or Token
or None
-
roleArn
¶ AutoScalingGroupResource.LifecycleHookSpecificationProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecification-rolearn
Type: string or Token
or None
-
-
class
MetricsCollectionProperty
¶ -
granularity
¶ AutoScalingGroupResource.MetricsCollectionProperty.Granularity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-granularity
Type: string or Token
-
metrics
¶ AutoScalingGroupResource.MetricsCollectionProperty.Metrics http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-metricscollection.html#cfn-as-metricscollection-metrics
Type: Token
or string orToken
or None
-
-
class
NotificationConfigurationProperty
¶ -
notificationTypes
¶ AutoScalingGroupResource.NotificationConfigurationProperty.NotificationTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html#cfn-as-group-notificationconfigurations-notificationtypes
Type: Token
or string orToken
or None
-
topicArn
¶ AutoScalingGroupResource.NotificationConfigurationProperty.TopicARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-notificationconfigurations.html#cfn-autoscaling-autoscalinggroup-notificationconfigurations-topicarn
Type: string or Token
-
-
class
TagPropertyProperty
¶ -
key
¶ AutoScalingGroupResource.TagPropertyProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-Key
Type: string or Token
-
propagateAtLaunch
¶ AutoScalingGroupResource.TagPropertyProperty.PropagateAtLaunch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-PropagateAtLaunch
Type: boolean or Token
-
value
¶ AutoScalingGroupResource.TagPropertyProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-tags.html#cfn-as-tags-Value
Type: string or Token
-
- parent (
AutoScalingGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.autoscaling.
AutoScalingGroupResourceProps
¶ -
autoScalingGroupName
¶ AWS::AutoScaling::AutoScalingGroup.AutoScalingGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-autoscalinggroupname
Type: string or Token
or None
-
availabilityZones
¶ AWS::AutoScaling::AutoScalingGroup.AvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-availabilityzones
Type: Token
or string orToken
or None
-
cooldown
¶ AWS::AutoScaling::AutoScalingGroup.Cooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-cooldown
Type: string or Token
or None
-
desiredCapacity
¶ AWS::AutoScaling::AutoScalingGroup.DesiredCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity
Type: string or Token
or None
-
healthCheckGracePeriod
¶ AWS::AutoScaling::AutoScalingGroup.HealthCheckGracePeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-healthcheckgraceperiod
Type: number or Token
or None
-
healthCheckType
¶ AWS::AutoScaling::AutoScalingGroup.HealthCheckType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-healthchecktype
Type: string or Token
or None
-
instanceId
¶ AWS::AutoScaling::AutoScalingGroup.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-instanceid
Type: string or Token
or None
-
launchConfigurationName
¶ AWS::AutoScaling::AutoScalingGroup.LaunchConfigurationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-launchconfigurationname
Type: string or Token
or None
-
lifecycleHookSpecificationList
¶ AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecificationList http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-lifecyclehookspecificationlist
Type: Token
orToken
orLifecycleHookSpecificationProperty
or None
-
loadBalancerNames
¶ AWS::AutoScaling::AutoScalingGroup.LoadBalancerNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-loadbalancernames
Type: Token
or string orToken
or None
-
maxSize
¶ AWS::AutoScaling::AutoScalingGroup.MaxSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-maxsize
Type: string or Token
-
metricsCollection
¶ AWS::AutoScaling::AutoScalingGroup.MetricsCollection http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-metricscollection
Type: Token
orToken
orMetricsCollectionProperty
or None
-
minSize
¶ AWS::AutoScaling::AutoScalingGroup.MinSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-minsize
Type: string or Token
-
notificationConfigurations
¶ AWS::AutoScaling::AutoScalingGroup.NotificationConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations
Type: Token
orToken
orNotificationConfigurationProperty
or None
-
placementGroup
¶ AWS::AutoScaling::AutoScalingGroup.PlacementGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-placementgroup
Type: string or Token
or None
-
serviceLinkedRoleArn
¶ AWS::AutoScaling::AutoScalingGroup.ServiceLinkedRoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-autoscaling-autoscalinggroup-servicelinkedrolearn
Type: string or Token
or None
AWS::AutoScaling::AutoScalingGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-tags
Type: Token
orToken
orTagPropertyProperty
or None
-
targetGroupArns
¶ AWS::AutoScaling::AutoScalingGroup.TargetGroupARNs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-targetgrouparns
Type: Token
or string orToken
or None
-
terminationPolicies
¶ AWS::AutoScaling::AutoScalingGroup.TerminationPolicies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-termpolicy
Type: Token
or string orToken
or None
-
vpcZoneIdentifier
¶ AWS::AutoScaling::AutoScalingGroup.VPCZoneIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-vpczoneidentifier
Type: Token
or string orToken
or None
-
LaunchConfigurationResource¶
-
class
_aws-cdk_resources.autoscaling.
LaunchConfigurationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LaunchConfigurationResource is a part of - name (string) –
- props (
LaunchConfigurationResourceProps
or None) – the properties of this LaunchConfigurationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
BlockDeviceMappingProperty
¶ -
deviceName
¶ LaunchConfigurationResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-devicename
Type: string or Token
-
ebs
¶ LaunchConfigurationResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-ebs
Type: Token
orBlockDeviceProperty
or None
-
noDevice
¶ LaunchConfigurationResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-nodevice
Type: boolean or Token
or None
-
virtualName
¶ LaunchConfigurationResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-mapping.html#cfn-as-launchconfig-blockdev-mapping-virtualname
Type: string or Token
or None
-
-
class
BlockDeviceProperty
¶ -
deleteOnTermination
¶ LaunchConfigurationResource.BlockDeviceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-deleteonterm
Type: boolean or Token
or None
-
encrypted
¶ LaunchConfigurationResource.BlockDeviceProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-encrypted
Type: boolean or Token
or None
-
iops
¶ LaunchConfigurationResource.BlockDeviceProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-iops
Type: number or Token
or None
-
snapshotId
¶ LaunchConfigurationResource.BlockDeviceProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-snapshotid
Type: string or Token
or None
-
volumeSize
¶ LaunchConfigurationResource.BlockDeviceProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-volumesize
Type: number or Token
or None
-
volumeType
¶ LaunchConfigurationResource.BlockDeviceProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig-blockdev-template.html#cfn-as-launchconfig-blockdev-template-volumetype
Type: string or Token
or None
-
- parent (
LaunchConfigurationResourceProps (interface)¶
-
class
_aws-cdk_resources.autoscaling.
LaunchConfigurationResourceProps
¶ -
associatePublicIpAddress
¶ AWS::AutoScaling::LaunchConfiguration.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cf-as-launchconfig-associatepubip
Type: boolean or Token
or None
-
blockDeviceMappings
¶ AWS::AutoScaling::LaunchConfiguration.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-blockdevicemappings
Type: Token
orToken
orBlockDeviceMappingProperty
or None
-
classicLinkVpcId
¶ AWS::AutoScaling::LaunchConfiguration.ClassicLinkVPCId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-classiclinkvpcid
Type: string or Token
or None
-
classicLinkVpcSecurityGroups
¶ AWS::AutoScaling::LaunchConfiguration.ClassicLinkVPCSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-classiclinkvpcsecuritygroups
Type: Token
or string orToken
or None
-
ebsOptimized
¶ AWS::AutoScaling::LaunchConfiguration.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-ebsoptimized
Type: boolean or Token
or None
-
iamInstanceProfile
¶ AWS::AutoScaling::LaunchConfiguration.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-iaminstanceprofile
Type: string or Token
or None
-
imageId
¶ AWS::AutoScaling::LaunchConfiguration.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-imageid
Type: string or Token
-
instanceId
¶ AWS::AutoScaling::LaunchConfiguration.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-instanceid
Type: string or Token
or None
-
instanceMonitoring
¶ AWS::AutoScaling::LaunchConfiguration.InstanceMonitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-instancemonitoring
Type: boolean or Token
or None
-
instanceType
¶ AWS::AutoScaling::LaunchConfiguration.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-instancetype
Type: string or Token
-
kernelId
¶ AWS::AutoScaling::LaunchConfiguration.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-kernelid
Type: string or Token
or None
-
keyName
¶ AWS::AutoScaling::LaunchConfiguration.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-keyname
Type: string or Token
or None
-
launchConfigurationName
¶ AWS::AutoScaling::LaunchConfiguration.LaunchConfigurationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-autoscaling-launchconfig-launchconfigurationname
Type: string or Token
or None
-
placementTenancy
¶ AWS::AutoScaling::LaunchConfiguration.PlacementTenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-placementtenancy
Type: string or Token
or None
-
ramDiskId
¶ AWS::AutoScaling::LaunchConfiguration.RamDiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-ramdiskid
Type: string or Token
or None
-
securityGroups
¶ AWS::AutoScaling::LaunchConfiguration.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-securitygroups
Type: Token
or string orToken
or None
-
spotPrice
¶ AWS::AutoScaling::LaunchConfiguration.SpotPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-spotprice
Type: string or Token
or None
-
userData
¶ AWS::AutoScaling::LaunchConfiguration.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-launchconfig.html#cfn-as-launchconfig-userdata
Type: string or Token
or None
-
LifecycleHookResource¶
-
class
_aws-cdk_resources.autoscaling.
LifecycleHookResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LifecycleHookResource is a part of - name (string) –
- props (
LifecycleHookResourceProps
or None) – the properties of this LifecycleHookResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
LifecycleHookResourceProps (interface)¶
-
class
_aws-cdk_resources.autoscaling.
LifecycleHookResourceProps
¶ -
autoScalingGroupName
¶ AWS::AutoScaling::LifecycleHook.AutoScalingGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-autoscalinggroupname
Type: string or Token
-
defaultResult
¶ AWS::AutoScaling::LifecycleHook.DefaultResult http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-defaultresult
Type: string or Token
or None
-
heartbeatTimeout
¶ AWS::AutoScaling::LifecycleHook.HeartbeatTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-heartbeattimeout
Type: number or Token
or None
-
lifecycleHookName
¶ AWS::AutoScaling::LifecycleHook.LifecycleHookName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecyclehookname
Type: string or Token
or None
-
lifecycleTransition
¶ AWS::AutoScaling::LifecycleHook.LifecycleTransition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-lifecycletransition
Type: string or Token
-
notificationMetadata
¶ AWS::AutoScaling::LifecycleHook.NotificationMetadata http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-notificationmetadata
Type: string or Token
or None
-
notificationTargetArn
¶ AWS::AutoScaling::LifecycleHook.NotificationTargetARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-notificationtargetarn
Type: string or Token
or None
-
roleArn
¶ AWS::AutoScaling::LifecycleHook.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#cfn-as-lifecyclehook-rolearn
Type: string or Token
or None
-
ScalingPolicyResource¶
-
class
_aws-cdk_resources.autoscaling.
ScalingPolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ScalingPolicyResource is a part of - name (string) –
- props (
ScalingPolicyResourceProps
or None) – the properties of this ScalingPolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
CustomizedMetricSpecificationProperty
¶ -
dimensions
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Dimensions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-dimensions
Type: Token
orToken
orMetricDimensionProperty
or None
-
metricName
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-metricname
Type: string or Token
-
namespace
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-namespace
Type: string or Token
-
statistic
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Statistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-statistic
Type: string or Token
-
unit
¶ ScalingPolicyResource.CustomizedMetricSpecificationProperty.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html#cfn-autoscaling-scalingpolicy-customizedmetricspecification-unit
Type: string or Token
or None
-
-
class
MetricDimensionProperty
¶ -
name
¶ ScalingPolicyResource.MetricDimensionProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html#cfn-autoscaling-scalingpolicy-metricdimension-name
Type: string or Token
-
value
¶ ScalingPolicyResource.MetricDimensionProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-metricdimension.html#cfn-autoscaling-scalingpolicy-metricdimension-value
Type: string or Token
-
-
class
PredefinedMetricSpecificationProperty
¶ -
predefinedMetricType
¶ ScalingPolicyResource.PredefinedMetricSpecificationProperty.PredefinedMetricType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-predefinedmetrictype
Type: string or Token
-
resourceLabel
¶ ScalingPolicyResource.PredefinedMetricSpecificationProperty.ResourceLabel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html#cfn-autoscaling-scalingpolicy-predefinedmetricspecification-resourcelabel
Type: string or Token
or None
-
-
class
StepAdjustmentProperty
¶ -
metricIntervalLowerBound
¶ ScalingPolicyResource.StepAdjustmentProperty.MetricIntervalLowerBound http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html#cfn-autoscaling-scalingpolicy-stepadjustment-metricintervallowerbound
Type: number or Token
or None
-
metricIntervalUpperBound
¶ ScalingPolicyResource.StepAdjustmentProperty.MetricIntervalUpperBound http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html#cfn-autoscaling-scalingpolicy-stepadjustment-metricintervalupperbound
Type: number or Token
or None
-
scalingAdjustment
¶ ScalingPolicyResource.StepAdjustmentProperty.ScalingAdjustment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-stepadjustments.html#cfn-autoscaling-scalingpolicy-stepadjustment-scalingadjustment
Type: number or Token
-
-
class
TargetTrackingConfigurationProperty
¶ -
customizedMetricSpecification
¶ ScalingPolicyResource.TargetTrackingConfigurationProperty.CustomizedMetricSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-customizedmetricspecification
Type: Token
orCustomizedMetricSpecificationProperty
or None
-
disableScaleIn
¶ ScalingPolicyResource.TargetTrackingConfigurationProperty.DisableScaleIn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-disablescalein
Type: boolean or Token
or None
-
predefinedMetricSpecification
¶ ScalingPolicyResource.TargetTrackingConfigurationProperty.PredefinedMetricSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-predefinedmetricspecification
Type: Token
orPredefinedMetricSpecificationProperty
or None
-
targetValue
¶ ScalingPolicyResource.TargetTrackingConfigurationProperty.TargetValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-targettrackingconfiguration.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration-targetvalue
Type: number or Token
-
- parent (
ScalingPolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.autoscaling.
ScalingPolicyResourceProps
¶ -
adjustmentType
¶ AWS::AutoScaling::ScalingPolicy.AdjustmentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-adjustmenttype
Type: string or Token
or None
-
autoScalingGroupName
¶ AWS::AutoScaling::ScalingPolicy.AutoScalingGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-autoscalinggroupname
Type: string or Token
-
cooldown
¶ AWS::AutoScaling::ScalingPolicy.Cooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-cooldown
Type: string or Token
or None
-
estimatedInstanceWarmup
¶ AWS::AutoScaling::ScalingPolicy.EstimatedInstanceWarmup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-estimatedinstancewarmup
Type: number or Token
or None
-
metricAggregationType
¶ AWS::AutoScaling::ScalingPolicy.MetricAggregationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-metricaggregationtype
Type: string or Token
or None
-
minAdjustmentMagnitude
¶ AWS::AutoScaling::ScalingPolicy.MinAdjustmentMagnitude http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-minadjustmentmagnitude
Type: number or Token
or None
-
policyType
¶ AWS::AutoScaling::ScalingPolicy.PolicyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-policytype
Type: string or Token
or None
-
scalingAdjustment
¶ AWS::AutoScaling::ScalingPolicy.ScalingAdjustment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-scalingadjustment
Type: number or Token
or None
-
stepAdjustments
¶ AWS::AutoScaling::ScalingPolicy.StepAdjustments http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-as-scalingpolicy-stepadjustments
Type: Token
orToken
orStepAdjustmentProperty
or None
-
targetTrackingConfiguration
¶ AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-policy.html#cfn-autoscaling-scalingpolicy-targettrackingconfiguration
Type: Token
orTargetTrackingConfigurationProperty
or None
-
ScheduledActionResource¶
-
class
_aws-cdk_resources.autoscaling.
ScheduledActionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ScheduledActionResource is a part of - name (string) –
- props (
ScheduledActionResourceProps
or None) – the properties of this ScheduledActionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ScheduledActionResourceProps (interface)¶
-
class
_aws-cdk_resources.autoscaling.
ScheduledActionResourceProps
¶ -
autoScalingGroupName
¶ AWS::AutoScaling::ScheduledAction.AutoScalingGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-asgname
Type: string or Token
-
desiredCapacity
¶ AWS::AutoScaling::ScheduledAction.DesiredCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-desiredcapacity
Type: number or Token
or None
-
endTime
¶ AWS::AutoScaling::ScheduledAction.EndTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-endtime
Type: string or Token
or None
-
maxSize
¶ AWS::AutoScaling::ScheduledAction.MaxSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-maxsize
Type: number or Token
or None
-
minSize
¶ AWS::AutoScaling::ScheduledAction.MinSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-minsize
Type: number or Token
or None
-
recurrence
¶ AWS::AutoScaling::ScheduledAction.Recurrence http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-recurrence
Type: string or Token
or None
-
startTime
¶ AWS::AutoScaling::ScheduledAction.StartTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html#cfn-as-scheduledaction-starttime
Type: string or Token
or None
-
autoscalingplans¶
ScalingPlanResource¶
-
class
_aws-cdk_resources.autoscalingplans.
ScalingPlanResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ScalingPlanResource is a part of - name (string) –
- props (
ScalingPlanResourceProps
or None) – the properties of this ScalingPlanResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ApplicationSourceProperty
¶ -
cloudFormationStackArn
¶ ScalingPlanResource.ApplicationSourceProperty.CloudFormationStackARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-cloudformationstackarn
Type: string or Token
or None
-
tagFilters
¶ ScalingPlanResource.ApplicationSourceProperty.TagFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-applicationsource.html#cfn-autoscalingplans-scalingplan-applicationsource-tagfilters
Type: Token
orToken
orTagFilterProperty
or None
-
-
class
CustomizedScalingMetricSpecificationProperty
¶ -
metricName
¶ ScalingPlanResource.CustomizedScalingMetricSpecificationProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-metricname
Type: string or Token
-
statistic
¶ ScalingPlanResource.CustomizedScalingMetricSpecificationProperty.Statistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-statistic
Type: string or Token
-
dimensions
¶ ScalingPlanResource.CustomizedScalingMetricSpecificationProperty.Dimensions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-dimensions
Type: Token
orToken
orMetricDimensionProperty
or None
-
unit
¶ ScalingPlanResource.CustomizedScalingMetricSpecificationProperty.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-unit
Type: string or Token
or None
-
namespace
¶ ScalingPlanResource.CustomizedScalingMetricSpecificationProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-customizedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-customizedscalingmetricspecification-namespace
Type: string or Token
-
-
class
MetricDimensionProperty
¶ -
value
¶ ScalingPlanResource.MetricDimensionProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-value
Type: string or Token
-
name
¶ ScalingPlanResource.MetricDimensionProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html#cfn-autoscalingplans-scalingplan-metricdimension-name
Type: string or Token
-
-
class
PredefinedScalingMetricSpecificationProperty
¶ -
resourceLabel
¶ ScalingPlanResource.PredefinedScalingMetricSpecificationProperty.ResourceLabel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-resourcelabel
Type: string or Token
or None
-
predefinedScalingMetricType
¶ ScalingPlanResource.PredefinedScalingMetricSpecificationProperty.PredefinedScalingMetricType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-predefinedscalingmetricspecification.html#cfn-autoscalingplans-scalingplan-predefinedscalingmetricspecification-predefinedscalingmetrictype
Type: string or Token
-
-
class
ScalingInstructionProperty
¶ -
resourceId
¶ ScalingPlanResource.ScalingInstructionProperty.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-resourceid
Type: string or Token
-
serviceNamespace
¶ ScalingPlanResource.ScalingInstructionProperty.ServiceNamespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-servicenamespace
Type: string or Token
-
scalableDimension
¶ ScalingPlanResource.ScalingInstructionProperty.ScalableDimension http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-scalabledimension
Type: string or Token
-
minCapacity
¶ ScalingPlanResource.ScalingInstructionProperty.MinCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-mincapacity
Type: number or Token
-
targetTrackingConfigurations
¶ ScalingPlanResource.ScalingInstructionProperty.TargetTrackingConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-targettrackingconfigurations
Type: Token
orToken
orTargetTrackingConfigurationProperty
-
maxCapacity
¶ ScalingPlanResource.ScalingInstructionProperty.MaxCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-scalinginstruction.html#cfn-autoscalingplans-scalingplan-scalinginstruction-maxcapacity
Type: number or Token
-
-
class
TagFilterProperty
¶ -
values
¶ ScalingPlanResource.TagFilterProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-values
Type: Token
or string orToken
or None
-
key
¶ ScalingPlanResource.TagFilterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-tagfilter.html#cfn-autoscalingplans-scalingplan-tagfilter-key
Type: string or Token
-
-
class
TargetTrackingConfigurationProperty
¶ -
scaleOutCooldown
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.ScaleOutCooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleoutcooldown
Type: number or Token
or None
-
targetValue
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.TargetValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-targetvalue
Type: number or Token
-
predefinedScalingMetricSpecification
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.PredefinedScalingMetricSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-predefinedscalingmetricspecification
Type: Token
orPredefinedScalingMetricSpecificationProperty
or None
-
disableScaleIn
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.DisableScaleIn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-disablescalein
Type: boolean or Token
or None
-
scaleInCooldown
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.ScaleInCooldown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-scaleincooldown
Type: number or Token
or None
-
estimatedInstanceWarmup
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.EstimatedInstanceWarmup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-estimatedinstancewarmup
Type: number or Token
or None
-
customizedScalingMetricSpecification
¶ ScalingPlanResource.TargetTrackingConfigurationProperty.CustomizedScalingMetricSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-targettrackingconfiguration.html#cfn-autoscalingplans-scalingplan-targettrackingconfiguration-customizedscalingmetricspecification
Type: Token
orCustomizedScalingMetricSpecificationProperty
or None
-
- parent (
ScalingPlanResourceProps (interface)¶
-
class
_aws-cdk_resources.autoscalingplans.
ScalingPlanResourceProps
¶ -
applicationSource
¶ AWS::AutoScalingPlans::ScalingPlan.ApplicationSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-applicationsource
Type: Token
orApplicationSourceProperty
-
scalingInstructions
¶ AWS::AutoScalingPlans::ScalingPlan.ScalingInstructions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscalingplans-scalingplan.html#cfn-autoscalingplans-scalingplan-scalinginstructions
Type: Token
orToken
orScalingInstructionProperty
-
batch¶
ComputeEnvironmentResource¶
-
class
_aws-cdk_resources.batch.
ComputeEnvironmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ComputeEnvironmentResource is a part of - name (string) –
- props (
ComputeEnvironmentResourceProps
or None) – the properties of this ComputeEnvironmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ComputeResourcesProperty
¶ -
spotIamFleetRole
¶ ComputeEnvironmentResource.ComputeResourcesProperty.SpotIamFleetRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-spotiamfleetrole
Type: string or Token
or None
-
maxvCpus
¶ ComputeEnvironmentResource.ComputeResourcesProperty.MaxvCpus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus
Type: number or Token
-
bidPercentage
¶ ComputeEnvironmentResource.ComputeResourcesProperty.BidPercentage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage
Type: number or Token
or None
-
securityGroupIds
¶ ComputeEnvironmentResource.ComputeResourcesProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids
Type: Token
or string orToken
-
subnets
¶ ComputeEnvironmentResource.ComputeResourcesProperty.Subnets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets
Type: Token
or string orToken
-
type
¶ ComputeEnvironmentResource.ComputeResourcesProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type
Type: string or Token
-
minvCpus
¶ ComputeEnvironmentResource.ComputeResourcesProperty.MinvCpus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus
Type: number or Token
-
imageId
¶ ComputeEnvironmentResource.ComputeResourcesProperty.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid
Type: string or Token
or None
-
instanceRole
¶ ComputeEnvironmentResource.ComputeResourcesProperty.InstanceRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole
Type: string or Token
-
instanceTypes
¶ ComputeEnvironmentResource.ComputeResourcesProperty.InstanceTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes
Type: Token
or string orToken
-
ec2KeyPair
¶ ComputeEnvironmentResource.ComputeResourcesProperty.Ec2KeyPair http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair
Type: string or Token
or None
ComputeEnvironmentResource.ComputeResourcesProperty.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags
Type: json or Token
or None
-
desiredvCpus
¶ ComputeEnvironmentResource.ComputeResourcesProperty.DesiredvCpus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-desiredvcpus
Type: number or Token
or None
-
- parent (
ComputeEnvironmentResourceProps (interface)¶
-
class
_aws-cdk_resources.batch.
ComputeEnvironmentResourceProps
¶ -
type
¶ AWS::Batch::ComputeEnvironment.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-type
Type: string or Token
-
serviceRole
¶ AWS::Batch::ComputeEnvironment.ServiceRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole
Type: string or Token
-
computeEnvironmentName
¶ AWS::Batch::ComputeEnvironment.ComputeEnvironmentName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeenvironmentname
Type: string or Token
or None
-
computeResources
¶ AWS::Batch::ComputeEnvironment.ComputeResources http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeresources
Type: Token
orComputeResourcesProperty
or None
-
state
¶ AWS::Batch::ComputeEnvironment.State http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-state
Type: string or Token
or None
-
JobDefinitionResource¶
-
class
_aws-cdk_resources.batch.
JobDefinitionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this JobDefinitionResource is a part of - name (string) –
- props (
JobDefinitionResourceProps
or None) – the properties of this JobDefinitionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ContainerPropertiesProperty
¶ -
mountPoints
¶ JobDefinitionResource.ContainerPropertiesProperty.MountPoints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-mountpoints
Type: Token
orToken
orMountPointsProperty
or None
-
user
¶ JobDefinitionResource.ContainerPropertiesProperty.User http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-user
Type: string or Token
or None
-
volumes
¶ JobDefinitionResource.ContainerPropertiesProperty.Volumes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-volumes
Type: Token
orToken
orVolumesProperty
or None
-
command
¶ JobDefinitionResource.ContainerPropertiesProperty.Command http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-command
Type: Token
or string orToken
or None
-
memory
¶ JobDefinitionResource.ContainerPropertiesProperty.Memory http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-memory
Type: number or Token
-
privileged
¶ JobDefinitionResource.ContainerPropertiesProperty.Privileged http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-privileged
Type: boolean or Token
or None
-
environment
¶ JobDefinitionResource.ContainerPropertiesProperty.Environment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-environment
Type: Token
orToken
orEnvironmentProperty
or None
-
jobRoleArn
¶ JobDefinitionResource.ContainerPropertiesProperty.JobRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-jobrolearn
Type: string or Token
or None
-
readonlyRootFilesystem
¶ JobDefinitionResource.ContainerPropertiesProperty.ReadonlyRootFilesystem http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-readonlyrootfilesystem
Type: boolean or Token
or None
-
ulimits
¶ JobDefinitionResource.ContainerPropertiesProperty.Ulimits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ulimits
Type: Token
orToken
orUlimitProperty
or None
-
vcpus
¶ JobDefinitionResource.ContainerPropertiesProperty.Vcpus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-vcpus
Type: number or Token
-
image
¶ JobDefinitionResource.ContainerPropertiesProperty.Image http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-image
Type: string or Token
-
-
class
EnvironmentProperty
¶ -
value
¶ JobDefinitionResource.EnvironmentProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-value
Type: string or Token
or None
-
name
¶ JobDefinitionResource.EnvironmentProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-name
Type: string or Token
or None
-
-
class
MountPointsProperty
¶ -
readOnly
¶ JobDefinitionResource.MountPointsProperty.ReadOnly http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-readonly
Type: boolean or Token
or None
-
sourceVolume
¶ JobDefinitionResource.MountPointsProperty.SourceVolume http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-sourcevolume
Type: string or Token
or None
-
containerPath
¶ JobDefinitionResource.MountPointsProperty.ContainerPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-containerpath
Type: string or Token
or None
-
-
class
RetryStrategyProperty
¶ -
attempts
¶ JobDefinitionResource.RetryStrategyProperty.Attempts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-attempts
Type: number or Token
or None
-
-
class
TimeoutProperty
¶ -
attemptDurationSeconds
¶ JobDefinitionResource.TimeoutProperty.AttemptDurationSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html#cfn-batch-jobdefinition-timeout-attemptdurationseconds
Type: number or Token
or None
-
-
class
UlimitProperty
¶ -
softLimit
¶ JobDefinitionResource.UlimitProperty.SoftLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-softlimit
Type: number or Token
-
hardLimit
¶ JobDefinitionResource.UlimitProperty.HardLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-hardlimit
Type: number or Token
-
name
¶ JobDefinitionResource.UlimitProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-name
Type: string or Token
-
-
class
VolumesHostProperty
¶ -
sourcePath
¶ JobDefinitionResource.VolumesHostProperty.SourcePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html#cfn-batch-jobdefinition-volumeshost-sourcepath
Type: string or Token
or None
-
-
class
VolumesProperty
¶ -
host
¶ JobDefinitionResource.VolumesProperty.Host http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-host
Type: Token
orVolumesHostProperty
or None
-
name
¶ JobDefinitionResource.VolumesProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-name
Type: string or Token
or None
-
- parent (
JobDefinitionResourceProps (interface)¶
-
class
_aws-cdk_resources.batch.
JobDefinitionResourceProps
¶ -
type
¶ AWS::Batch::JobDefinition.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type
Type: string or Token
-
parameters
¶ AWS::Batch::JobDefinition.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters
Type: json or Token
or None
-
timeout
¶ AWS::Batch::JobDefinition.Timeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout
Type: Token
orTimeoutProperty
or None
-
containerProperties
¶ AWS::Batch::JobDefinition.ContainerProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties
Type: Token
orContainerPropertiesProperty
-
jobDefinitionName
¶ AWS::Batch::JobDefinition.JobDefinitionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname
Type: string or Token
or None
-
retryStrategy
¶ AWS::Batch::JobDefinition.RetryStrategy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy
Type: Token
orRetryStrategyProperty
or None
-
JobQueueResource¶
-
class
_aws-cdk_resources.batch.
JobQueueResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this JobQueueResource is a part of - name (string) –
- props (
JobQueueResourceProps
or None) – the properties of this JobQueueResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ComputeEnvironmentOrderProperty
¶ -
computeEnvironment
¶ JobQueueResource.ComputeEnvironmentOrderProperty.ComputeEnvironment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-computeenvironment
Type: string or Token
-
order
¶ JobQueueResource.ComputeEnvironmentOrderProperty.Order http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-order
Type: number or Token
-
- parent (
JobQueueResourceProps (interface)¶
-
class
_aws-cdk_resources.batch.
JobQueueResourceProps
¶ -
computeEnvironmentOrder
¶ AWS::Batch::JobQueue.ComputeEnvironmentOrder http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder
Type: Token
orToken
orComputeEnvironmentOrderProperty
-
priority
¶ AWS::Batch::JobQueue.Priority http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority
Type: number or Token
-
state
¶ AWS::Batch::JobQueue.State http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state
Type: string or Token
or None
-
jobQueueName
¶ AWS::Batch::JobQueue.JobQueueName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename
Type: string or Token
or None
-
budgets¶
BudgetResource¶
-
class
_aws-cdk_resources.budgets.
BudgetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this BudgetResource is a part of - name (string) –
- props (
BudgetResourceProps
or None) – the properties of this BudgetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
BudgetDataProperty
¶ -
budgetLimit
¶ BudgetResource.BudgetDataProperty.BudgetLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetlimit
Type: Token
orSpendProperty
or None
-
timePeriod
¶ BudgetResource.BudgetDataProperty.TimePeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeperiod
Type: Token
orTimePeriodProperty
or None
-
timeUnit
¶ BudgetResource.BudgetDataProperty.TimeUnit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-timeunit
Type: string or Token
-
costFilters
¶ BudgetResource.BudgetDataProperty.CostFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costfilters
Type: json or Token
or None
-
budgetName
¶ BudgetResource.BudgetDataProperty.BudgetName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgetname
Type: string or Token
or None
-
costTypes
¶ BudgetResource.BudgetDataProperty.CostTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-costtypes
Type: Token
orCostTypesProperty
or None
-
budgetType
¶ BudgetResource.BudgetDataProperty.BudgetType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html#cfn-budgets-budget-budgetdata-budgettype
Type: string or Token
-
-
class
CostTypesProperty
¶ -
includeSupport
¶ BudgetResource.CostTypesProperty.IncludeSupport http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesupport
Type: boolean or Token
or None
-
includeOtherSubscription
¶ BudgetResource.CostTypesProperty.IncludeOtherSubscription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeothersubscription
Type: boolean or Token
or None
-
includeTax
¶ BudgetResource.CostTypesProperty.IncludeTax http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includetax
Type: boolean or Token
or None
-
includeSubscription
¶ BudgetResource.CostTypesProperty.IncludeSubscription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includesubscription
Type: boolean or Token
or None
-
useBlended
¶ BudgetResource.CostTypesProperty.UseBlended http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useblended
Type: boolean or Token
or None
-
includeUpfront
¶ BudgetResource.CostTypesProperty.IncludeUpfront http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includeupfront
Type: boolean or Token
or None
-
includeDiscount
¶ BudgetResource.CostTypesProperty.IncludeDiscount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includediscount
Type: boolean or Token
or None
-
includeCredit
¶ BudgetResource.CostTypesProperty.IncludeCredit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includecredit
Type: boolean or Token
or None
-
includeRecurring
¶ BudgetResource.CostTypesProperty.IncludeRecurring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerecurring
Type: boolean or Token
or None
-
useAmortized
¶ BudgetResource.CostTypesProperty.UseAmortized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-useamortized
Type: boolean or Token
or None
-
includeRefund
¶ BudgetResource.CostTypesProperty.IncludeRefund http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html#cfn-budgets-budget-costtypes-includerefund
Type: boolean or Token
or None
-
-
class
NotificationProperty
¶ -
comparisonOperator
¶ BudgetResource.NotificationProperty.ComparisonOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-comparisonoperator
Type: string or Token
-
notificationType
¶ BudgetResource.NotificationProperty.NotificationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-notificationtype
Type: string or Token
-
threshold
¶ BudgetResource.NotificationProperty.Threshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-threshold
Type: number or Token
-
thresholdType
¶ BudgetResource.NotificationProperty.ThresholdType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notification.html#cfn-budgets-budget-notification-thresholdtype
Type: string or Token
or None
-
-
class
NotificationWithSubscribersProperty
¶ -
subscribers
¶ BudgetResource.NotificationWithSubscribersProperty.Subscribers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-subscribers
Type: Token
orToken
orSubscriberProperty
-
notification
¶ BudgetResource.NotificationWithSubscribersProperty.Notification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html#cfn-budgets-budget-notificationwithsubscribers-notification
Type: Token
orNotificationProperty
-
-
class
SpendProperty
¶ -
amount
¶ BudgetResource.SpendProperty.Amount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-amount
Type: number or Token
-
unit
¶ BudgetResource.SpendProperty.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html#cfn-budgets-budget-spend-unit
Type: string or Token
-
-
class
SubscriberProperty
¶ -
subscriptionType
¶ BudgetResource.SubscriberProperty.SubscriptionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-subscriptiontype
Type: string or Token
-
address
¶ BudgetResource.SubscriberProperty.Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-subscriber.html#cfn-budgets-budget-subscriber-address
Type: string or Token
-
-
class
TimePeriodProperty
¶ -
start
¶ BudgetResource.TimePeriodProperty.Start http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-start
Type: string or Token
or None
-
end
¶ BudgetResource.TimePeriodProperty.End http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html#cfn-budgets-budget-timeperiod-end
Type: string or Token
or None
-
- parent (
BudgetResourceProps (interface)¶
-
class
_aws-cdk_resources.budgets.
BudgetResourceProps
¶ -
notificationsWithSubscribers
¶ AWS::Budgets::Budget.NotificationsWithSubscribers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-notificationswithsubscribers
Type: Token
orToken
orNotificationWithSubscribersProperty
or None
-
budget
¶ AWS::Budgets::Budget.Budget http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-budgets-budget.html#cfn-budgets-budget-budget
Type: Token
orBudgetDataProperty
-
certificatemanager¶
CertificateResource¶
-
class
_aws-cdk_resources.certificatemanager.
CertificateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CertificateResource is a part of - name (string) –
- props (
CertificateResourceProps
or None) – the properties of this CertificateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
DomainValidationOptionProperty
¶ -
domainName
¶ CertificateResource.DomainValidationOptionProperty.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoptions-domainname
Type: string or Token
-
validationDomain
¶ CertificateResource.DomainValidationOptionProperty.ValidationDomain http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-validationdomain
Type: string or Token
-
- parent (
CertificateResourceProps (interface)¶
-
class
_aws-cdk_resources.certificatemanager.
CertificateResourceProps
¶ -
domainName
¶ AWS::CertificateManager::Certificate.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname
Type: string or Token
-
domainValidationOptions
¶ AWS::CertificateManager::Certificate.DomainValidationOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions
Type: Token
orToken
orDomainValidationOptionProperty
or None
-
subjectAlternativeNames
¶ AWS::CertificateManager::Certificate.SubjectAlternativeNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames
Type: Token
or string orToken
or None
AWS::CertificateManager::Certificate.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-tags
Type: Token
orToken
orTag
or None
-
validationMethod
¶ AWS::CertificateManager::Certificate.ValidationMethod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod
Type: string or Token
or None
-
cloud9¶
EnvironmentEC2Arn¶
EnvironmentEC2Name¶
EnvironmentEC2Resource¶
-
class
_aws-cdk_resources.cloud9.
EnvironmentEC2Resource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EnvironmentEC2Resource is a part of - name (string) –
- props (
EnvironmentEC2ResourceProps
or None) – the properties of this EnvironmentEC2Resource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
environmentEc2Arn
¶ Type: EnvironmentEC2Arn
(readonly)
-
environmentEc2Name
¶ Type: EnvironmentEC2Name
(readonly)
-
class
RepositoryProperty
¶ -
pathComponent
¶ EnvironmentEC2Resource.RepositoryProperty.PathComponent http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html#cfn-cloud9-environmentec2-repository-pathcomponent
Type: string or Token
-
repositoryUrl
¶ EnvironmentEC2Resource.RepositoryProperty.RepositoryUrl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloud9-environmentec2-repository.html#cfn-cloud9-environmentec2-repository-repositoryurl
Type: string or Token
-
- parent (
EnvironmentEC2ResourceProps (interface)¶
-
class
_aws-cdk_resources.cloud9.
EnvironmentEC2ResourceProps
¶ -
repositories
¶ AWS::Cloud9::EnvironmentEC2.Repositories http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-repositories
Type: Token
orToken
orRepositoryProperty
or None
-
ownerArn
¶ AWS::Cloud9::EnvironmentEC2.OwnerArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-ownerarn
Type: string or Token
or None
-
description
¶ AWS::Cloud9::EnvironmentEC2.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-description
Type: string or Token
or None
-
automaticStopTimeMinutes
¶ AWS::Cloud9::EnvironmentEC2.AutomaticStopTimeMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-automaticstoptimeminutes
Type: number or Token
or None
-
subnetId
¶ AWS::Cloud9::EnvironmentEC2.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-subnetid
Type: string or Token
or None
-
instanceType
¶ AWS::Cloud9::EnvironmentEC2.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-instancetype
Type: string or Token
-
environmentEc2Name
¶ AWS::Cloud9::EnvironmentEC2.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloud9-environmentec2.html#cfn-cloud9-environmentec2-name
Type: string or Token
or None
-
cloudformation¶
CustomResource¶
-
class
_aws-cdk_resources.cloudformation.
CustomResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CustomResource is a part of - name (string) –
- props (
CustomResourceProps
or None) – the properties of this CustomResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
CustomResourceProps (interface)¶
StackResource¶
-
class
_aws-cdk_resources.cloudformation.
StackResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StackResource is a part of - name (string) –
- props (
StackResourceProps
or None) – the properties of this StackResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
StackResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudformation.
StackResourceProps
¶ -
notificationArns
¶ AWS::CloudFormation::Stack.NotificationARNs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns
Type: Token
or string orToken
or None
-
parameters
¶ AWS::CloudFormation::Stack.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters
Type: Token
or string orToken
or None
AWS::CloudFormation::Stack.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags
Type: Token
orToken
orTag
or None
-
templateUrl
¶ AWS::CloudFormation::Stack.TemplateURL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl
Type: string or Token
-
timeoutInMinutes
¶ AWS::CloudFormation::Stack.TimeoutInMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes
Type: number or Token
or None
-
WaitConditionData¶
WaitConditionHandleResource¶
-
class
_aws-cdk_resources.cloudformation.
WaitConditionHandleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this WaitConditionHandleResource is a part of - name (string) –
- props (
WaitConditionHandleResourceProps
or None) – the properties of this WaitConditionHandleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
WaitConditionHandleResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudformation.
WaitConditionHandleResourceProps
¶
WaitConditionResource¶
-
class
_aws-cdk_resources.cloudformation.
WaitConditionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this WaitConditionResource is a part of - name (string) –
- props (
WaitConditionResourceProps
or None) – the properties of this WaitConditionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
waitConditionData
¶ Type: WaitConditionData
(readonly)
- parent (
WaitConditionResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudformation.
WaitConditionResourceProps
¶ -
count
¶ AWS::CloudFormation::WaitCondition.Count http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-count
Type: number or Token
or None
-
handle
¶ AWS::CloudFormation::WaitCondition.Handle http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-handle
Type: string or Token
-
timeout
¶ AWS::CloudFormation::WaitCondition.Timeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waitcondition.html#cfn-waitcondition-timeout
Type: string or Token
-
cloudfront¶
CloudFrontOriginAccessIdentityResource¶
-
class
_aws-cdk_resources.cloudfront.
CloudFrontOriginAccessIdentityResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CloudFrontOriginAccessIdentityResource is a part of - name (string) –
- props (
CloudFrontOriginAccessIdentityResourceProps
or None) – the properties of this CloudFrontOriginAccessIdentityResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
cloudFrontOriginAccessIdentityS3CanonicalUserId
¶ Type: CloudFrontOriginAccessIdentityS3CanonicalUserId
(readonly)
-
class
CloudFrontOriginAccessIdentityConfigProperty
¶ -
comment
¶ CloudFrontOriginAccessIdentityResource.CloudFrontOriginAccessIdentityConfigProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig-comment
Type: string or Token
-
- parent (
CloudFrontOriginAccessIdentityResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudfront.
CloudFrontOriginAccessIdentityResourceProps
¶ -
cloudFrontOriginAccessIdentityConfig
¶ AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig
Type: Token
orCloudFrontOriginAccessIdentityConfigProperty
-
CloudFrontOriginAccessIdentityS3CanonicalUserId¶
DistributionDomainName¶
DistributionResource¶
-
class
_aws-cdk_resources.cloudfront.
DistributionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DistributionResource is a part of - name (string) –
- props (
DistributionResourceProps
or None) – the properties of this DistributionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
distributionDomainName
¶ Type: DistributionDomainName
(readonly)
-
class
CacheBehaviorProperty
¶ -
compress
¶ DistributionResource.CacheBehaviorProperty.Compress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-compress
Type: boolean or Token
or None
-
lambdaFunctionAssociations
¶ DistributionResource.CacheBehaviorProperty.LambdaFunctionAssociations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-lambdafunctionassociations
Type: Token
orToken
orLambdaFunctionAssociationProperty
or None
-
targetOriginId
¶ DistributionResource.CacheBehaviorProperty.TargetOriginId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-targetoriginid
Type: string or Token
-
viewerProtocolPolicy
¶ DistributionResource.CacheBehaviorProperty.ViewerProtocolPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-viewerprotocolpolicy
Type: string or Token
-
trustedSigners
¶ DistributionResource.CacheBehaviorProperty.TrustedSigners http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-trustedsigners
Type: Token
or string orToken
or None
-
defaultTtl
¶ DistributionResource.CacheBehaviorProperty.DefaultTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-defaultttl
Type: number or Token
or None
-
allowedMethods
¶ DistributionResource.CacheBehaviorProperty.AllowedMethods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-allowedmethods
Type: Token
or string orToken
or None
-
pathPattern
¶ DistributionResource.CacheBehaviorProperty.PathPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-pathpattern
Type: string or Token
-
cachedMethods
¶ DistributionResource.CacheBehaviorProperty.CachedMethods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-cachedmethods
Type: Token
or string orToken
or None
-
smoothStreaming
¶ DistributionResource.CacheBehaviorProperty.SmoothStreaming http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-smoothstreaming
Type: boolean or Token
or None
-
forwardedValues
¶ DistributionResource.CacheBehaviorProperty.ForwardedValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-forwardedvalues
Type: Token
orForwardedValuesProperty
-
minTtl
¶ DistributionResource.CacheBehaviorProperty.MinTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-minttl
Type: number or Token
or None
-
maxTtl
¶ DistributionResource.CacheBehaviorProperty.MaxTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html#cfn-cloudfront-distribution-cachebehavior-maxttl
Type: number or Token
or None
-
-
class
CookiesProperty
¶ -
whitelistedNames
¶ DistributionResource.CookiesProperty.WhitelistedNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-whitelistednames
Type: Token
or string orToken
or None
-
forward
¶ DistributionResource.CookiesProperty.Forward http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html#cfn-cloudfront-distribution-cookies-forward
Type: string or Token
-
-
class
CustomErrorResponseProperty
¶ -
responseCode
¶ DistributionResource.CustomErrorResponseProperty.ResponseCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsecode
Type: number or Token
or None
-
errorCachingMinTtl
¶ DistributionResource.CustomErrorResponseProperty.ErrorCachingMinTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcachingminttl
Type: number or Token
or None
-
errorCode
¶ DistributionResource.CustomErrorResponseProperty.ErrorCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-errorcode
Type: number or Token
-
responsePagePath
¶ DistributionResource.CustomErrorResponseProperty.ResponsePagePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html#cfn-cloudfront-distribution-customerrorresponse-responsepagepath
Type: string or Token
or None
-
-
class
CustomOriginConfigProperty
¶ -
originReadTimeout
¶ DistributionResource.CustomOriginConfigProperty.OriginReadTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout
Type: number or Token
or None
-
httpsPort
¶ DistributionResource.CustomOriginConfigProperty.HTTPSPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpsport
Type: number or Token
or None
-
originKeepaliveTimeout
¶ DistributionResource.CustomOriginConfigProperty.OriginKeepaliveTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout
Type: number or Token
or None
-
originSslProtocols
¶ DistributionResource.CustomOriginConfigProperty.OriginSSLProtocols http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols
Type: Token
or string orToken
or None
-
httpPort
¶ DistributionResource.CustomOriginConfigProperty.HTTPPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpport
Type: number or Token
or None
-
originProtocolPolicy
¶ DistributionResource.CustomOriginConfigProperty.OriginProtocolPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy
Type: string or Token
-
-
class
DefaultCacheBehaviorProperty
¶ -
compress
¶ DistributionResource.DefaultCacheBehaviorProperty.Compress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-compress
Type: boolean or Token
or None
-
allowedMethods
¶ DistributionResource.DefaultCacheBehaviorProperty.AllowedMethods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-allowedmethods
Type: Token
or string orToken
or None
-
cachedMethods
¶ DistributionResource.DefaultCacheBehaviorProperty.CachedMethods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-cachedmethods
Type: Token
or string orToken
or None
-
lambdaFunctionAssociations
¶ DistributionResource.DefaultCacheBehaviorProperty.LambdaFunctionAssociations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-lambdafunctionassociations
Type: Token
orToken
orLambdaFunctionAssociationProperty
or None
-
smoothStreaming
¶ DistributionResource.DefaultCacheBehaviorProperty.SmoothStreaming http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-smoothstreaming
Type: boolean or Token
or None
-
targetOriginId
¶ DistributionResource.DefaultCacheBehaviorProperty.TargetOriginId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-targetoriginid
Type: string or Token
-
viewerProtocolPolicy
¶ DistributionResource.DefaultCacheBehaviorProperty.ViewerProtocolPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-viewerprotocolpolicy
Type: string or Token
-
forwardedValues
¶ DistributionResource.DefaultCacheBehaviorProperty.ForwardedValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-forwardedvalues
Type: Token
orForwardedValuesProperty
-
minTtl
¶ DistributionResource.DefaultCacheBehaviorProperty.MinTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-minttl
Type: number or Token
or None
-
maxTtl
¶ DistributionResource.DefaultCacheBehaviorProperty.MaxTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-maxttl
Type: number or Token
or None
-
trustedSigners
¶ DistributionResource.DefaultCacheBehaviorProperty.TrustedSigners http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-trustedsigners
Type: Token
or string orToken
or None
-
defaultTtl
¶ DistributionResource.DefaultCacheBehaviorProperty.DefaultTTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html#cfn-cloudfront-distribution-defaultcachebehavior-defaultttl
Type: number or Token
or None
-
-
class
DistributionConfigProperty
¶ -
logging
¶ DistributionResource.DistributionConfigProperty.Logging http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-logging
Type: Token
orLoggingProperty
or None
-
comment
¶ DistributionResource.DistributionConfigProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-comment
Type: string or Token
or None
-
defaultRootObject
¶ DistributionResource.DistributionConfigProperty.DefaultRootObject http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultrootobject
Type: string or Token
or None
-
origins
¶ DistributionResource.DistributionConfigProperty.Origins http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-origins
Type: Token
orToken
orOriginProperty
or None
-
viewerCertificate
¶ DistributionResource.DistributionConfigProperty.ViewerCertificate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-viewercertificate
Type: Token
orViewerCertificateProperty
or None
-
priceClass
¶ DistributionResource.DistributionConfigProperty.PriceClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-priceclass
Type: string or Token
or None
-
defaultCacheBehavior
¶ DistributionResource.DistributionConfigProperty.DefaultCacheBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-defaultcachebehavior
Type: Token
orDefaultCacheBehaviorProperty
or None
-
customErrorResponses
¶ DistributionResource.DistributionConfigProperty.CustomErrorResponses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-customerrorresponses
Type: Token
orToken
orCustomErrorResponseProperty
or None
-
enabled
¶ DistributionResource.DistributionConfigProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-enabled
Type: boolean or Token
-
aliases
¶ DistributionResource.DistributionConfigProperty.Aliases http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases
Type: Token
or string orToken
or None
-
ipv6Enabled
¶ DistributionResource.DistributionConfigProperty.IPV6Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-ipv6enabled
Type: boolean or Token
or None
-
webAclId
¶ DistributionResource.DistributionConfigProperty.WebACLId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-webaclid
Type: string or Token
or None
-
httpVersion
¶ DistributionResource.DistributionConfigProperty.HttpVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-httpversion
Type: string or Token
or None
-
restrictions
¶ DistributionResource.DistributionConfigProperty.Restrictions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions
Type: Token
orRestrictionsProperty
or None
-
cacheBehaviors
¶ DistributionResource.DistributionConfigProperty.CacheBehaviors http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-cachebehaviors
Type: Token
orToken
orCacheBehaviorProperty
or None
-
-
class
ForwardedValuesProperty
¶ DistributionResource.ForwardedValuesProperty.Cookies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-cookies
Type: Token
orCookiesProperty
or None
-
headers
¶ DistributionResource.ForwardedValuesProperty.Headers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-headers
Type: Token
or string orToken
or None
-
queryString
¶ DistributionResource.ForwardedValuesProperty.QueryString http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystring
Type: boolean or Token
-
queryStringCacheKeys
¶ DistributionResource.ForwardedValuesProperty.QueryStringCacheKeys http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-forwardedvalues.html#cfn-cloudfront-distribution-forwardedvalues-querystringcachekeys
Type: Token
or string orToken
or None
-
class
GeoRestrictionProperty
¶ -
locations
¶ DistributionResource.GeoRestrictionProperty.Locations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-locations
Type: Token
or string orToken
or None
-
restrictionType
¶ DistributionResource.GeoRestrictionProperty.RestrictionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html#cfn-cloudfront-distribution-georestriction-restrictiontype
Type: string or Token
-
-
class
LambdaFunctionAssociationProperty
¶ -
eventType
¶ DistributionResource.LambdaFunctionAssociationProperty.EventType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-eventtype
Type: string or Token
or None
-
lambdaFunctionArn
¶ DistributionResource.LambdaFunctionAssociationProperty.LambdaFunctionARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-lambdafunctionassociation.html#cfn-cloudfront-distribution-lambdafunctionassociation-lambdafunctionarn
Type: string or Token
or None
-
-
class
LoggingProperty
¶ -
includeCookies
¶ DistributionResource.LoggingProperty.IncludeCookies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-includecookies
Type: boolean or Token
or None
-
bucket
¶ DistributionResource.LoggingProperty.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-bucket
Type: string or Token
-
prefix
¶ DistributionResource.LoggingProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-prefix
Type: string or Token
or None
-
-
class
OriginCustomHeaderProperty
¶ -
headerValue
¶ DistributionResource.OriginCustomHeaderProperty.HeaderValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headervalue
Type: string or Token
-
headerName
¶ DistributionResource.OriginCustomHeaderProperty.HeaderName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html#cfn-cloudfront-distribution-origincustomheader-headername
Type: string or Token
-
-
class
OriginProperty
¶ -
originCustomHeaders
¶ DistributionResource.OriginProperty.OriginCustomHeaders http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-origincustomheaders
Type: Token
orToken
orOriginCustomHeaderProperty
or None
-
domainName
¶ DistributionResource.OriginProperty.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-domainname
Type: string or Token
-
s3OriginConfig
¶ DistributionResource.OriginProperty.S3OriginConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-s3originconfig
Type: Token
orS3OriginConfigProperty
or None
-
originPath
¶ DistributionResource.OriginProperty.OriginPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-originpath
Type: string or Token
or None
-
id
¶ DistributionResource.OriginProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-id
Type: string or Token
-
customOriginConfig
¶ DistributionResource.OriginProperty.CustomOriginConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html#cfn-cloudfront-distribution-origin-customoriginconfig
Type: Token
orCustomOriginConfigProperty
or None
-
-
class
RestrictionsProperty
¶ -
geoRestriction
¶ DistributionResource.RestrictionsProperty.GeoRestriction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html#cfn-cloudfront-distribution-restrictions-georestriction
Type: Token
orGeoRestrictionProperty
-
-
class
S3OriginConfigProperty
¶ -
originAccessIdentity
¶ DistributionResource.S3OriginConfigProperty.OriginAccessIdentity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-s3originconfig.html#cfn-cloudfront-distribution-s3originconfig-originaccessidentity
Type: string or Token
or None
-
-
class
ViewerCertificateProperty
¶ -
iamCertificateId
¶ DistributionResource.ViewerCertificateProperty.IamCertificateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-iamcertificateid
Type: string or Token
or None
-
sslSupportMethod
¶ DistributionResource.ViewerCertificateProperty.SslSupportMethod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-sslsupportmethod
Type: string or Token
or None
-
minimumProtocolVersion
¶ DistributionResource.ViewerCertificateProperty.MinimumProtocolVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-minimumprotocolversion
Type: string or Token
or None
-
cloudFrontDefaultCertificate
¶ DistributionResource.ViewerCertificateProperty.CloudFrontDefaultCertificate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-cloudfrontdefaultcertificate
Type: boolean or Token
or None
-
acmCertificateArn
¶ DistributionResource.ViewerCertificateProperty.AcmCertificateArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html#cfn-cloudfront-distribution-viewercertificate-acmcertificatearn
Type: string or Token
or None
-
- parent (
DistributionResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudfront.
DistributionResourceProps
¶ -
distributionConfig
¶ AWS::CloudFront::Distribution.DistributionConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-distributionconfig
Type: Token
orDistributionConfigProperty
AWS::CloudFront::Distribution.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-tags
Type: Token
orToken
orTag
or None
-
StreamingDistributionDomainName¶
StreamingDistributionResource¶
-
class
_aws-cdk_resources.cloudfront.
StreamingDistributionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StreamingDistributionResource is a part of - name (string) –
- props (
StreamingDistributionResourceProps
or None) – the properties of this StreamingDistributionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
streamingDistributionDomainName
¶ Type: StreamingDistributionDomainName
(readonly)
-
class
LoggingProperty
¶ -
bucket
¶ StreamingDistributionResource.LoggingProperty.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-bucket
Type: string or Token
-
enabled
¶ StreamingDistributionResource.LoggingProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-enabled
Type: boolean or Token
-
prefix
¶ StreamingDistributionResource.LoggingProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html#cfn-cloudfront-streamingdistribution-logging-prefix
Type: string or Token
-
-
class
S3OriginProperty
¶ -
domainName
¶ StreamingDistributionResource.S3OriginProperty.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-domainname
Type: string or Token
-
originAccessIdentity
¶ StreamingDistributionResource.S3OriginProperty.OriginAccessIdentity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html#cfn-cloudfront-streamingdistribution-s3origin-originaccessidentity
Type: string or Token
-
-
class
StreamingDistributionConfigProperty
¶ -
logging
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.Logging http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-logging
Type: Token
orLoggingProperty
or None
-
comment
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-comment
Type: string or Token
-
priceClass
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.PriceClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-priceclass
Type: string or Token
or None
-
s3Origin
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.S3Origin http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-s3origin
Type: Token
orS3OriginProperty
-
enabled
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-enabled
Type: boolean or Token
-
aliases
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.Aliases http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-aliases
Type: Token
or string orToken
or None
-
trustedSigners
¶ StreamingDistributionResource.StreamingDistributionConfigProperty.TrustedSigners http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-streamingdistributionconfig.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig-trustedsigners
Type: Token
orTrustedSignersProperty
-
-
class
TrustedSignersProperty
¶ -
enabled
¶ StreamingDistributionResource.TrustedSignersProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-enabled
Type: boolean or Token
-
awsAccountNumbers
¶ StreamingDistributionResource.TrustedSignersProperty.AwsAccountNumbers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html#cfn-cloudfront-streamingdistribution-trustedsigners-awsaccountnumbers
Type: Token
or string orToken
or None
-
- parent (
StreamingDistributionResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudfront.
StreamingDistributionResourceProps
¶ -
streamingDistributionConfig
¶ AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig
Type: Token
orStreamingDistributionConfigProperty
AWS::CloudFront::StreamingDistribution.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-tags
Type: Token
orToken
orTag
-
cloudtrail¶
TrailArn¶
TrailResource¶
-
class
_aws-cdk_resources.cloudtrail.
TrailResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TrailResource is a part of - name (string) –
- props (
TrailResourceProps
or None) – the properties of this TrailResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
trailArn
¶ Type: TrailArn
(readonly)
-
trailSnsTopicArn
¶ Type: TrailSnsTopicArn
(readonly)
-
class
DataResourceProperty
¶ -
type
¶ TrailResource.DataResourceProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-type
Type: string or Token
-
values
¶ TrailResource.DataResourceProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html#cfn-cloudtrail-trail-dataresource-values
Type: Token
or string orToken
or None
-
-
class
EventSelectorProperty
¶ -
dataResources
¶ TrailResource.EventSelectorProperty.DataResources http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-dataresources
Type: Token
orToken
orDataResourceProperty
or None
-
includeManagementEvents
¶ TrailResource.EventSelectorProperty.IncludeManagementEvents http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-includemanagementevents
Type: boolean or Token
or None
-
readWriteType
¶ TrailResource.EventSelectorProperty.ReadWriteType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html#cfn-cloudtrail-trail-eventselector-readwritetype
Type: string or Token
or None
-
- parent (
TrailResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudtrail.
TrailResourceProps
¶ -
cloudWatchLogsLogGroupArn
¶ AWS::CloudTrail::Trail.CloudWatchLogsLogGroupArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsloggrouparn
Type: string or Token
or None
-
cloudWatchLogsRoleArn
¶ AWS::CloudTrail::Trail.CloudWatchLogsRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsrolearn
Type: string or Token
or None
-
enableLogFileValidation
¶ AWS::CloudTrail::Trail.EnableLogFileValidation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-enablelogfilevalidation
Type: boolean or Token
or None
-
eventSelectors
¶ AWS::CloudTrail::Trail.EventSelectors http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-eventselectors
Type: Token
orToken
orEventSelectorProperty
or None
-
includeGlobalServiceEvents
¶ AWS::CloudTrail::Trail.IncludeGlobalServiceEvents http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-includeglobalserviceevents
Type: boolean or Token
or None
-
isLogging
¶ AWS::CloudTrail::Trail.IsLogging http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-islogging
Type: boolean or Token
-
isMultiRegionTrail
¶ AWS::CloudTrail::Trail.IsMultiRegionTrail http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-ismultiregiontrail
Type: boolean or Token
or None
-
kmsKeyId
¶ AWS::CloudTrail::Trail.KMSKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-kmskeyid
Type: string or Token
or None
-
s3BucketName
¶ AWS::CloudTrail::Trail.S3BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-s3bucketname
Type: string or Token
-
s3KeyPrefix
¶ AWS::CloudTrail::Trail.S3KeyPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-s3keyprefix
Type: string or Token
or None
-
snsTopicName
¶ AWS::CloudTrail::Trail.SnsTopicName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-snstopicname
Type: string or Token
or None
AWS::CloudTrail::Trail.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-tags
Type: Token
orToken
orTag
or None
-
trailName
¶ AWS::CloudTrail::Trail.TrailName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-trailname
Type: string or Token
or None
-
cloudwatch¶
AlarmArn¶
AlarmResource¶
-
class
_aws-cdk_resources.cloudwatch.
AlarmResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AlarmResource is a part of - name (string) –
- props (
AlarmResourceProps
or None) – the properties of this AlarmResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
alarmArn
¶ Type: AlarmArn
(readonly)
-
class
DimensionProperty
¶ -
name
¶ AlarmResource.DimensionProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-name
Type: string or Token
-
value
¶ AlarmResource.DimensionProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html#cfn-cloudwatch-alarm-dimension-value
Type: string or Token
-
- parent (
AlarmResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudwatch.
AlarmResourceProps
¶ -
actionsEnabled
¶ AWS::CloudWatch::Alarm.ActionsEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-actionsenabled
Type: boolean or Token
or None
-
alarmActions
¶ AWS::CloudWatch::Alarm.AlarmActions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmactions
Type: Token
or string orToken
or None
-
alarmDescription
¶ AWS::CloudWatch::Alarm.AlarmDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmdescription
Type: string or Token
or None
-
alarmName
¶ AWS::CloudWatch::Alarm.AlarmName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-alarmname
Type: string or Token
or None
-
comparisonOperator
¶ AWS::CloudWatch::Alarm.ComparisonOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-comparisonoperator
Type: string or Token
-
dimensions
¶ AWS::CloudWatch::Alarm.Dimensions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-dimension
Type: Token
orToken
orDimensionProperty
or None
-
evaluateLowSampleCountPercentile
¶ AWS::CloudWatch::Alarm.EvaluateLowSampleCountPercentile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluatelowsamplecountpercentile
Type: string or Token
or None
-
evaluationPeriods
¶ AWS::CloudWatch::Alarm.EvaluationPeriods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-evaluationperiods
Type: number or Token
-
extendedStatistic
¶ AWS::CloudWatch::Alarm.ExtendedStatistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-extendedstatistic
Type: string or Token
or None
-
insufficientDataActions
¶ AWS::CloudWatch::Alarm.InsufficientDataActions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-insufficientdataactions
Type: Token
or string orToken
or None
-
metricName
¶ AWS::CloudWatch::Alarm.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-metricname
Type: string or Token
-
namespace
¶ AWS::CloudWatch::Alarm.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-namespace
Type: string or Token
-
okActions
¶ AWS::CloudWatch::Alarm.OKActions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-okactions
Type: Token
or string orToken
or None
-
period
¶ AWS::CloudWatch::Alarm.Period http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-period
Type: number or Token
-
statistic
¶ AWS::CloudWatch::Alarm.Statistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-statistic
Type: string or Token
or None
-
threshold
¶ AWS::CloudWatch::Alarm.Threshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-threshold
Type: number or Token
-
treatMissingData
¶ AWS::CloudWatch::Alarm.TreatMissingData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-treatmissingdata
Type: string or Token
or None
-
unit
¶ AWS::CloudWatch::Alarm.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html#cfn-cloudwatch-alarms-unit
Type: string or Token
or None
-
DashboardResource¶
-
class
_aws-cdk_resources.cloudwatch.
DashboardResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DashboardResource is a part of - name (string) –
- props (
DashboardResourceProps
or None) – the properties of this DashboardResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DashboardResourceProps (interface)¶
-
class
_aws-cdk_resources.cloudwatch.
DashboardResourceProps
¶ -
dashboardName
¶ AWS::CloudWatch::Dashboard.DashboardName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardname
Type: string or Token
or None
-
dashboardBody
¶ AWS::CloudWatch::Dashboard.DashboardBody http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html#cfn-cloudwatch-dashboard-dashboardbody
Type: string or Token
-
codebuild¶
ProjectArn¶
ProjectResource¶
-
class
_aws-cdk_resources.codebuild.
ProjectResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ProjectResource is a part of - name (string) –
- props (
ProjectResourceProps
or None) – the properties of this ProjectResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
projectArn
¶ Type: ProjectArn
(readonly)
-
class
ArtifactsProperty
¶ -
path
¶ ProjectResource.ArtifactsProperty.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-path
Type: string or Token
or None
-
type
¶ ProjectResource.ArtifactsProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-type
Type: string or Token
-
packaging
¶ ProjectResource.ArtifactsProperty.Packaging http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-packaging
Type: string or Token
or None
-
location
¶ ProjectResource.ArtifactsProperty.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-location
Type: string or Token
or None
-
name
¶ ProjectResource.ArtifactsProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-name
Type: string or Token
or None
-
namespaceType
¶ ProjectResource.ArtifactsProperty.NamespaceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-namespacetype
Type: string or Token
or None
-
-
class
EnvironmentProperty
¶ -
type
¶ ProjectResource.EnvironmentProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type
Type: string or Token
-
environmentVariables
¶ ProjectResource.EnvironmentProperty.EnvironmentVariables http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-environmentvariables
Type: Token
orToken
orEnvironmentVariableProperty
or None
-
privilegedMode
¶ ProjectResource.EnvironmentProperty.PrivilegedMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-privilegedmode
Type: boolean or Token
or None
-
image
¶ ProjectResource.EnvironmentProperty.Image http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-image
Type: string or Token
-
computeType
¶ ProjectResource.EnvironmentProperty.ComputeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype
Type: string or Token
-
-
class
EnvironmentVariableProperty
¶ -
type
¶ ProjectResource.EnvironmentVariableProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type
Type: string or Token
or None
-
value
¶ ProjectResource.EnvironmentVariableProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value
Type: string or Token
-
name
¶ ProjectResource.EnvironmentVariableProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-name
Type: string or Token
-
-
class
ProjectCacheProperty
¶ -
type
¶ ProjectResource.ProjectCacheProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-type
Type: string or Token
-
location
¶ ProjectResource.ProjectCacheProperty.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html#cfn-codebuild-project-projectcache-location
Type: string or Token
or None
-
-
class
ProjectTriggersProperty
¶ -
webhook
¶ ProjectResource.ProjectTriggersProperty.Webhook http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html#cfn-codebuild-project-projecttriggers-webhook
Type: boolean or Token
or None
-
-
class
SourceAuthProperty
¶ -
type
¶ ProjectResource.SourceAuthProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-type
Type: string or Token
-
resource
¶ ProjectResource.SourceAuthProperty.Resource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-sourceauth.html#cfn-codebuild-project-sourceauth-resource
Type: string or Token
or None
-
-
class
SourceProperty
¶ -
type
¶ ProjectResource.SourceProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-type
Type: string or Token
-
auth
¶ ProjectResource.SourceProperty.Auth http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-auth
Type: Token
orSourceAuthProperty
or None
-
buildSpec
¶ ProjectResource.SourceProperty.BuildSpec http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildspec
Type: string or Token
or None
-
gitCloneDepth
¶ ProjectResource.SourceProperty.GitCloneDepth http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitclonedepth
Type: number or Token
or None
-
insecureSsl
¶ ProjectResource.SourceProperty.InsecureSsl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-insecuressl
Type: boolean or Token
or None
-
location
¶ ProjectResource.SourceProperty.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-location
Type: string or Token
or None
-
-
class
VpcConfigProperty
¶ -
subnets
¶ ProjectResource.VpcConfigProperty.Subnets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-subnets
Type: Token
or string orToken
-
vpcId
¶ ProjectResource.VpcConfigProperty.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-vpcid
Type: string or Token
-
securityGroupIds
¶ ProjectResource.VpcConfigProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-vpcconfig.html#cfn-codebuild-project-vpcconfig-securitygroupids
Type: Token
or string orToken
-
- parent (
ProjectResourceProps (interface)¶
-
class
_aws-cdk_resources.codebuild.
ProjectResourceProps
¶ -
description
¶ AWS::CodeBuild::Project.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-description
Type: string or Token
or None
-
vpcConfig
¶ AWS::CodeBuild::Project.VpcConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-vpcconfig
Type: Token
orVpcConfigProperty
or None
-
encryptionKey
¶ AWS::CodeBuild::Project.EncryptionKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-encryptionkey
Type: string or Token
or None
-
triggers
¶ AWS::CodeBuild::Project.Triggers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-triggers
Type: Token
orProjectTriggersProperty
or None
-
source
¶ AWS::CodeBuild::Project.Source http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-source
Type: Token
orSourceProperty
-
projectName
¶ AWS::CodeBuild::Project.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-name
Type: string or Token
or None
-
artifacts
¶ AWS::CodeBuild::Project.Artifacts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-artifacts
Type: Token
orArtifactsProperty
-
badgeEnabled
¶ AWS::CodeBuild::Project.BadgeEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled
Type: boolean or Token
or None
-
serviceRole
¶ AWS::CodeBuild::Project.ServiceRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-servicerole
Type: string or Token
-
environment
¶ AWS::CodeBuild::Project.Environment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment
Type: Token
orEnvironmentProperty
AWS::CodeBuild::Project.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-tags
Type: Token
orToken
orTag
or None
-
timeoutInMinutes
¶ AWS::CodeBuild::Project.TimeoutInMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-timeoutinminutes
Type: number or Token
or None
-
cache
¶ AWS::CodeBuild::Project.Cache http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-cache
Type: Token
orProjectCacheProperty
or None
-
codecommit¶
RepositoryArn¶
RepositoryCloneUrlHttp¶
RepositoryCloneUrlSsh¶
RepositoryName¶
RepositoryResource¶
-
class
_aws-cdk_resources.codecommit.
RepositoryResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RepositoryResource is a part of - name (string) –
- props (
RepositoryResourceProps
or None) – the properties of this RepositoryResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
repositoryCloneUrlHttp
¶ Type: RepositoryCloneUrlHttp
(readonly)
-
repositoryCloneUrlSsh
¶ Type: RepositoryCloneUrlSsh
(readonly)
-
repositoryArn
¶ Type: RepositoryArn
(readonly)
-
repositoryName
¶ Type: RepositoryName
(readonly)
-
class
RepositoryTriggerProperty
¶ -
events
¶ RepositoryResource.RepositoryTriggerProperty.Events http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-events
Type: Token
or string orToken
or None
-
branches
¶ RepositoryResource.RepositoryTriggerProperty.Branches http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-branches
Type: Token
or string orToken
or None
-
customData
¶ RepositoryResource.RepositoryTriggerProperty.CustomData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-customdata
Type: string or Token
or None
-
destinationArn
¶ RepositoryResource.RepositoryTriggerProperty.DestinationArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-destinationarn
Type: string or Token
or None
-
name
¶ RepositoryResource.RepositoryTriggerProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codecommit-repository-repositorytrigger.html#cfn-codecommit-repository-repositorytrigger-name
Type: string or Token
or None
-
- parent (
RepositoryResourceProps (interface)¶
-
class
_aws-cdk_resources.codecommit.
RepositoryResourceProps
¶ -
repositoryName
¶ AWS::CodeCommit::Repository.RepositoryName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositoryname
Type: string or Token
-
triggers
¶ AWS::CodeCommit::Repository.Triggers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-triggers
Type: Token
orToken
orRepositoryTriggerProperty
or None
-
repositoryDescription
¶ AWS::CodeCommit::Repository.RepositoryDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codecommit-repository.html#cfn-codecommit-repository-repositorydescription
Type: string or Token
or None
-
codedeploy¶
ApplicationResource¶
-
class
_aws-cdk_resources.codedeploy.
ApplicationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApplicationResource is a part of - name (string) –
- props (
ApplicationResourceProps
or None) – the properties of this ApplicationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ApplicationResourceProps (interface)¶
-
class
_aws-cdk_resources.codedeploy.
ApplicationResourceProps
¶ -
applicationName
¶ AWS::CodeDeploy::Application.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-applicationname
Type: string or Token
or None
-
computePlatform
¶ AWS::CodeDeploy::Application.ComputePlatform http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html#cfn-codedeploy-application-computeplatform
Type: string or Token
or None
-
DeploymentConfigResource¶
-
class
_aws-cdk_resources.codedeploy.
DeploymentConfigResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DeploymentConfigResource is a part of - name (string) –
- props (
DeploymentConfigResourceProps
or None) – the properties of this DeploymentConfigResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
MinimumHealthyHostsProperty
¶ -
type
¶ DeploymentConfigResource.MinimumHealthyHostsProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-type
Type: string or Token
-
value
¶ DeploymentConfigResource.MinimumHealthyHostsProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-value
Type: number or Token
-
- parent (
DeploymentConfigResourceProps (interface)¶
-
class
_aws-cdk_resources.codedeploy.
DeploymentConfigResourceProps
¶ -
deploymentConfigName
¶ AWS::CodeDeploy::DeploymentConfig.DeploymentConfigName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-deploymentconfigname
Type: string or Token
or None
-
minimumHealthyHosts
¶ AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts
Type: Token
orMinimumHealthyHostsProperty
or None
-
DeploymentGroupResource¶
-
class
_aws-cdk_resources.codedeploy.
DeploymentGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DeploymentGroupResource is a part of - name (string) –
- props (
DeploymentGroupResourceProps
or None) – the properties of this DeploymentGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AlarmConfigurationProperty
¶ -
alarms
¶ DeploymentGroupResource.AlarmConfigurationProperty.Alarms http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-alarms
Type: Token
orToken
orAlarmProperty
or None
-
enabled
¶ DeploymentGroupResource.AlarmConfigurationProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-enabled
Type: boolean or Token
or None
-
ignorePollAlarmFailure
¶ DeploymentGroupResource.AlarmConfigurationProperty.IgnorePollAlarmFailure http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html#cfn-codedeploy-deploymentgroup-alarmconfiguration-ignorepollalarmfailure
Type: boolean or Token
or None
-
-
class
AlarmProperty
¶ -
name
¶ DeploymentGroupResource.AlarmProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html#cfn-codedeploy-deploymentgroup-alarm-name
Type: string or Token
or None
-
-
class
AutoRollbackConfigurationProperty
¶ -
enabled
¶ DeploymentGroupResource.AutoRollbackConfigurationProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-enabled
Type: boolean or Token
or None
-
events
¶ DeploymentGroupResource.AutoRollbackConfigurationProperty.Events http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-autorollbackconfiguration.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration-events
Type: Token
or string orToken
or None
-
-
class
DeploymentProperty
¶ -
description
¶ DeploymentGroupResource.DeploymentProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-description
Type: string or Token
or None
-
ignoreApplicationStopFailures
¶ DeploymentGroupResource.DeploymentProperty.IgnoreApplicationStopFailures http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-ignoreapplicationstopfailures
Type: boolean or Token
or None
-
revision
¶ DeploymentGroupResource.DeploymentProperty.Revision http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision
Type: Token
orRevisionLocationProperty
-
-
class
DeploymentStyleProperty
¶ -
deploymentOption
¶ DeploymentGroupResource.DeploymentStyleProperty.DeploymentOption http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymentoption
Type: string or Token
or None
-
deploymentType
¶ DeploymentGroupResource.DeploymentStyleProperty.DeploymentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deploymentstyle.html#cfn-codedeploy-deploymentgroup-deploymentstyle-deploymenttype
Type: string or Token
or None
-
-
class
EC2TagFilterProperty
¶ -
key
¶ DeploymentGroupResource.EC2TagFilterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilters.html#cfn-properties-codedeploy-deploymentgroup-ec2tagfilters-key
Type: string or Token
or None
-
type
¶ DeploymentGroupResource.EC2TagFilterProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilters.html#cfn-properties-codedeploy-deploymentgroup-ec2tagfilters-type
Type: string or Token
or None
-
value
¶ DeploymentGroupResource.EC2TagFilterProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-ec2tagfilters.html#cfn-properties-codedeploy-deploymentgroup-ec2tagfilters-value
Type: string or Token
or None
-
-
class
ELBInfoProperty
¶ -
name
¶ DeploymentGroupResource.ELBInfoProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html#cfn-codedeploy-deploymentgroup-elbinfo-name
Type: string or Token
or None
-
-
class
GitHubLocationProperty
¶ -
commitId
¶ DeploymentGroupResource.GitHubLocationProperty.CommitId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-commitid
Type: string or Token
-
repository
¶ DeploymentGroupResource.GitHubLocationProperty.Repository http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-githublocation.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation-repository
Type: string or Token
-
-
class
LoadBalancerInfoProperty
¶ -
elbInfoList
¶ DeploymentGroupResource.LoadBalancerInfoProperty.ElbInfoList http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-elbinfolist
Type: Token
orToken
orELBInfoProperty
or None
-
targetGroupInfoList
¶ DeploymentGroupResource.LoadBalancerInfoProperty.TargetGroupInfoList http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgroupinfolist
Type: Token
orToken
orTargetGroupInfoProperty
or None
-
-
class
RevisionLocationProperty
¶ -
gitHubLocation
¶ DeploymentGroupResource.RevisionLocationProperty.GitHubLocation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-githublocation
Type: Token
orGitHubLocationProperty
or None
-
revisionType
¶ DeploymentGroupResource.RevisionLocationProperty.RevisionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-revisiontype
Type: string or Token
or None
-
s3Location
¶ DeploymentGroupResource.RevisionLocationProperty.S3Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location
Type: Token
orS3LocationProperty
or None
-
-
class
S3LocationProperty
¶ -
bucket
¶ DeploymentGroupResource.S3LocationProperty.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bucket
Type: string or Token
-
bundleType
¶ DeploymentGroupResource.S3LocationProperty.BundleType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-bundletype
Type: string or Token
or None
-
eTag
¶ DeploymentGroupResource.S3LocationProperty.ETag http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-etag
Type: string or Token
or None
-
key
¶ DeploymentGroupResource.S3LocationProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-key
Type: string or Token
-
version
¶ DeploymentGroupResource.S3LocationProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision-s3location.html#cfn-properties-codedeploy-deploymentgroup-deployment-revision-s3location-value
Type: string or Token
or None
-
-
class
TagFilterProperty
¶ -
key
¶ DeploymentGroupResource.TagFilterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters.html#cfn-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters-key
Type: string or Token
or None
-
type
¶ DeploymentGroupResource.TagFilterProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters.html#cfn-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters-type
Type: string or Token
or None
-
value
¶ DeploymentGroupResource.TagFilterProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters.html#cfn-properties-codedeploy-deploymentgroup-onpremisesinstancetagfilters-value
Type: string or Token
or None
-
-
class
TargetGroupInfoProperty
¶ -
name
¶ DeploymentGroupResource.TargetGroupInfoProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html#cfn-codedeploy-deploymentgroup-targetgroupinfo-name
Type: string or Token
or None
-
-
class
TriggerConfigProperty
¶ -
triggerEvents
¶ DeploymentGroupResource.TriggerConfigProperty.TriggerEvents http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggerevents
Type: Token
or string orToken
or None
-
triggerName
¶ DeploymentGroupResource.TriggerConfigProperty.TriggerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggername
Type: string or Token
or None
-
triggerTargetArn
¶ DeploymentGroupResource.TriggerConfigProperty.TriggerTargetArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html#cfn-codedeploy-deploymentgroup-triggerconfig-triggertargetarn
Type: string or Token
or None
-
- parent (
DeploymentGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.codedeploy.
DeploymentGroupResourceProps
¶ -
alarmConfiguration
¶ AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-alarmconfiguration
Type: Token
orAlarmConfigurationProperty
or None
-
applicationName
¶ AWS::CodeDeploy::DeploymentGroup.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-applicationname
Type: string or Token
-
autoRollbackConfiguration
¶ AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autorollbackconfiguration
Type: Token
orAutoRollbackConfigurationProperty
or None
-
autoScalingGroups
¶ AWS::CodeDeploy::DeploymentGroup.AutoScalingGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-autoscalinggroups
Type: Token
or string orToken
or None
-
deployment
¶ AWS::CodeDeploy::DeploymentGroup.Deployment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deployment
Type: Token
orDeploymentProperty
or None
-
deploymentConfigName
¶ AWS::CodeDeploy::DeploymentGroup.DeploymentConfigName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentconfigname
Type: string or Token
or None
-
deploymentGroupName
¶ AWS::CodeDeploy::DeploymentGroup.DeploymentGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentgroupname
Type: string or Token
or None
-
deploymentStyle
¶ AWS::CodeDeploy::DeploymentGroup.DeploymentStyle http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-deploymentstyle
Type: Token
orDeploymentStyleProperty
or None
-
ec2TagFilters
¶ AWS::CodeDeploy::DeploymentGroup.Ec2TagFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-ec2tagfilters
Type: Token
orToken
orEC2TagFilterProperty
or None
-
loadBalancerInfo
¶ AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo
Type: Token
orLoadBalancerInfoProperty
or None
-
onPremisesInstanceTagFilters
¶ AWS::CodeDeploy::DeploymentGroup.OnPremisesInstanceTagFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-onpremisesinstancetagfilters
Type: Token
orToken
orTagFilterProperty
or None
-
serviceRoleArn
¶ AWS::CodeDeploy::DeploymentGroup.ServiceRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-servicerolearn
Type: string or Token
-
triggerConfigurations
¶ AWS::CodeDeploy::DeploymentGroup.TriggerConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations
Type: Token
orToken
orTriggerConfigProperty
or None
-
codepipeline¶
CustomActionTypeResource¶
-
class
_aws-cdk_resources.codepipeline.
CustomActionTypeResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CustomActionTypeResource is a part of - name (string) –
- props (
CustomActionTypeResourceProps
or None) – the properties of this CustomActionTypeResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ArtifactDetailsProperty
¶ -
maximumCount
¶ CustomActionTypeResource.ArtifactDetailsProperty.MaximumCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount
Type: number or Token
-
minimumCount
¶ CustomActionTypeResource.ArtifactDetailsProperty.MinimumCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount
Type: number or Token
-
-
class
ConfigurationPropertiesProperty
¶ -
description
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description
Type: string or Token
or None
-
key
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key
Type: boolean or Token
-
name
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name
Type: string or Token
-
queryable
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Queryable http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable
Type: boolean or Token
or None
-
required
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Required http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required
Type: boolean or Token
-
secret
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Secret http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret
Type: boolean or Token
-
type
¶ CustomActionTypeResource.ConfigurationPropertiesProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type
Type: string or Token
or None
-
-
class
SettingsProperty
¶ -
entityUrlTemplate
¶ CustomActionTypeResource.SettingsProperty.EntityUrlTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate
Type: string or Token
or None
-
executionUrlTemplate
¶ CustomActionTypeResource.SettingsProperty.ExecutionUrlTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate
Type: string or Token
or None
-
revisionUrlTemplate
¶ CustomActionTypeResource.SettingsProperty.RevisionUrlTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate
Type: string or Token
or None
-
thirdPartyConfigurationUrl
¶ CustomActionTypeResource.SettingsProperty.ThirdPartyConfigurationUrl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl
Type: string or Token
or None
-
- parent (
CustomActionTypeResourceProps (interface)¶
-
class
_aws-cdk_resources.codepipeline.
CustomActionTypeResourceProps
¶ -
category
¶ AWS::CodePipeline::CustomActionType.Category http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category
Type: string or Token
-
configurationProperties
¶ AWS::CodePipeline::CustomActionType.ConfigurationProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties
Type: Token
orToken
orConfigurationPropertiesProperty
or None
-
inputArtifactDetails
¶ AWS::CodePipeline::CustomActionType.InputArtifactDetails http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails
Type: Token
orArtifactDetailsProperty
-
outputArtifactDetails
¶ AWS::CodePipeline::CustomActionType.OutputArtifactDetails http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails
Type: Token
orArtifactDetailsProperty
-
provider
¶ AWS::CodePipeline::CustomActionType.Provider http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider
Type: string or Token
-
settings
¶ AWS::CodePipeline::CustomActionType.Settings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings
Type: Token
orSettingsProperty
or None
-
version
¶ AWS::CodePipeline::CustomActionType.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version
Type: string or Token
or None
-
PipelineResource¶
-
class
_aws-cdk_resources.codepipeline.
PipelineResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PipelineResource is a part of - name (string) –
- props (
PipelineResourceProps
or None) – the properties of this PipelineResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActionDeclarationProperty
¶ -
actionTypeId
¶ PipelineResource.ActionDeclarationProperty.ActionTypeId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid
Type: Token
orActionTypeIdProperty
-
configuration
¶ PipelineResource.ActionDeclarationProperty.Configuration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration
Type: json or Token
or None
-
inputArtifacts
¶ PipelineResource.ActionDeclarationProperty.InputArtifacts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts
Type: Token
orToken
orInputArtifactProperty
or None
-
name
¶ PipelineResource.ActionDeclarationProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name
Type: string or Token
-
outputArtifacts
¶ PipelineResource.ActionDeclarationProperty.OutputArtifacts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts
Type: Token
orToken
orOutputArtifactProperty
or None
-
roleArn
¶ PipelineResource.ActionDeclarationProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn
Type: string or Token
or None
-
runOrder
¶ PipelineResource.ActionDeclarationProperty.RunOrder http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder
Type: number or Token
or None
-
-
class
ActionTypeIdProperty
¶ -
category
¶ PipelineResource.ActionTypeIdProperty.Category http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category
Type: string or Token
-
owner
¶ PipelineResource.ActionTypeIdProperty.Owner http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner
Type: string or Token
-
provider
¶ PipelineResource.ActionTypeIdProperty.Provider http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider
Type: string or Token
-
version
¶ PipelineResource.ActionTypeIdProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-version
Type: string or Token
-
-
class
ArtifactStoreProperty
¶ -
encryptionKey
¶ PipelineResource.ArtifactStoreProperty.EncryptionKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey
Type: Token
orEncryptionKeyProperty
or None
-
location
¶ PipelineResource.ArtifactStoreProperty.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location
Type: string or Token
-
type
¶ PipelineResource.ArtifactStoreProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type
Type: string or Token
-
-
class
BlockerDeclarationProperty
¶ -
name
¶ PipelineResource.BlockerDeclarationProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-name
Type: string or Token
-
type
¶ PipelineResource.BlockerDeclarationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-type
Type: string or Token
-
-
class
EncryptionKeyProperty
¶ -
id
¶ PipelineResource.EncryptionKeyProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id
Type: string or Token
-
type
¶ PipelineResource.EncryptionKeyProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type
Type: string or Token
-
-
class
InputArtifactProperty
¶ -
name
¶ PipelineResource.InputArtifactProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name
Type: string or Token
-
-
class
OutputArtifactProperty
¶ -
name
¶ PipelineResource.OutputArtifactProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts-name
Type: string or Token
-
-
class
StageDeclarationProperty
¶ -
actions
¶ PipelineResource.StageDeclarationProperty.Actions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-actions
Type: Token
orToken
orActionDeclarationProperty
-
blockers
¶ PipelineResource.StageDeclarationProperty.Blockers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-blockers
Type: Token
orToken
orBlockerDeclarationProperty
or None
-
name
¶ PipelineResource.StageDeclarationProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-name
Type: string or Token
-
-
class
StageTransitionProperty
¶ -
reason
¶ PipelineResource.StageTransitionProperty.Reason http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason
Type: string or Token
-
stageName
¶ PipelineResource.StageTransitionProperty.StageName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-stagename
Type: string or Token
-
- parent (
PipelineResourceProps (interface)¶
-
class
_aws-cdk_resources.codepipeline.
PipelineResourceProps
¶ -
artifactStore
¶ AWS::CodePipeline::Pipeline.ArtifactStore http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore
Type: Token
orArtifactStoreProperty
-
disableInboundStageTransitions
¶ AWS::CodePipeline::Pipeline.DisableInboundStageTransitions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions
Type: Token
orToken
orStageTransitionProperty
or None
-
pipelineName
¶ AWS::CodePipeline::Pipeline.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name
Type: string or Token
or None
-
restartExecutionOnUpdate
¶ AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate
Type: boolean or Token
or None
-
roleArn
¶ AWS::CodePipeline::Pipeline.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn
Type: string or Token
-
stages
¶ AWS::CodePipeline::Pipeline.Stages http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages
Type: Token
orToken
orStageDeclarationProperty
-
cognito¶
IdentityPoolName¶
IdentityPoolResource¶
-
class
_aws-cdk_resources.cognito.
IdentityPoolResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this IdentityPoolResource is a part of - name (string) –
- props (
IdentityPoolResourceProps
or None) – the properties of this IdentityPoolResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
identityPoolName
¶ Type: IdentityPoolName
(readonly)
-
class
CognitoIdentityProviderProperty
¶ -
serverSideTokenCheck
¶ IdentityPoolResource.CognitoIdentityProviderProperty.ServerSideTokenCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-serversidetokencheck
Type: boolean or Token
or None
-
providerName
¶ IdentityPoolResource.CognitoIdentityProviderProperty.ProviderName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-providername
Type: string or Token
or None
-
clientId
¶ IdentityPoolResource.CognitoIdentityProviderProperty.ClientId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-clientid
Type: string or Token
or None
-
-
class
CognitoStreamsProperty
¶ -
streamingStatus
¶ IdentityPoolResource.CognitoStreamsProperty.StreamingStatus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamingstatus
Type: string or Token
or None
-
streamName
¶ IdentityPoolResource.CognitoStreamsProperty.StreamName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname
Type: string or Token
or None
-
roleArn
¶ IdentityPoolResource.CognitoStreamsProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-rolearn
Type: string or Token
or None
-
-
class
PushSyncProperty
¶ -
applicationArns
¶ IdentityPoolResource.PushSyncProperty.ApplicationArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-applicationarns
Type: Token
or string orToken
or None
-
roleArn
¶ IdentityPoolResource.PushSyncProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-rolearn
Type: string or Token
or None
-
- parent (
IdentityPoolResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
IdentityPoolResourceProps
¶ -
pushSync
¶ AWS::Cognito::IdentityPool.PushSync http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-pushsync
Type: Token
orPushSyncProperty
or None
-
cognitoIdentityProviders
¶ AWS::Cognito::IdentityPool.CognitoIdentityProviders http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoidentityproviders
Type: Token
orToken
orCognitoIdentityProviderProperty
or None
-
cognitoEvents
¶ AWS::Cognito::IdentityPool.CognitoEvents http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoevents
Type: json or Token
or None
-
developerProviderName
¶ AWS::Cognito::IdentityPool.DeveloperProviderName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-developerprovidername
Type: string or Token
or None
-
cognitoStreams
¶ AWS::Cognito::IdentityPool.CognitoStreams http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitostreams
Type: Token
orCognitoStreamsProperty
or None
-
identityPoolName
¶ AWS::Cognito::IdentityPool.IdentityPoolName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypoolname
Type: string or Token
or None
-
allowUnauthenticatedIdentities
¶ AWS::Cognito::IdentityPool.AllowUnauthenticatedIdentities http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowunauthenticatedidentities
Type: boolean or Token
-
supportedLoginProviders
¶ AWS::Cognito::IdentityPool.SupportedLoginProviders http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-supportedloginproviders
Type: json or Token
or None
-
samlProviderArns
¶ AWS::Cognito::IdentityPool.SamlProviderARNs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-samlproviderarns
Type: Token
or string orToken
or None
-
openIdConnectProviderArns
¶ AWS::Cognito::IdentityPool.OpenIdConnectProviderARNs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-openidconnectproviderarns
Type: Token
or string orToken
or None
-
IdentityPoolRoleAttachmentResource¶
-
class
_aws-cdk_resources.cognito.
IdentityPoolRoleAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this IdentityPoolRoleAttachmentResource is a part of - name (string) –
- props (
IdentityPoolRoleAttachmentResourceProps
or None) – the properties of this IdentityPoolRoleAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
MappingRuleProperty
¶ -
matchType
¶ IdentityPoolRoleAttachmentResource.MappingRuleProperty.MatchType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype
Type: string or Token
-
value
¶ IdentityPoolRoleAttachmentResource.MappingRuleProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value
Type: string or Token
-
claim
¶ IdentityPoolRoleAttachmentResource.MappingRuleProperty.Claim http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim
Type: string or Token
-
roleArn
¶ IdentityPoolRoleAttachmentResource.MappingRuleProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn
Type: string or Token
-
-
class
RoleMappingProperty
¶ -
type
¶ IdentityPoolRoleAttachmentResource.RoleMappingProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-type
Type: string or Token
-
ambiguousRoleResolution
¶ IdentityPoolRoleAttachmentResource.RoleMappingProperty.AmbiguousRoleResolution http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-ambiguousroleresolution
Type: string or Token
or None
-
rulesConfiguration
¶ IdentityPoolRoleAttachmentResource.RoleMappingProperty.RulesConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-rulesconfiguration
Type: Token
orRulesConfigurationTypeProperty
or None
-
-
class
RulesConfigurationTypeProperty
¶ -
rules
¶ IdentityPoolRoleAttachmentResource.RulesConfigurationTypeProperty.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html#cfn-cognito-identitypoolroleattachment-rulesconfigurationtype-rules
Type: Token
orToken
orMappingRuleProperty
-
- parent (
IdentityPoolRoleAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
IdentityPoolRoleAttachmentResourceProps
¶ -
roleMappings
¶ AWS::Cognito::IdentityPoolRoleAttachment.RoleMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-rolemappings
Type: Token
orToken
orRoleMappingProperty
or None
-
identityPoolId
¶ AWS::Cognito::IdentityPoolRoleAttachment.IdentityPoolId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-identitypoolid
Type: string or Token
-
roles
¶ AWS::Cognito::IdentityPoolRoleAttachment.Roles http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-roles
Type: json or Token
or None
-
UserPoolArn¶
UserPoolClientClientSecret¶
UserPoolClientName¶
UserPoolClientResource¶
-
class
_aws-cdk_resources.cognito.
UserPoolClientResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserPoolClientResource is a part of - name (string) –
- props (
UserPoolClientResourceProps
or None) – the properties of this UserPoolClientResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
userPoolClientClientSecret
¶ Type: UserPoolClientClientSecret
(readonly)
-
userPoolClientName
¶ Type: UserPoolClientName
(readonly)
- parent (
UserPoolClientResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
UserPoolClientResourceProps
¶ -
generateSecret
¶ AWS::Cognito::UserPoolClient.GenerateSecret http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret
Type: boolean or Token
or None
-
clientName
¶ AWS::Cognito::UserPoolClient.ClientName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-clientname
Type: string or Token
or None
-
userPoolId
¶ AWS::Cognito::UserPoolClient.UserPoolId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-userpoolid
Type: string or Token
-
explicitAuthFlows
¶ AWS::Cognito::UserPoolClient.ExplicitAuthFlows http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-explicitauthflows
Type: Token
or string orToken
or None
-
refreshTokenValidity
¶ AWS::Cognito::UserPoolClient.RefreshTokenValidity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenvalidity
Type: number or Token
or None
-
readAttributes
¶ AWS::Cognito::UserPoolClient.ReadAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes
Type: Token
or string orToken
or None
-
writeAttributes
¶ AWS::Cognito::UserPoolClient.WriteAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes
Type: Token
or string orToken
or None
-
UserPoolGroupResource¶
-
class
_aws-cdk_resources.cognito.
UserPoolGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserPoolGroupResource is a part of - name (string) –
- props (
UserPoolGroupResourceProps
or None) – the properties of this UserPoolGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
UserPoolGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
UserPoolGroupResourceProps
¶ -
groupName
¶ AWS::Cognito::UserPoolGroup.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname
Type: string or Token
or None
-
description
¶ AWS::Cognito::UserPoolGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description
Type: string or Token
or None
-
userPoolId
¶ AWS::Cognito::UserPoolGroup.UserPoolId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-userpoolid
Type: string or Token
-
precedence
¶ AWS::Cognito::UserPoolGroup.Precedence http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence
Type: number or Token
or None
-
roleArn
¶ AWS::Cognito::UserPoolGroup.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn
Type: string or Token
or None
-
UserPoolProviderName¶
UserPoolProviderUrl¶
UserPoolResource¶
-
class
_aws-cdk_resources.cognito.
UserPoolResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserPoolResource is a part of - name (string) –
- props (
UserPoolResourceProps
or None) – the properties of this UserPoolResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
userPoolProviderName
¶ Type: UserPoolProviderName
(readonly)
-
userPoolProviderUrl
¶ Type: UserPoolProviderUrl
(readonly)
-
userPoolArn
¶ Type: UserPoolArn
(readonly)
-
class
AdminCreateUserConfigProperty
¶ -
inviteMessageTemplate
¶ UserPoolResource.AdminCreateUserConfigProperty.InviteMessageTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-invitemessagetemplate
Type: Token
orInviteMessageTemplateProperty
or None
-
unusedAccountValidityDays
¶ UserPoolResource.AdminCreateUserConfigProperty.UnusedAccountValidityDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays
Type: number or Token
or None
-
allowAdminCreateUserOnly
¶ UserPoolResource.AdminCreateUserConfigProperty.AllowAdminCreateUserOnly http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly
Type: boolean or Token
or None
-
-
class
DeviceConfigurationProperty
¶ -
deviceOnlyRememberedOnUserPrompt
¶ UserPoolResource.DeviceConfigurationProperty.DeviceOnlyRememberedOnUserPrompt http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-deviceonlyrememberedonuserprompt
Type: boolean or Token
or None
-
challengeRequiredOnNewDevice
¶ UserPoolResource.DeviceConfigurationProperty.ChallengeRequiredOnNewDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-challengerequiredonnewdevice
Type: boolean or Token
or None
-
-
class
EmailConfigurationProperty
¶ -
replyToEmailAddress
¶ UserPoolResource.EmailConfigurationProperty.ReplyToEmailAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-replytoemailaddress
Type: string or Token
or None
-
sourceArn
¶ UserPoolResource.EmailConfigurationProperty.SourceArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-sourcearn
Type: string or Token
or None
-
-
class
InviteMessageTemplateProperty
¶ -
emailMessage
¶ UserPoolResource.InviteMessageTemplateProperty.EmailMessage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailmessage
Type: string or Token
or None
-
smsMessage
¶ UserPoolResource.InviteMessageTemplateProperty.SMSMessage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-smsmessage
Type: string or Token
or None
-
emailSubject
¶ UserPoolResource.InviteMessageTemplateProperty.EmailSubject http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailsubject
Type: string or Token
or None
-
-
class
LambdaConfigProperty
¶ -
createAuthChallenge
¶ UserPoolResource.LambdaConfigProperty.CreateAuthChallenge http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge
Type: string or Token
or None
-
preAuthentication
¶ UserPoolResource.LambdaConfigProperty.PreAuthentication http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication
Type: string or Token
or None
-
defineAuthChallenge
¶ UserPoolResource.LambdaConfigProperty.DefineAuthChallenge http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge
Type: string or Token
or None
-
preSignUp
¶ UserPoolResource.LambdaConfigProperty.PreSignUp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup
Type: string or Token
or None
-
postAuthentication
¶ UserPoolResource.LambdaConfigProperty.PostAuthentication http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication
Type: string or Token
or None
-
postConfirmation
¶ UserPoolResource.LambdaConfigProperty.PostConfirmation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation
Type: string or Token
or None
-
customMessage
¶ UserPoolResource.LambdaConfigProperty.CustomMessage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage
Type: string or Token
or None
-
verifyAuthChallengeResponse
¶ UserPoolResource.LambdaConfigProperty.VerifyAuthChallengeResponse http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse
Type: string or Token
or None
-
-
class
NumberAttributeConstraintsProperty
¶ -
minValue
¶ UserPoolResource.NumberAttributeConstraintsProperty.MinValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-minvalue
Type: string or Token
or None
-
maxValue
¶ UserPoolResource.NumberAttributeConstraintsProperty.MaxValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-maxvalue
Type: string or Token
or None
-
-
class
PasswordPolicyProperty
¶ -
requireNumbers
¶ UserPoolResource.PasswordPolicyProperty.RequireNumbers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers
Type: boolean or Token
or None
-
minimumLength
¶ UserPoolResource.PasswordPolicyProperty.MinimumLength http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-minimumlength
Type: number or Token
or None
-
requireUppercase
¶ UserPoolResource.PasswordPolicyProperty.RequireUppercase http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase
Type: boolean or Token
or None
-
requireLowercase
¶ UserPoolResource.PasswordPolicyProperty.RequireLowercase http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase
Type: boolean or Token
or None
-
requireSymbols
¶ UserPoolResource.PasswordPolicyProperty.RequireSymbols http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols
Type: boolean or Token
or None
-
-
class
PoliciesProperty
¶ -
passwordPolicy
¶ UserPoolResource.PoliciesProperty.PasswordPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html#cfn-cognito-userpool-policies-passwordpolicy
Type: Token
orPasswordPolicyProperty
or None
-
-
class
SchemaAttributeProperty
¶ -
developerOnlyAttribute
¶ UserPoolResource.SchemaAttributeProperty.DeveloperOnlyAttribute http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute
Type: boolean or Token
or None
-
mutable
¶ UserPoolResource.SchemaAttributeProperty.Mutable http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable
Type: boolean or Token
or None
-
attributeDataType
¶ UserPoolResource.SchemaAttributeProperty.AttributeDataType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype
Type: string or Token
or None
-
stringAttributeConstraints
¶ UserPoolResource.SchemaAttributeProperty.StringAttributeConstraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints
Type: Token
orStringAttributeConstraintsProperty
or None
-
required
¶ UserPoolResource.SchemaAttributeProperty.Required http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required
Type: boolean or Token
or None
-
numberAttributeConstraints
¶ UserPoolResource.SchemaAttributeProperty.NumberAttributeConstraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints
Type: Token
orNumberAttributeConstraintsProperty
or None
-
name
¶ UserPoolResource.SchemaAttributeProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name
Type: string or Token
or None
-
-
class
SmsConfigurationProperty
¶ -
externalId
¶ UserPoolResource.SmsConfigurationProperty.ExternalId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-externalid
Type: string or Token
or None
-
snsCallerArn
¶ UserPoolResource.SmsConfigurationProperty.SnsCallerArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snscallerarn
Type: string or Token
or None
-
-
class
StringAttributeConstraintsProperty
¶ -
minLength
¶ UserPoolResource.StringAttributeConstraintsProperty.MinLength http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength
Type: string or Token
or None
-
maxLength
¶ UserPoolResource.StringAttributeConstraintsProperty.MaxLength http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-maxlength
Type: string or Token
or None
-
- parent (
UserPoolResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
UserPoolResourceProps
¶ -
userPoolTags
¶ AWS::Cognito::UserPool.UserPoolTags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags
Type: json or Token
or None
-
policies
¶ AWS::Cognito::UserPool.Policies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies
Type: Token
orPoliciesProperty
or None
-
mfaConfiguration
¶ AWS::Cognito::UserPool.MfaConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration
Type: string or Token
or None
-
schema
¶ AWS::Cognito::UserPool.Schema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema
Type: Token
orToken
orSchemaAttributeProperty
or None
-
adminCreateUserConfig
¶ AWS::Cognito::UserPool.AdminCreateUserConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig
Type: Token
orAdminCreateUserConfigProperty
or None
-
smsAuthenticationMessage
¶ AWS::Cognito::UserPool.SmsAuthenticationMessage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage
Type: string or Token
or None
-
userPoolName
¶ AWS::Cognito::UserPool.UserPoolName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname
Type: string or Token
or None
-
smsVerificationMessage
¶ AWS::Cognito::UserPool.SmsVerificationMessage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage
Type: string or Token
or None
-
emailConfiguration
¶ AWS::Cognito::UserPool.EmailConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration
Type: Token
orEmailConfigurationProperty
or None
-
smsConfiguration
¶ AWS::Cognito::UserPool.SmsConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration
Type: Token
orSmsConfigurationProperty
or None
-
aliasAttributes
¶ AWS::Cognito::UserPool.AliasAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes
Type: Token
or string orToken
or None
-
emailVerificationSubject
¶ AWS::Cognito::UserPool.EmailVerificationSubject http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject
Type: string or Token
or None
-
lambdaConfig
¶ AWS::Cognito::UserPool.LambdaConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig
Type: Token
orLambdaConfigProperty
or None
-
usernameAttributes
¶ AWS::Cognito::UserPool.UsernameAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes
Type: Token
or string orToken
or None
-
autoVerifiedAttributes
¶ AWS::Cognito::UserPool.AutoVerifiedAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes
Type: Token
or string orToken
or None
-
deviceConfiguration
¶ AWS::Cognito::UserPool.DeviceConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration
Type: Token
orDeviceConfigurationProperty
or None
-
emailVerificationMessage
¶ AWS::Cognito::UserPool.EmailVerificationMessage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage
Type: string or Token
or None
-
UserPoolUserResource¶
-
class
_aws-cdk_resources.cognito.
UserPoolUserResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserPoolUserResource is a part of - name (string) –
- props (
UserPoolUserResourceProps
or None) – the properties of this UserPoolUserResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AttributeTypeProperty
¶ -
value
¶ UserPoolUserResource.AttributeTypeProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-value
Type: string or Token
or None
-
name
¶ UserPoolUserResource.AttributeTypeProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooluser-attributetype.html#cfn-cognito-userpooluser-attributetype-name
Type: string or Token
or None
-
- parent (
UserPoolUserResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
UserPoolUserResourceProps
¶ -
validationData
¶ AWS::Cognito::UserPoolUser.ValidationData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata
Type: Token
orToken
orAttributeTypeProperty
or None
-
userPoolId
¶ AWS::Cognito::UserPoolUser.UserPoolId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid
Type: string or Token
-
username
¶ AWS::Cognito::UserPoolUser.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username
Type: string or Token
or None
-
messageAction
¶ AWS::Cognito::UserPoolUser.MessageAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction
Type: string or Token
or None
-
desiredDeliveryMediums
¶ AWS::Cognito::UserPoolUser.DesiredDeliveryMediums http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums
Type: Token
or string orToken
or None
-
forceAliasCreation
¶ AWS::Cognito::UserPoolUser.ForceAliasCreation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation
Type: boolean or Token
or None
-
userAttributes
¶ AWS::Cognito::UserPoolUser.UserAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes
Type: Token
orToken
orAttributeTypeProperty
or None
-
UserPoolUserToGroupAttachmentResource¶
-
class
_aws-cdk_resources.cognito.
UserPoolUserToGroupAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserPoolUserToGroupAttachmentResource is a part of - name (string) –
- props (
UserPoolUserToGroupAttachmentResourceProps
or None) – the properties of this UserPoolUserToGroupAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
UserPoolUserToGroupAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.cognito.
UserPoolUserToGroupAttachmentResourceProps
¶ -
groupName
¶ AWS::Cognito::UserPoolUserToGroupAttachment.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-groupname
Type: string or Token
-
userPoolId
¶ AWS::Cognito::UserPoolUserToGroupAttachment.UserPoolId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-userpoolid
Type: string or Token
-
username
¶ AWS::Cognito::UserPoolUserToGroupAttachment.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html#cfn-cognito-userpoolusertogroupattachment-username
Type: string or Token
-
config¶
ConfigRuleArn¶
ConfigRuleComplianceType¶
ConfigRuleId¶
ConfigRuleResource¶
-
class
_aws-cdk_resources.config.
ConfigRuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ConfigRuleResource is a part of - name (string) –
- props (
ConfigRuleResourceProps
or None) – the properties of this ConfigRuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
configRuleArn
¶ Type: ConfigRuleArn
(readonly)
-
configRuleComplianceType
¶ Type: ConfigRuleComplianceType
(readonly)
-
configRuleId
¶ Type: ConfigRuleId
(readonly)
-
class
ScopeProperty
¶ -
complianceResourceId
¶ ConfigRuleResource.ScopeProperty.ComplianceResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourceid
Type: string or Token
or None
-
complianceResourceTypes
¶ ConfigRuleResource.ScopeProperty.ComplianceResourceTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourcetypes
Type: Token
or string orToken
or None
-
tagKey
¶ ConfigRuleResource.ScopeProperty.TagKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagkey
Type: string or Token
or None
-
tagValue
¶ ConfigRuleResource.ScopeProperty.TagValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagvalue
Type: string or Token
or None
-
-
class
SourceDetailProperty
¶ -
eventSource
¶ ConfigRuleResource.SourceDetailProperty.EventSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html#cfn-config-configrule-source-sourcedetail-eventsource
Type: string or Token
-
maximumExecutionFrequency
¶ ConfigRuleResource.SourceDetailProperty.MaximumExecutionFrequency http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html#cfn-config-configrule-sourcedetail-maximumexecutionfrequency
Type: string or Token
or None
-
messageType
¶ ConfigRuleResource.SourceDetailProperty.MessageType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html#cfn-config-configrule-source-sourcedetail-messagetype
Type: string or Token
-
-
class
SourceProperty
¶ -
owner
¶ ConfigRuleResource.SourceProperty.Owner http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-owner
Type: string or Token
-
sourceDetails
¶ ConfigRuleResource.SourceProperty.SourceDetails http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-sourcedetails
Type: Token
orToken
orSourceDetailProperty
or None
-
sourceIdentifier
¶ ConfigRuleResource.SourceProperty.SourceIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-sourceidentifier
Type: string or Token
-
- parent (
ConfigRuleResourceProps (interface)¶
-
class
_aws-cdk_resources.config.
ConfigRuleResourceProps
¶ -
configRuleName
¶ AWS::Config::ConfigRule.ConfigRuleName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-configrulename
Type: string or Token
or None
-
description
¶ AWS::Config::ConfigRule.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-description
Type: string or Token
or None
-
inputParameters
¶ AWS::Config::ConfigRule.InputParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-inputparameters
Type: json or Token
or None
-
maximumExecutionFrequency
¶ AWS::Config::ConfigRule.MaximumExecutionFrequency http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-maximumexecutionfrequency
Type: string or Token
or None
-
scope
¶ AWS::Config::ConfigRule.Scope http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-scope
Type: Token
orScopeProperty
or None
-
source
¶ AWS::Config::ConfigRule.Source http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configrule.html#cfn-config-configrule-source
Type: Token
orSourceProperty
-
ConfigurationRecorderResource¶
-
class
_aws-cdk_resources.config.
ConfigurationRecorderResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ConfigurationRecorderResource is a part of - name (string) –
- props (
ConfigurationRecorderResourceProps
or None) – the properties of this ConfigurationRecorderResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
RecordingGroupProperty
¶ -
allSupported
¶ ConfigurationRecorderResource.RecordingGroupProperty.AllSupported http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-allsupported
Type: boolean or Token
or None
-
includeGlobalResourceTypes
¶ ConfigurationRecorderResource.RecordingGroupProperty.IncludeGlobalResourceTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-includeglobalresourcetypes
Type: boolean or Token
or None
-
resourceTypes
¶ ConfigurationRecorderResource.RecordingGroupProperty.ResourceTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-resourcetypes
Type: Token
or string orToken
or None
-
- parent (
ConfigurationRecorderResourceProps (interface)¶
-
class
_aws-cdk_resources.config.
ConfigurationRecorderResourceProps
¶ -
configurationRecorderName
¶ AWS::Config::ConfigurationRecorder.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-name
Type: string or Token
or None
-
recordingGroup
¶ AWS::Config::ConfigurationRecorder.RecordingGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-recordinggroup
Type: Token
orRecordingGroupProperty
or None
-
roleArn
¶ AWS::Config::ConfigurationRecorder.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html#cfn-config-configurationrecorder-rolearn
Type: string or Token
-
DeliveryChannelResource¶
-
class
_aws-cdk_resources.config.
DeliveryChannelResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DeliveryChannelResource is a part of - name (string) –
- props (
DeliveryChannelResourceProps
or None) – the properties of this DeliveryChannelResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ConfigSnapshotDeliveryPropertiesProperty
¶ -
deliveryFrequency
¶ DeliveryChannelResource.ConfigSnapshotDeliveryPropertiesProperty.DeliveryFrequency http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties-deliveryfrequency
Type: string or Token
or None
-
- parent (
DeliveryChannelResourceProps (interface)¶
-
class
_aws-cdk_resources.config.
DeliveryChannelResourceProps
¶ -
configSnapshotDeliveryProperties
¶ AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties
Type: Token
orConfigSnapshotDeliveryPropertiesProperty
or None
-
deliveryChannelName
¶ AWS::Config::DeliveryChannel.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-name
Type: string or Token
or None
-
s3BucketName
¶ AWS::Config::DeliveryChannel.S3BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3bucketname
Type: string or Token
-
s3KeyPrefix
¶ AWS::Config::DeliveryChannel.S3KeyPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3keyprefix
Type: string or Token
or None
-
snsTopicArn
¶ AWS::Config::DeliveryChannel.SnsTopicARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-snstopicarn
Type: string or Token
or None
-
datapipeline¶
PipelineResource¶
-
class
_aws-cdk_resources.datapipeline.
PipelineResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PipelineResource is a part of - name (string) –
- props (
PipelineResourceProps
or None) – the properties of this PipelineResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldProperty
¶ -
key
¶ PipelineResource.FieldProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-key
Type: string or Token
-
refValue
¶ PipelineResource.FieldProperty.RefValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-refvalue
Type: string or Token
or None
-
stringValue
¶ PipelineResource.FieldProperty.StringValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html#cfn-datapipeline-pipeline-pipelineobjects-fields-stringvalue
Type: string or Token
or None
-
-
class
ParameterAttributeProperty
¶ -
key
¶ PipelineResource.ParameterAttributeProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html#cfn-datapipeline-pipeline-parameterobjects-attribtues-key
Type: string or Token
-
stringValue
¶ PipelineResource.ParameterAttributeProperty.StringValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html#cfn-datapipeline-pipeline-parameterobjects-attribtues-stringvalue
Type: string or Token
-
-
class
ParameterObjectProperty
¶ -
attributes
¶ PipelineResource.ParameterObjectProperty.Attributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html#cfn-datapipeline-pipeline-parameterobjects-attributes
Type: Token
orToken
orParameterAttributeProperty
-
id
¶ PipelineResource.ParameterObjectProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html#cfn-datapipeline-pipeline-parameterobjects-id
Type: string or Token
-
-
class
ParameterValueProperty
¶ -
id
¶ PipelineResource.ParameterValueProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html#cfn-datapipeline-pipeline-parametervalues-id
Type: string or Token
-
stringValue
¶ PipelineResource.ParameterValueProperty.StringValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html#cfn-datapipeline-pipeline-parametervalues-stringvalue
Type: string or Token
-
-
class
PipelineObjectProperty
¶ -
fields
¶ PipelineResource.PipelineObjectProperty.Fields http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-fields
Type: Token
orToken
orFieldProperty
-
id
¶ PipelineResource.PipelineObjectProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-id
Type: string or Token
-
name
¶ PipelineResource.PipelineObjectProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html#cfn-datapipeline-pipeline-pipelineobjects-name
Type: string or Token
-
-
class
PipelineTagProperty
¶ -
key
¶ PipelineResource.PipelineTagProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html#cfn-datapipeline-pipeline-pipelinetags-key
Type: string or Token
-
value
¶ PipelineResource.PipelineTagProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html#cfn-datapipeline-pipeline-pipelinetags-value
Type: string or Token
-
- parent (
PipelineResourceProps (interface)¶
-
class
_aws-cdk_resources.datapipeline.
PipelineResourceProps
¶ -
activate
¶ AWS::DataPipeline::Pipeline.Activate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-activate
Type: boolean or Token
or None
-
description
¶ AWS::DataPipeline::Pipeline.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-description
Type: string or Token
or None
-
pipelineName
¶ AWS::DataPipeline::Pipeline.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-name
Type: string or Token
-
parameterObjects
¶ AWS::DataPipeline::Pipeline.ParameterObjects http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parameterobjects
Type: Token
orToken
orParameterObjectProperty
-
parameterValues
¶ AWS::DataPipeline::Pipeline.ParameterValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parametervalues
Type: Token
orToken
orParameterValueProperty
or None
-
pipelineObjects
¶ AWS::DataPipeline::Pipeline.PipelineObjects http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelineobjects
Type: Token
orToken
orPipelineObjectProperty
or None
-
pipelineTags
¶ AWS::DataPipeline::Pipeline.PipelineTags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelinetags
Type: Token
orToken
orPipelineTagProperty
or None
-
dax¶
ClusterArn¶
ClusterDiscoveryEndpoint¶
ClusterResource¶
-
class
_aws-cdk_resources.dax.
ClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterResource is a part of - name (string) –
- props (
ClusterResourceProps
or None) – the properties of this ClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
clusterDiscoveryEndpoint
¶ Type: ClusterDiscoveryEndpoint
(readonly)
-
clusterArn
¶ Type: ClusterArn
(readonly)
- parent (
ClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.dax.
ClusterResourceProps
¶ -
description
¶ AWS::DAX::Cluster.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-description
Type: string or Token
or None
-
replicationFactor
¶ AWS::DAX::Cluster.ReplicationFactor http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-replicationfactor
Type: number or Token
-
parameterGroupName
¶ AWS::DAX::Cluster.ParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-parametergroupname
Type: string or Token
or None
-
availabilityZones
¶ AWS::DAX::Cluster.AvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-availabilityzones
Type: Token
or string orToken
or None
-
nodeType
¶ AWS::DAX::Cluster.NodeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-nodetype
Type: string or Token
-
iamRoleArn
¶ AWS::DAX::Cluster.IAMRoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-iamrolearn
Type: string or Token
-
subnetGroupName
¶ AWS::DAX::Cluster.SubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-subnetgroupname
Type: string or Token
or None
-
clusterName
¶ AWS::DAX::Cluster.ClusterName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clustername
Type: string or Token
or None
-
preferredMaintenanceWindow
¶ AWS::DAX::Cluster.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-preferredmaintenancewindow
Type: string or Token
or None
-
notificationTopicArn
¶ AWS::DAX::Cluster.NotificationTopicARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-notificationtopicarn
Type: string or Token
or None
-
securityGroupIds
¶ AWS::DAX::Cluster.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-securitygroupids
Type: Token
or string orToken
or None
AWS::DAX::Cluster.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-tags
Type: json or Token
or None
-
ParameterGroupResource¶
-
class
_aws-cdk_resources.dax.
ParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ParameterGroupResource is a part of - name (string) –
- props (
ParameterGroupResourceProps
or None) – the properties of this ParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.dax.
ParameterGroupResourceProps
¶ -
parameterNameValues
¶ AWS::DAX::ParameterGroup.ParameterNameValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-parameternamevalues
Type: json or Token
or None
-
description
¶ AWS::DAX::ParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-description
Type: string or Token
or None
-
parameterGroupName
¶ AWS::DAX::ParameterGroup.ParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html#cfn-dax-parametergroup-parametergroupname
Type: string or Token
or None
-
SubnetGroupResource¶
-
class
_aws-cdk_resources.dax.
SubnetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubnetGroupResource is a part of - name (string) –
- props (
SubnetGroupResourceProps
or None) – the properties of this SubnetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SubnetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.dax.
SubnetGroupResourceProps
¶ -
description
¶ AWS::DAX::SubnetGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-description
Type: string or Token
or None
-
subnetGroupName
¶ AWS::DAX::SubnetGroup.SubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-subnetgroupname
Type: string or Token
or None
-
subnetIds
¶ AWS::DAX::SubnetGroup.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-subnetgroup.html#cfn-dax-subnetgroup-subnetids
Type: Token
or string orToken
-
directoryservice¶
MicrosoftADAlias¶
MicrosoftADDnsIpAddresses¶
MicrosoftADResource¶
-
class
_aws-cdk_resources.directoryservice.
MicrosoftADResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MicrosoftADResource is a part of - name (string) –
- props (
MicrosoftADResourceProps
or None) – the properties of this MicrosoftADResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
microsoftAdAlias
¶ Type: MicrosoftADAlias
(readonly)
-
microsoftAdDnsIpAddresses
¶ Type: MicrosoftADDnsIpAddresses
(readonly)
-
class
VpcSettingsProperty
¶ -
subnetIds
¶ MicrosoftADResource.VpcSettingsProperty.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-subnetids
Type: Token
or string orToken
-
vpcId
¶ MicrosoftADResource.VpcSettingsProperty.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-vpcid
Type: string or Token
-
- parent (
MicrosoftADResourceProps (interface)¶
-
class
_aws-cdk_resources.directoryservice.
MicrosoftADResourceProps
¶ -
createAlias
¶ AWS::DirectoryService::MicrosoftAD.CreateAlias http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-createalias
Type: boolean or Token
or None
-
edition
¶ AWS::DirectoryService::MicrosoftAD.Edition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition
Type: string or Token
or None
-
enableSso
¶ AWS::DirectoryService::MicrosoftAD.EnableSso http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-enablesso
Type: boolean or Token
or None
-
microsoftAdName
¶ AWS::DirectoryService::MicrosoftAD.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name
Type: string or Token
-
password
¶ AWS::DirectoryService::MicrosoftAD.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password
Type: string or Token
-
shortName
¶ AWS::DirectoryService::MicrosoftAD.ShortName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname
Type: string or Token
or None
-
vpcSettings
¶ AWS::DirectoryService::MicrosoftAD.VpcSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-vpcsettings
Type: Token
orVpcSettingsProperty
-
SimpleADAlias¶
SimpleADDnsIpAddresses¶
SimpleADResource¶
-
class
_aws-cdk_resources.directoryservice.
SimpleADResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SimpleADResource is a part of - name (string) –
- props (
SimpleADResourceProps
or None) – the properties of this SimpleADResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
simpleAdAlias
¶ Type: SimpleADAlias
(readonly)
-
simpleAdDnsIpAddresses
¶ Type: SimpleADDnsIpAddresses
(readonly)
-
class
VpcSettingsProperty
¶ -
subnetIds
¶ SimpleADResource.VpcSettingsProperty.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-subnetids
Type: Token
or string orToken
-
vpcId
¶ SimpleADResource.VpcSettingsProperty.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-vpcid
Type: string or Token
-
- parent (
SimpleADResourceProps (interface)¶
-
class
_aws-cdk_resources.directoryservice.
SimpleADResourceProps
¶ -
createAlias
¶ AWS::DirectoryService::SimpleAD.CreateAlias http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias
Type: boolean or Token
or None
-
description
¶ AWS::DirectoryService::SimpleAD.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description
Type: string or Token
or None
-
enableSso
¶ AWS::DirectoryService::SimpleAD.EnableSso http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso
Type: boolean or Token
or None
-
simpleAdName
¶ AWS::DirectoryService::SimpleAD.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name
Type: string or Token
-
password
¶ AWS::DirectoryService::SimpleAD.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password
Type: string or Token
-
shortName
¶ AWS::DirectoryService::SimpleAD.ShortName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname
Type: string or Token
or None
-
size
¶ AWS::DirectoryService::SimpleAD.Size http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size
Type: string or Token
-
vpcSettings
¶ AWS::DirectoryService::SimpleAD.VpcSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings
Type: Token
orVpcSettingsProperty
-
dms¶
CertificateResource¶
-
class
_aws-cdk_resources.dms.
CertificateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CertificateResource is a part of - name (string) –
- props (
CertificateResourceProps
or None) – the properties of this CertificateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
CertificateResourceProps (interface)¶
-
class
_aws-cdk_resources.dms.
CertificateResourceProps
¶ -
certificateIdentifier
¶ AWS::DMS::Certificate.CertificateIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificateidentifier
Type: string or Token
or None
-
certificatePem
¶ AWS::DMS::Certificate.CertificatePem http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatepem
Type: string or Token
or None
-
certificateWallet
¶ AWS::DMS::Certificate.CertificateWallet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-certificate.html#cfn-dms-certificate-certificatewallet
Type: string or Token
or None
-
EndpointExternalId¶
EndpointResource¶
-
class
_aws-cdk_resources.dms.
EndpointResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EndpointResource is a part of - name (string) –
- props (
EndpointResourceProps
or None) – the properties of this EndpointResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
endpointExternalId
¶ Type: EndpointExternalId
(readonly)
-
class
DynamoDbSettingsProperty
¶ -
serviceAccessRoleArn
¶ EndpointResource.DynamoDbSettingsProperty.ServiceAccessRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html#cfn-dms-endpoint-dynamodbsettings-serviceaccessrolearn
Type: string or Token
or None
-
-
class
MongoDbSettingsProperty
¶ -
authSource
¶ EndpointResource.MongoDbSettingsProperty.AuthSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authsource
Type: string or Token
or None
-
authMechanism
¶ EndpointResource.MongoDbSettingsProperty.AuthMechanism http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authmechanism
Type: string or Token
or None
-
username
¶ EndpointResource.MongoDbSettingsProperty.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-username
Type: string or Token
or None
-
docsToInvestigate
¶ EndpointResource.MongoDbSettingsProperty.DocsToInvestigate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-docstoinvestigate
Type: string or Token
or None
-
serverName
¶ EndpointResource.MongoDbSettingsProperty.ServerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername
Type: string or Token
or None
-
port
¶ EndpointResource.MongoDbSettingsProperty.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port
Type: number or Token
or None
-
extractDocId
¶ EndpointResource.MongoDbSettingsProperty.ExtractDocId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-extractdocid
Type: string or Token
or None
-
databaseName
¶ EndpointResource.MongoDbSettingsProperty.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-databasename
Type: string or Token
or None
-
authType
¶ EndpointResource.MongoDbSettingsProperty.AuthType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-authtype
Type: string or Token
or None
-
password
¶ EndpointResource.MongoDbSettingsProperty.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-password
Type: string or Token
or None
-
nestingLevel
¶ EndpointResource.MongoDbSettingsProperty.NestingLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-nestinglevel
Type: string or Token
or None
-
-
class
S3SettingsProperty
¶ -
externalTableDefinition
¶ EndpointResource.S3SettingsProperty.ExternalTableDefinition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-externaltabledefinition
Type: string or Token
or None
-
bucketName
¶ EndpointResource.S3SettingsProperty.BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketname
Type: string or Token
or None
-
bucketFolder
¶ EndpointResource.S3SettingsProperty.BucketFolder http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-bucketfolder
Type: string or Token
or None
-
csvRowDelimiter
¶ EndpointResource.S3SettingsProperty.CsvRowDelimiter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvrowdelimiter
Type: string or Token
or None
-
csvDelimiter
¶ EndpointResource.S3SettingsProperty.CsvDelimiter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-csvdelimiter
Type: string or Token
or None
-
serviceAccessRoleArn
¶ EndpointResource.S3SettingsProperty.ServiceAccessRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-serviceaccessrolearn
Type: string or Token
or None
-
compressionType
¶ EndpointResource.S3SettingsProperty.CompressionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html#cfn-dms-endpoint-s3settings-compressiontype
Type: string or Token
or None
-
- parent (
EndpointResourceProps (interface)¶
-
class
_aws-cdk_resources.dms.
EndpointResourceProps
¶ -
kmsKeyId
¶ AWS::DMS::Endpoint.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid
Type: string or Token
or None
-
port
¶ AWS::DMS::Endpoint.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-port
Type: number or Token
or None
-
databaseName
¶ AWS::DMS::Endpoint.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-databasename
Type: string or Token
or None
-
s3Settings
¶ AWS::DMS::Endpoint.S3Settings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings
Type: Token
orS3SettingsProperty
or None
-
engineName
¶ AWS::DMS::Endpoint.EngineName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename
Type: string or Token
-
dynamoDbSettings
¶ AWS::DMS::Endpoint.DynamoDbSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings
Type: Token
orDynamoDbSettingsProperty
or None
-
username
¶ AWS::DMS::Endpoint.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-username
Type: string or Token
or None
-
sslMode
¶ AWS::DMS::Endpoint.SslMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode
Type: string or Token
or None
-
serverName
¶ AWS::DMS::Endpoint.ServerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-servername
Type: string or Token
or None
-
extraConnectionAttributes
¶ AWS::DMS::Endpoint.ExtraConnectionAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes
Type: string or Token
or None
-
endpointType
¶ AWS::DMS::Endpoint.EndpointType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype
Type: string or Token
AWS::DMS::Endpoint.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags
Type: Token
orToken
orTag
or None
-
endpointIdentifier
¶ AWS::DMS::Endpoint.EndpointIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointidentifier
Type: string or Token
or None
-
password
¶ AWS::DMS::Endpoint.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-password
Type: string or Token
or None
-
certificateArn
¶ AWS::DMS::Endpoint.CertificateArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-certificatearn
Type: string or Token
or None
-
mongoDbSettings
¶ AWS::DMS::Endpoint.MongoDbSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings
Type: Token
orMongoDbSettingsProperty
or None
-
EventSubscriptionResource¶
-
class
_aws-cdk_resources.dms.
EventSubscriptionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EventSubscriptionResource is a part of - name (string) –
- props (
EventSubscriptionResourceProps
or None) – the properties of this EventSubscriptionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
EventSubscriptionResourceProps (interface)¶
-
class
_aws-cdk_resources.dms.
EventSubscriptionResourceProps
¶ -
sourceType
¶ AWS::DMS::EventSubscription.SourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype
Type: string or Token
or None
-
eventCategories
¶ AWS::DMS::EventSubscription.EventCategories http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-eventcategories
Type: Token
or string orToken
or None
-
enabled
¶ AWS::DMS::EventSubscription.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled
Type: boolean or Token
or None
-
subscriptionName
¶ AWS::DMS::EventSubscription.SubscriptionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname
Type: string or Token
or None
-
snsTopicArn
¶ AWS::DMS::EventSubscription.SnsTopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-snstopicarn
Type: string or Token
-
sourceIds
¶ AWS::DMS::EventSubscription.SourceIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourceids
Type: Token
or string orToken
or None
AWS::DMS::EventSubscription.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags
Type: Token
orToken
orTag
or None
-
ReplicationInstancePrivateIpAddresses¶
ReplicationInstancePublicIpAddresses¶
ReplicationInstanceResource¶
-
class
_aws-cdk_resources.dms.
ReplicationInstanceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReplicationInstanceResource is a part of - name (string) –
- props (
ReplicationInstanceResourceProps
or None) – the properties of this ReplicationInstanceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
replicationInstancePublicIpAddresses
¶ Type: ReplicationInstancePublicIpAddresses
(readonly)
-
replicationInstancePrivateIpAddresses
¶ Type: ReplicationInstancePrivateIpAddresses
(readonly)
- parent (
ReplicationInstanceResourceProps (interface)¶
-
class
_aws-cdk_resources.dms.
ReplicationInstanceResourceProps
¶ -
replicationInstanceIdentifier
¶ AWS::DMS::ReplicationInstance.ReplicationInstanceIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceidentifier
Type: string or Token
or None
-
engineVersion
¶ AWS::DMS::ReplicationInstance.EngineVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-engineversion
Type: string or Token
or None
-
kmsKeyId
¶ AWS::DMS::ReplicationInstance.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-kmskeyid
Type: string or Token
or None
-
availabilityZone
¶ AWS::DMS::ReplicationInstance.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-availabilityzone
Type: string or Token
or None
-
preferredMaintenanceWindow
¶ AWS::DMS::ReplicationInstance.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-preferredmaintenancewindow
Type: string or Token
or None
-
autoMinorVersionUpgrade
¶ AWS::DMS::ReplicationInstance.AutoMinorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-autominorversionupgrade
Type: boolean or Token
or None
-
replicationSubnetGroupIdentifier
¶ AWS::DMS::ReplicationInstance.ReplicationSubnetGroupIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationsubnetgroupidentifier
Type: string or Token
or None
-
allocatedStorage
¶ AWS::DMS::ReplicationInstance.AllocatedStorage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allocatedstorage
Type: number or Token
or None
-
vpcSecurityGroupIds
¶ AWS::DMS::ReplicationInstance.VpcSecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-vpcsecuritygroupids
Type: Token
or string orToken
or None
-
allowMajorVersionUpgrade
¶ AWS::DMS::ReplicationInstance.AllowMajorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-allowmajorversionupgrade
Type: boolean or Token
or None
-
replicationInstanceClass
¶ AWS::DMS::ReplicationInstance.ReplicationInstanceClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-replicationinstanceclass
Type: string or Token
-
publiclyAccessible
¶ AWS::DMS::ReplicationInstance.PubliclyAccessible http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-publiclyaccessible
Type: boolean or Token
or None
-
multiAz
¶ AWS::DMS::ReplicationInstance.MultiAZ http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-multiaz
Type: boolean or Token
or None
AWS::DMS::ReplicationInstance.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationinstance.html#cfn-dms-replicationinstance-tags
Type: Token
orToken
orTag
or None
-
ReplicationSubnetGroupResource¶
-
class
_aws-cdk_resources.dms.
ReplicationSubnetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReplicationSubnetGroupResource is a part of - name (string) –
- props (
ReplicationSubnetGroupResourceProps
or None) – the properties of this ReplicationSubnetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ReplicationSubnetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.dms.
ReplicationSubnetGroupResourceProps
¶ -
replicationSubnetGroupDescription
¶ AWS::DMS::ReplicationSubnetGroup.ReplicationSubnetGroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupdescription
Type: string or Token
-
replicationSubnetGroupIdentifier
¶ AWS::DMS::ReplicationSubnetGroup.ReplicationSubnetGroupIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-replicationsubnetgroupidentifier
Type: string or Token
or None
-
subnetIds
¶ AWS::DMS::ReplicationSubnetGroup.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-subnetids
Type: Token
or string orToken
AWS::DMS::ReplicationSubnetGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationsubnetgroup.html#cfn-dms-replicationsubnetgroup-tags
Type: Token
orToken
orTag
or None
-
ReplicationTaskResource¶
-
class
_aws-cdk_resources.dms.
ReplicationTaskResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReplicationTaskResource is a part of - name (string) –
- props (
ReplicationTaskResourceProps
or None) – the properties of this ReplicationTaskResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ReplicationTaskResourceProps (interface)¶
-
class
_aws-cdk_resources.dms.
ReplicationTaskResourceProps
¶ -
replicationTaskSettings
¶ AWS::DMS::ReplicationTask.ReplicationTaskSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings
Type: string or Token
or None
-
tableMappings
¶ AWS::DMS::ReplicationTask.TableMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings
Type: string or Token
-
replicationTaskIdentifier
¶ AWS::DMS::ReplicationTask.ReplicationTaskIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier
Type: string or Token
or None
-
sourceEndpointArn
¶ AWS::DMS::ReplicationTask.SourceEndpointArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn
Type: string or Token
-
migrationType
¶ AWS::DMS::ReplicationTask.MigrationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype
Type: string or Token
-
targetEndpointArn
¶ AWS::DMS::ReplicationTask.TargetEndpointArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn
Type: string or Token
-
replicationInstanceArn
¶ AWS::DMS::ReplicationTask.ReplicationInstanceArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn
Type: string or Token
AWS::DMS::ReplicationTask.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags
Type: Token
orToken
orTag
or None
-
cdcStartTime
¶ AWS::DMS::ReplicationTask.CdcStartTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime
Type: number or Token
or None
-
dynamodb¶
TableArn¶
TableResource¶
-
class
_aws-cdk_resources.dynamodb.
TableResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TableResource is a part of - name (string) –
- props (
TableResourceProps
or None) – the properties of this TableResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
tableArn
¶ Type: TableArn
(readonly)
-
tableStreamArn
¶ Type: TableStreamArn
(readonly)
-
class
AttributeDefinitionProperty
¶ -
attributeName
¶ TableResource.AttributeDefinitionProperty.AttributeName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename
Type: string or Token
-
attributeType
¶ TableResource.AttributeDefinitionProperty.AttributeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename-attributetype
Type: string or Token
-
-
class
GlobalSecondaryIndexProperty
¶ -
indexName
¶ TableResource.GlobalSecondaryIndexProperty.IndexName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-indexname
Type: string or Token
-
keySchema
¶ TableResource.GlobalSecondaryIndexProperty.KeySchema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-keyschema
Type: Token
orToken
orKeySchemaProperty
-
projection
¶ TableResource.GlobalSecondaryIndexProperty.Projection http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-projection
Type: Token
orProjectionProperty
-
provisionedThroughput
¶ TableResource.GlobalSecondaryIndexProperty.ProvisionedThroughput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-provisionedthroughput
Type: Token
orProvisionedThroughputProperty
-
-
class
KeySchemaProperty
¶ -
attributeName
¶ TableResource.KeySchemaProperty.AttributeName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-attributename
Type: string or Token
-
keyType
¶ TableResource.KeySchemaProperty.KeyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-keytype
Type: string or Token
-
-
class
LocalSecondaryIndexProperty
¶ -
indexName
¶ TableResource.LocalSecondaryIndexProperty.IndexName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-indexname
Type: string or Token
-
keySchema
¶ TableResource.LocalSecondaryIndexProperty.KeySchema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-keyschema
Type: Token
orToken
orKeySchemaProperty
-
projection
¶ TableResource.LocalSecondaryIndexProperty.Projection http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-projection
Type: Token
orProjectionProperty
-
-
class
PointInTimeRecoverySpecificationProperty
¶ -
pointInTimeRecoveryEnabled
¶ TableResource.PointInTimeRecoverySpecificationProperty.PointInTimeRecoveryEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled
Type: boolean or Token
or None
-
-
class
ProjectionProperty
¶ -
nonKeyAttributes
¶ TableResource.ProjectionProperty.NonKeyAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-nonkeyatt
Type: Token
or string orToken
or None
-
projectionType
¶ TableResource.ProjectionProperty.ProjectionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-projtype
Type: string or Token
or None
-
-
class
ProvisionedThroughputProperty
¶ -
readCapacityUnits
¶ TableResource.ProvisionedThroughputProperty.ReadCapacityUnits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-readcapacityunits
Type: number or Token
-
writeCapacityUnits
¶ TableResource.ProvisionedThroughputProperty.WriteCapacityUnits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-writecapacityunits
Type: number or Token
-
-
class
SSESpecificationProperty
¶ -
sseEnabled
¶ TableResource.SSESpecificationProperty.SSEEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-sseenabled
Type: boolean or Token
-
-
class
StreamSpecificationProperty
¶ -
streamViewType
¶ TableResource.StreamSpecificationProperty.StreamViewType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html#cfn-dynamodb-streamspecification-streamviewtype
Type: string or Token
-
-
class
TimeToLiveSpecificationProperty
¶ -
attributeName
¶ TableResource.TimeToLiveSpecificationProperty.AttributeName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-attributename
Type: string or Token
-
enabled
¶ TableResource.TimeToLiveSpecificationProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-enabled
Type: boolean or Token
-
- parent (
TableResourceProps (interface)¶
-
class
_aws-cdk_resources.dynamodb.
TableResourceProps
¶ -
attributeDefinitions
¶ AWS::DynamoDB::Table.AttributeDefinitions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedef
Type: Token
orToken
orAttributeDefinitionProperty
or None
-
globalSecondaryIndexes
¶ AWS::DynamoDB::Table.GlobalSecondaryIndexes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-gsi
Type: Token
orToken
orGlobalSecondaryIndexProperty
or None
-
keySchema
¶ AWS::DynamoDB::Table.KeySchema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema
Type: Token
orToken
orKeySchemaProperty
-
localSecondaryIndexes
¶ AWS::DynamoDB::Table.LocalSecondaryIndexes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-lsi
Type: Token
orToken
orLocalSecondaryIndexProperty
or None
-
pointInTimeRecoverySpecification
¶ AWS::DynamoDB::Table.PointInTimeRecoverySpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification
Type: Token
orPointInTimeRecoverySpecificationProperty
or None
-
provisionedThroughput
¶ AWS::DynamoDB::Table.ProvisionedThroughput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput
Type: Token
orProvisionedThroughputProperty
-
sseSpecification
¶ AWS::DynamoDB::Table.SSESpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification
Type: Token
orSSESpecificationProperty
or None
-
streamSpecification
¶ AWS::DynamoDB::Table.StreamSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification
Type: Token
orStreamSpecificationProperty
or None
-
tableName
¶ AWS::DynamoDB::Table.TableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename
Type: string or Token
or None
AWS::DynamoDB::Table.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags
Type: Token
orToken
orTag
or None
-
timeToLiveSpecification
¶ AWS::DynamoDB::Table.TimeToLiveSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification
Type: Token
orTimeToLiveSpecificationProperty
or None
-
ec2¶
CustomerGatewayResource¶
-
class
_aws-cdk_resources.ec2.
CustomerGatewayResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CustomerGatewayResource is a part of - name (string) –
- props (
CustomerGatewayResourceProps
or None) – the properties of this CustomerGatewayResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
CustomerGatewayResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
CustomerGatewayResourceProps
¶ -
bgpAsn
¶ AWS::EC2::CustomerGateway.BgpAsn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-bgpasn
Type: number or Token
-
ipAddress
¶ AWS::EC2::CustomerGateway.IpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-ipaddress
Type: string or Token
AWS::EC2::CustomerGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-tags
Type: Token
orToken
orTag
or None
-
type
¶ AWS::EC2::CustomerGateway.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customer-gateway.html#cfn-ec2-customergateway-type
Type: string or Token
-
DHCPOptionsResource¶
-
class
_aws-cdk_resources.ec2.
DHCPOptionsResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DHCPOptionsResource is a part of - name (string) –
- props (
DHCPOptionsResourceProps
or None) – the properties of this DHCPOptionsResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DHCPOptionsResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
DHCPOptionsResourceProps
¶ -
domainName
¶ AWS::EC2::DHCPOptions.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-domainname
Type: string or Token
or None
-
domainNameServers
¶ AWS::EC2::DHCPOptions.DomainNameServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-domainnameservers
Type: Token
or string orToken
or None
-
netbiosNameServers
¶ AWS::EC2::DHCPOptions.NetbiosNameServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-netbiosnameservers
Type: Token
or string orToken
or None
-
netbiosNodeType
¶ AWS::EC2::DHCPOptions.NetbiosNodeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-netbiosnodetype
Type: number or Token
or None
-
ntpServers
¶ AWS::EC2::DHCPOptions.NtpServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-ntpservers
Type: Token
or string orToken
or None
AWS::EC2::DHCPOptions.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcp-options.html#cfn-ec2-dhcpoptions-tags
Type: Token
orToken
orTag
or None
-
EIPAllocationId¶
EIPAssociationResource¶
-
class
_aws-cdk_resources.ec2.
EIPAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EIPAssociationResource is a part of - name (string) –
- props (
EIPAssociationResourceProps
or None) – the properties of this EIPAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
EIPAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
EIPAssociationResourceProps
¶ -
allocationId
¶ AWS::EC2::EIPAssociation.AllocationId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-allocationid
Type: string or Token
or None
-
eip
¶ AWS::EC2::EIPAssociation.EIP http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-eip
Type: string or Token
or None
-
instanceId
¶ AWS::EC2::EIPAssociation.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-instanceid
Type: string or Token
or None
-
networkInterfaceId
¶ AWS::EC2::EIPAssociation.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-networkinterfaceid
Type: string or Token
or None
-
privateIpAddress
¶ AWS::EC2::EIPAssociation.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip-association.html#cfn-ec2-eipassociation-PrivateIpAddress
Type: string or Token
or None
-
EIPResource¶
-
class
_aws-cdk_resources.ec2.
EIPResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EIPResource is a part of - name (string) –
- props (
EIPResourceProps
or None) – the properties of this EIPResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
eipAllocationId
¶ Type: EIPAllocationId
(readonly)
- parent (
EIPResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
EIPResourceProps
¶ -
domain
¶ AWS::EC2::EIP.Domain http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-domain
Type: string or Token
or None
-
instanceId
¶ AWS::EC2::EIP.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid
Type: string or Token
or None
-
EgressOnlyInternetGatewayResource¶
-
class
_aws-cdk_resources.ec2.
EgressOnlyInternetGatewayResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EgressOnlyInternetGatewayResource is a part of - name (string) –
- props (
EgressOnlyInternetGatewayResourceProps
or None) – the properties of this EgressOnlyInternetGatewayResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
EgressOnlyInternetGatewayResourceProps (interface)¶
FlowLogResource¶
-
class
_aws-cdk_resources.ec2.
FlowLogResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this FlowLogResource is a part of - name (string) –
- props (
FlowLogResourceProps
or None) – the properties of this FlowLogResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
FlowLogResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
FlowLogResourceProps
¶ -
deliverLogsPermissionArn
¶ AWS::EC2::FlowLog.DeliverLogsPermissionArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn
Type: string or Token
-
logGroupName
¶ AWS::EC2::FlowLog.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname
Type: string or Token
-
resourceId
¶ AWS::EC2::FlowLog.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid
Type: string or Token
-
resourceType
¶ AWS::EC2::FlowLog.ResourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype
Type: string or Token
-
trafficType
¶ AWS::EC2::FlowLog.TrafficType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype
Type: string or Token
-
HostResource¶
-
class
_aws-cdk_resources.ec2.
HostResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this HostResource is a part of - name (string) –
- props (
HostResourceProps
or None) – the properties of this HostResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
HostResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
HostResourceProps
¶ -
autoPlacement
¶ AWS::EC2::Host.AutoPlacement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-autoplacement
Type: string or Token
or None
-
availabilityZone
¶ AWS::EC2::Host.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-availabilityzone
Type: string or Token
-
instanceType
¶ AWS::EC2::Host.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-host.html#cfn-ec2-host-instancetype
Type: string or Token
-
InstanceAvailabilityZone¶
InstancePrivateDnsName¶
InstancePrivateIp¶
InstancePublicDnsName¶
InstancePublicIp¶
InstanceResource¶
-
class
_aws-cdk_resources.ec2.
InstanceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InstanceResource is a part of - name (string) –
- props (
InstanceResourceProps
or None) – the properties of this InstanceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
instanceAvailabilityZone
¶ Type: InstanceAvailabilityZone
(readonly)
-
instancePrivateDnsName
¶ Type: InstancePrivateDnsName
(readonly)
-
instancePrivateIp
¶ Type: InstancePrivateIp
(readonly)
-
instancePublicDnsName
¶ Type: InstancePublicDnsName
(readonly)
-
instancePublicIp
¶ Type: InstancePublicIp
(readonly)
-
class
AssociationParameterProperty
¶ -
key
¶ InstanceResource.AssociationParameterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-key
Type: string or Token
-
value
¶ InstanceResource.AssociationParameterProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations-associationparameters.html#cfn-ec2-instance-ssmassociations-associationparameters-value
Type: Token
or string orToken
-
-
class
BlockDeviceMappingProperty
¶ -
deviceName
¶ InstanceResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-devicename
Type: string or Token
-
ebs
¶ InstanceResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-ebs
Type: Token
orEbsProperty
or None
-
noDevice
¶ InstanceResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-nodevice
Type: Token
orNoDeviceProperty
or None
-
virtualName
¶ InstanceResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-mapping.html#cfn-ec2-blockdev-mapping-virtualname
Type: string or Token
or None
-
-
class
CreditSpecificationProperty
¶ -
cpuCredits
¶ InstanceResource.CreditSpecificationProperty.CPUCredits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-creditspecification.html#cfn-ec2-instance-creditspecification-cpucredits
Type: string or Token
or None
-
-
class
EbsProperty
¶ -
deleteOnTermination
¶ InstanceResource.EbsProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-deleteontermination
Type: boolean or Token
or None
-
encrypted
¶ InstanceResource.EbsProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-encrypted
Type: boolean or Token
or None
-
iops
¶ InstanceResource.EbsProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-iops
Type: number or Token
or None
-
snapshotId
¶ InstanceResource.EbsProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-snapshotid
Type: string or Token
or None
-
volumeSize
¶ InstanceResource.EbsProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumesize
Type: number or Token
or None
-
volumeType
¶ InstanceResource.EbsProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-blockdev-template.html#cfn-ec2-blockdev-template-volumetype
Type: string or Token
or None
-
-
class
ElasticGpuSpecificationProperty
¶ -
type
¶ InstanceResource.ElasticGpuSpecificationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-elasticgpuspecification.html#cfn-ec2-instance-elasticgpuspecification-type
Type: string or Token
-
-
class
InstanceIpv6AddressProperty
¶ -
ipv6Address
¶ InstanceResource.InstanceIpv6AddressProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html#cfn-ec2-instance-instanceipv6address-ipv6address
Type: string or Token
-
-
class
LaunchTemplateSpecificationProperty
¶ -
launchTemplateId
¶ InstanceResource.LaunchTemplateSpecificationProperty.LaunchTemplateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplateid
Type: string or Token
or None
-
launchTemplateName
¶ InstanceResource.LaunchTemplateSpecificationProperty.LaunchTemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-launchtemplatename
Type: string or Token
or None
-
version
¶ InstanceResource.LaunchTemplateSpecificationProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-launchtemplatespecification.html#cfn-ec2-instance-launchtemplatespecification-version
Type: string or Token
-
-
class
NetworkInterfaceProperty
¶ -
associatePublicIpAddress
¶ InstanceResource.NetworkInterfaceProperty.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-associatepubip
Type: boolean or Token
or None
-
deleteOnTermination
¶ InstanceResource.NetworkInterfaceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-delete
Type: boolean or Token
or None
-
description
¶ InstanceResource.NetworkInterfaceProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-description
Type: string or Token
or None
-
deviceIndex
¶ InstanceResource.NetworkInterfaceProperty.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-deviceindex
Type: string or Token
-
groupSet
¶ InstanceResource.NetworkInterfaceProperty.GroupSet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-groupset
Type: Token
or string orToken
or None
-
ipv6AddressCount
¶ InstanceResource.NetworkInterfaceProperty.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresscount
Type: number or Token
or None
-
ipv6Addresses
¶ InstanceResource.NetworkInterfaceProperty.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#cfn-ec2-instance-networkinterface-ipv6addresses
Type: Token
orToken
orInstanceIpv6AddressProperty
or None
-
networkInterfaceId
¶ InstanceResource.NetworkInterfaceProperty.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-network-iface
Type: string or Token
or None
-
privateIpAddress
¶ InstanceResource.NetworkInterfaceProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddress
Type: string or Token
or None
-
privateIpAddresses
¶ InstanceResource.NetworkInterfaceProperty.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-privateipaddresses
Type: Token
orToken
orPrivateIpAddressSpecificationProperty
or None
-
secondaryPrivateIpAddressCount
¶ InstanceResource.NetworkInterfaceProperty.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-secondprivateip
Type: number or Token
or None
-
subnetId
¶ InstanceResource.NetworkInterfaceProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-iface-embedded.html#aws-properties-ec2-network-iface-embedded-subnetid
Type: string or Token
or None
-
-
class
NoDeviceProperty
¶
-
class
PrivateIpAddressSpecificationProperty
¶ -
primary
¶ InstanceResource.PrivateIpAddressSpecificationProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary
Type: boolean or Token
-
privateIpAddress
¶ InstanceResource.PrivateIpAddressSpecificationProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress
Type: string or Token
-
-
class
SsmAssociationProperty
¶ -
associationParameters
¶ InstanceResource.SsmAssociationProperty.AssociationParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-associationparameters
Type: Token
orToken
orAssociationParameterProperty
or None
-
documentName
¶ InstanceResource.SsmAssociationProperty.DocumentName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-ssmassociations.html#cfn-ec2-instance-ssmassociations-documentname
Type: string or Token
-
-
class
VolumeProperty
¶ -
device
¶ InstanceResource.VolumeProperty.Device http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-device
Type: string or Token
-
volumeId
¶ InstanceResource.VolumeProperty.VolumeId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-mount-point.html#cfn-ec2-mountpoint-volumeid
Type: string or Token
-
- parent (
InstanceResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
InstanceResourceProps
¶ -
additionalInfo
¶ AWS::EC2::Instance.AdditionalInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-additionalinfo
Type: string or Token
or None
-
affinity
¶ AWS::EC2::Instance.Affinity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-affinity
Type: string or Token
or None
-
availabilityZone
¶ AWS::EC2::Instance.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-availabilityzone
Type: string or Token
or None
-
blockDeviceMappings
¶ AWS::EC2::Instance.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-blockdevicemappings
Type: Token
orToken
orBlockDeviceMappingProperty
or None
-
creditSpecification
¶ AWS::EC2::Instance.CreditSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-creditspecification
Type: Token
orCreditSpecificationProperty
or None
-
disableApiTermination
¶ AWS::EC2::Instance.DisableApiTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-disableapitermination
Type: boolean or Token
or None
-
ebsOptimized
¶ AWS::EC2::Instance.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ebsoptimized
Type: boolean or Token
or None
-
elasticGpuSpecifications
¶ AWS::EC2::Instance.ElasticGpuSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications
Type: Token
orToken
orElasticGpuSpecificationProperty
or None
-
hostId
¶ AWS::EC2::Instance.HostId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-hostid
Type: string or Token
or None
-
iamInstanceProfile
¶ AWS::EC2::Instance.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile
Type: string or Token
or None
-
imageId
¶ AWS::EC2::Instance.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-imageid
Type: string or Token
or None
-
instanceInitiatedShutdownBehavior
¶ AWS::EC2::Instance.InstanceInitiatedShutdownBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior
Type: string or Token
or None
-
instanceType
¶ AWS::EC2::Instance.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-instancetype
Type: string or Token
or None
-
ipv6AddressCount
¶ AWS::EC2::Instance.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresscount
Type: number or Token
or None
-
ipv6Addresses
¶ AWS::EC2::Instance.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ipv6addresses
Type: Token
orToken
orInstanceIpv6AddressProperty
or None
-
kernelId
¶ AWS::EC2::Instance.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-kernelid
Type: string or Token
or None
-
keyName
¶ AWS::EC2::Instance.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-keyname
Type: string or Token
or None
-
launchTemplate
¶ AWS::EC2::Instance.LaunchTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-launchtemplate
Type: Token
orLaunchTemplateSpecificationProperty
or None
-
monitoring
¶ AWS::EC2::Instance.Monitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-monitoring
Type: boolean or Token
or None
-
networkInterfaces
¶ AWS::EC2::Instance.NetworkInterfaces http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-networkinterfaces
Type: Token
orToken
orNetworkInterfaceProperty
or None
-
placementGroupName
¶ AWS::EC2::Instance.PlacementGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-placementgroupname
Type: string or Token
or None
-
privateIpAddress
¶ AWS::EC2::Instance.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-privateipaddress
Type: string or Token
or None
-
ramdiskId
¶ AWS::EC2::Instance.RamdiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ramdiskid
Type: string or Token
or None
-
securityGroupIds
¶ AWS::EC2::Instance.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroupids
Type: Token
or string orToken
or None
-
securityGroups
¶ AWS::EC2::Instance.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-securitygroups
Type: Token
or string orToken
or None
-
sourceDestCheck
¶ AWS::EC2::Instance.SourceDestCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-sourcedestcheck
Type: boolean or Token
or None
-
ssmAssociations
¶ AWS::EC2::Instance.SsmAssociations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-ssmassociations
Type: Token
orToken
orSsmAssociationProperty
or None
-
subnetId
¶ AWS::EC2::Instance.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-subnetid
Type: string or Token
or None
AWS::EC2::Instance.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tags
Type: Token
orToken
orTag
or None
-
tenancy
¶ AWS::EC2::Instance.Tenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-tenancy
Type: string or Token
or None
-
userData
¶ AWS::EC2::Instance.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-userdata
Type: string or Token
or None
-
volumes
¶ AWS::EC2::Instance.Volumes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html#cfn-ec2-instance-volumes
Type: Token
orToken
orVolumeProperty
or None
-
InternetGatewayResource¶
-
class
_aws-cdk_resources.ec2.
InternetGatewayResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InternetGatewayResource is a part of - name (string) –
- props (
InternetGatewayResourceProps
or None) – the properties of this InternetGatewayResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
InternetGatewayResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
InternetGatewayResourceProps
¶ AWS::EC2::InternetGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-internetgateway.html#cfn-ec2-internetgateway-tags
Type: Token
orToken
orTag
or None
LaunchTemplateDefaultVersionNumber¶
LaunchTemplateLatestVersionNumber¶
LaunchTemplateResource¶
-
class
_aws-cdk_resources.ec2.
LaunchTemplateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LaunchTemplateResource is a part of - name (string) –
- props (
LaunchTemplateResourceProps
or None) – the properties of this LaunchTemplateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
launchTemplateLatestVersionNumber
¶ Type: LaunchTemplateLatestVersionNumber
(readonly)
-
launchTemplateDefaultVersionNumber
¶ Type: LaunchTemplateDefaultVersionNumber
(readonly)
-
class
BlockDeviceMappingProperty
¶ -
ebs
¶ LaunchTemplateResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs
Type: Token
orEbsProperty
or None
-
noDevice
¶ LaunchTemplateResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice
Type: string or Token
or None
-
virtualName
¶ LaunchTemplateResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname
Type: string or Token
or None
-
deviceName
¶ LaunchTemplateResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename
Type: string or Token
or None
-
-
class
CreditSpecificationProperty
¶ -
cpuCredits
¶ LaunchTemplateResource.CreditSpecificationProperty.CpuCredits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-creditspecification.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification-cpucredits
Type: string or Token
or None
-
-
class
EbsProperty
¶ -
snapshotId
¶ LaunchTemplateResource.EbsProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-snapshotid
Type: string or Token
or None
-
volumeType
¶ LaunchTemplateResource.EbsProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumetype
Type: string or Token
or None
-
kmsKeyId
¶ LaunchTemplateResource.EbsProperty.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-kmskeyid
Type: string or Token
or None
-
encrypted
¶ LaunchTemplateResource.EbsProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-encrypted
Type: boolean or Token
or None
-
iops
¶ LaunchTemplateResource.EbsProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-iops
Type: number or Token
or None
-
volumeSize
¶ LaunchTemplateResource.EbsProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-volumesize
Type: number or Token
or None
-
deleteOnTermination
¶ LaunchTemplateResource.EbsProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping-ebs.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs-deleteontermination
Type: boolean or Token
or None
-
-
class
ElasticGpuSpecificationProperty
¶ -
type
¶ LaunchTemplateResource.ElasticGpuSpecificationProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html#cfn-ec2-launchtemplate-elasticgpuspecification-type
Type: string or Token
or None
-
-
class
IamInstanceProfileProperty
¶ -
arn
¶ LaunchTemplateResource.IamInstanceProfileProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-arn
Type: string or Token
or None
-
name
¶ LaunchTemplateResource.IamInstanceProfileProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile-name
Type: string or Token
or None
-
-
class
InstanceMarketOptionsProperty
¶ -
spotOptions
¶ LaunchTemplateResource.InstanceMarketOptionsProperty.SpotOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions
Type: Token
orSpotOptionsProperty
or None
-
marketType
¶ LaunchTemplateResource.InstanceMarketOptionsProperty.MarketType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-markettype
Type: string or Token
or None
-
-
class
Ipv6AddProperty
¶ -
ipv6Address
¶ LaunchTemplateResource.Ipv6AddProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-ipv6add.html#cfn-ec2-launchtemplate-ipv6add-ipv6address
Type: string or Token
or None
-
-
class
LaunchTemplateDataProperty
¶ -
securityGroups
¶ LaunchTemplateResource.LaunchTemplateDataProperty.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroups
Type: Token
or string orToken
or None
-
tagSpecifications
¶ LaunchTemplateResource.LaunchTemplateDataProperty.TagSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications
Type: Token
orToken
orTagSpecificationProperty
or None
-
userData
¶ LaunchTemplateResource.LaunchTemplateDataProperty.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-userdata
Type: string or Token
or None
-
instanceInitiatedShutdownBehavior
¶ LaunchTemplateResource.LaunchTemplateDataProperty.InstanceInitiatedShutdownBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instanceinitiatedshutdownbehavior
Type: string or Token
or None
-
blockDeviceMappings
¶ LaunchTemplateResource.LaunchTemplateDataProperty.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-blockdevicemappings
Type: Token
orToken
orBlockDeviceMappingProperty
or None
-
iamInstanceProfile
¶ LaunchTemplateResource.LaunchTemplateDataProperty.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-iaminstanceprofile
Type: Token
orIamInstanceProfileProperty
or None
-
kernelId
¶ LaunchTemplateResource.LaunchTemplateDataProperty.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid
Type: string or Token
or None
-
securityGroupIds
¶ LaunchTemplateResource.LaunchTemplateDataProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-securitygroupids
Type: Token
or string orToken
or None
-
ebsOptimized
¶ LaunchTemplateResource.LaunchTemplateDataProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ebsoptimized
Type: boolean or Token
or None
-
keyName
¶ LaunchTemplateResource.LaunchTemplateDataProperty.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-keyname
Type: string or Token
or None
-
disableApiTermination
¶ LaunchTemplateResource.LaunchTemplateDataProperty.DisableApiTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-disableapitermination
Type: boolean or Token
or None
-
elasticGpuSpecifications
¶ LaunchTemplateResource.LaunchTemplateDataProperty.ElasticGpuSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticgpuspecifications
Type: Token
orToken
orElasticGpuSpecificationProperty
or None
-
placement
¶ LaunchTemplateResource.LaunchTemplateDataProperty.Placement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-placement
Type: Token
orPlacementProperty
or None
-
instanceMarketOptions
¶ LaunchTemplateResource.LaunchTemplateDataProperty.InstanceMarketOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions
Type: Token
orInstanceMarketOptionsProperty
or None
-
networkInterfaces
¶ LaunchTemplateResource.LaunchTemplateDataProperty.NetworkInterfaces http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-networkinterfaces
Type: Token
orToken
orNetworkInterfaceProperty
or None
-
imageId
¶ LaunchTemplateResource.LaunchTemplateDataProperty.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-imageid
Type: string or Token
or None
-
instanceType
¶ LaunchTemplateResource.LaunchTemplateDataProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-instancetype
Type: string or Token
or None
-
ramDiskId
¶ LaunchTemplateResource.LaunchTemplateDataProperty.RamDiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-ramdiskid
Type: string or Token
or None
-
monitoring
¶ LaunchTemplateResource.LaunchTemplateDataProperty.Monitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring
Type: Token
orMonitoringProperty
or None
-
creditSpecification
¶ LaunchTemplateResource.LaunchTemplateDataProperty.CreditSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-creditspecification
Type: Token
orCreditSpecificationProperty
or None
-
-
class
MonitoringProperty
¶ -
enabled
¶ LaunchTemplateResource.MonitoringProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-monitoring.html#cfn-ec2-launchtemplate-launchtemplatedata-monitoring-enabled
Type: boolean or Token
or None
-
-
class
NetworkInterfaceProperty
¶ -
description
¶ LaunchTemplateResource.NetworkInterfaceProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-description
Type: string or Token
or None
-
privateIpAddress
¶ LaunchTemplateResource.NetworkInterfaceProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddress
Type: string or Token
or None
-
privateIpAddresses
¶ LaunchTemplateResource.NetworkInterfaceProperty.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-privateipaddresses
Type: Token
orToken
orPrivateIpAddProperty
or None
-
secondaryPrivateIpAddressCount
¶ LaunchTemplateResource.NetworkInterfaceProperty.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-secondaryprivateipaddresscount
Type: number or Token
or None
-
ipv6AddressCount
¶ LaunchTemplateResource.NetworkInterfaceProperty.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresscount
Type: number or Token
or None
-
groups
¶ LaunchTemplateResource.NetworkInterfaceProperty.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-groups
Type: Token
or string orToken
or None
-
deviceIndex
¶ LaunchTemplateResource.NetworkInterfaceProperty.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deviceindex
Type: number or Token
or None
-
subnetId
¶ LaunchTemplateResource.NetworkInterfaceProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-subnetid
Type: string or Token
or None
-
ipv6Addresses
¶ LaunchTemplateResource.NetworkInterfaceProperty.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-ipv6addresses
Type: Token
orToken
orIpv6AddProperty
or None
-
associatePublicIpAddress
¶ LaunchTemplateResource.NetworkInterfaceProperty.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatepublicipaddress
Type: boolean or Token
or None
-
networkInterfaceId
¶ LaunchTemplateResource.NetworkInterfaceProperty.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-networkinterfaceid
Type: string or Token
or None
-
deleteOnTermination
¶ LaunchTemplateResource.NetworkInterfaceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-deleteontermination
Type: boolean or Token
or None
-
-
class
PlacementProperty
¶ -
groupName
¶ LaunchTemplateResource.PlacementProperty.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-groupname
Type: string or Token
or None
-
tenancy
¶ LaunchTemplateResource.PlacementProperty.Tenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-tenancy
Type: string or Token
or None
-
availabilityZone
¶ LaunchTemplateResource.PlacementProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-availabilityzone
Type: string or Token
or None
-
affinity
¶ LaunchTemplateResource.PlacementProperty.Affinity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-affinity
Type: string or Token
or None
-
hostId
¶ LaunchTemplateResource.PlacementProperty.HostId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-placement.html#cfn-ec2-launchtemplate-launchtemplatedata-placement-hostid
Type: string or Token
or None
-
-
class
PrivateIpAddProperty
¶ -
privateIpAddress
¶ LaunchTemplateResource.PrivateIpAddProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-privateipaddress
Type: string or Token
or None
-
primary
¶ LaunchTemplateResource.PrivateIpAddProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-privateipadd.html#cfn-ec2-launchtemplate-privateipadd-primary
Type: boolean or Token
or None
-
-
class
SpotOptionsProperty
¶ -
spotInstanceType
¶ LaunchTemplateResource.SpotOptionsProperty.SpotInstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-spotinstancetype
Type: string or Token
or None
-
instanceInterruptionBehavior
¶ LaunchTemplateResource.SpotOptionsProperty.InstanceInterruptionBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-instanceinterruptionbehavior
Type: string or Token
or None
-
maxPrice
¶ LaunchTemplateResource.SpotOptionsProperty.MaxPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-instancemarketoptions-spotoptions-maxprice
Type: string or Token
or None
-
-
class
TagSpecificationProperty
¶ -
resourceType
¶ LaunchTemplateResource.TagSpecificationProperty.ResourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-resourcetype
Type: string or Token
or None
LaunchTemplateResource.TagSpecificationProperty.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html#cfn-ec2-launchtemplate-tagspecification-tags
Type: Token
orToken
orTag
or None
-
- parent (
LaunchTemplateResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
LaunchTemplateResourceProps
¶ -
launchTemplateName
¶ AWS::EC2::LaunchTemplate.LaunchTemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatename
Type: string or Token
or None
-
launchTemplateData
¶ AWS::EC2::LaunchTemplate.LaunchTemplateData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-launchtemplatedata
Type: Token
orLaunchTemplateDataProperty
or None
-
NatGatewayResource¶
-
class
_aws-cdk_resources.ec2.
NatGatewayResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NatGatewayResource is a part of - name (string) –
- props (
NatGatewayResourceProps
or None) – the properties of this NatGatewayResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
NatGatewayResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
NatGatewayResourceProps
¶ -
allocationId
¶ AWS::EC2::NatGateway.AllocationId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid
Type: string or Token
-
subnetId
¶ AWS::EC2::NatGateway.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-subnetid
Type: string or Token
AWS::EC2::NatGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-tags
Type: Token
orToken
orTag
or None
-
NetworkAclEntryResource¶
-
class
_aws-cdk_resources.ec2.
NetworkAclEntryResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NetworkAclEntryResource is a part of - name (string) –
- props (
NetworkAclEntryResourceProps
or None) – the properties of this NetworkAclEntryResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
IcmpProperty
¶ -
code
¶ NetworkAclEntryResource.IcmpProperty.Code http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-code
Type: number or Token
or None
-
type
¶ NetworkAclEntryResource.IcmpProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-icmp.html#cfn-ec2-networkaclentry-icmp-type
Type: number or Token
or None
-
-
class
PortRangeProperty
¶ -
from
¶ NetworkAclEntryResource.PortRangeProperty.From http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-from
Type: number or Token
or None
-
to
¶ NetworkAclEntryResource.PortRangeProperty.To http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkaclentry-portrange.html#cfn-ec2-networkaclentry-portrange-to
Type: number or Token
or None
-
- parent (
NetworkAclEntryResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
NetworkAclEntryResourceProps
¶ -
cidrBlock
¶ AWS::EC2::NetworkAclEntry.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-cidrblock
Type: string or Token
-
egress
¶ AWS::EC2::NetworkAclEntry.Egress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-egress
Type: boolean or Token
or None
-
icmp
¶ AWS::EC2::NetworkAclEntry.Icmp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-icmp
Type: Token
orIcmpProperty
or None
-
ipv6CidrBlock
¶ AWS::EC2::NetworkAclEntry.Ipv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-ipv6cidrblock
Type: string or Token
or None
-
networkAclId
¶ AWS::EC2::NetworkAclEntry.NetworkAclId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-networkaclid
Type: string or Token
-
portRange
¶ AWS::EC2::NetworkAclEntry.PortRange http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-portrange
Type: Token
orPortRangeProperty
or None
-
protocol
¶ AWS::EC2::NetworkAclEntry.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-protocol
Type: number or Token
-
ruleAction
¶ AWS::EC2::NetworkAclEntry.RuleAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-ruleaction
Type: string or Token
-
ruleNumber
¶ AWS::EC2::NetworkAclEntry.RuleNumber http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl-entry.html#cfn-ec2-networkaclentry-rulenumber
Type: number or Token
-
NetworkAclResource¶
-
class
_aws-cdk_resources.ec2.
NetworkAclResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NetworkAclResource is a part of - name (string) –
- props (
NetworkAclResourceProps
or None) – the properties of this NetworkAclResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
NetworkAclResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
NetworkAclResourceProps
¶ AWS::EC2::NetworkAcl.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html#cfn-ec2-networkacl-tags
Type: Token
orToken
orTag
or None
-
vpcId
¶ AWS::EC2::NetworkAcl.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-acl.html#cfn-ec2-networkacl-vpcid
Type: string or Token
NetworkInterfaceAttachmentResource¶
-
class
_aws-cdk_resources.ec2.
NetworkInterfaceAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NetworkInterfaceAttachmentResource is a part of - name (string) –
- props (
NetworkInterfaceAttachmentResourceProps
or None) – the properties of this NetworkInterfaceAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
NetworkInterfaceAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
NetworkInterfaceAttachmentResourceProps
¶ -
deleteOnTermination
¶ AWS::EC2::NetworkInterfaceAttachment.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deleteonterm
Type: boolean or Token
or None
-
deviceIndex
¶ AWS::EC2::NetworkInterfaceAttachment.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-deviceindex
Type: string or Token
-
instanceId
¶ AWS::EC2::NetworkInterfaceAttachment.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-instanceid
Type: string or Token
-
networkInterfaceId
¶ AWS::EC2::NetworkInterfaceAttachment.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface-attachment.html#cfn-ec2-network-interface-attachment-networkinterfaceid
Type: string or Token
-
NetworkInterfacePermissionResource¶
-
class
_aws-cdk_resources.ec2.
NetworkInterfacePermissionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NetworkInterfacePermissionResource is a part of - name (string) –
- props (
NetworkInterfacePermissionResourceProps
or None) – the properties of this NetworkInterfacePermissionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
NetworkInterfacePermissionResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
NetworkInterfacePermissionResourceProps
¶ -
awsAccountId
¶ AWS::EC2::NetworkInterfacePermission.AwsAccountId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-awsaccountid
Type: string or Token
-
networkInterfaceId
¶ AWS::EC2::NetworkInterfacePermission.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-networkinterfaceid
Type: string or Token
-
permission
¶ AWS::EC2::NetworkInterfacePermission.Permission http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterfacepermission.html#cfn-ec2-networkinterfacepermission-permission
Type: string or Token
-
NetworkInterfacePrimaryPrivateIpAddress¶
NetworkInterfaceResource¶
-
class
_aws-cdk_resources.ec2.
NetworkInterfaceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this NetworkInterfaceResource is a part of - name (string) –
- props (
NetworkInterfaceResourceProps
or None) – the properties of this NetworkInterfaceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
networkInterfacePrimaryPrivateIpAddress
¶ Type: NetworkInterfacePrimaryPrivateIpAddress
(readonly)
-
networkInterfaceSecondaryPrivateIpAddresses
¶ Type: NetworkInterfaceSecondaryPrivateIpAddresses
(readonly)
-
class
InstanceIpv6AddressProperty
¶ -
ipv6Address
¶ NetworkInterfaceResource.InstanceIpv6AddressProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinterface-instanceipv6address.html#cfn-ec2-networkinterface-instanceipv6address-ipv6address
Type: string or Token
-
-
class
PrivateIpAddressSpecificationProperty
¶ -
primary
¶ NetworkInterfaceResource.PrivateIpAddressSpecificationProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-primary
Type: boolean or Token
-
privateIpAddress
¶ NetworkInterfaceResource.PrivateIpAddressSpecificationProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-network-interface-privateipspec.html#cfn-ec2-networkinterface-privateipspecification-privateipaddress
Type: string or Token
-
- parent (
NetworkInterfaceResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
NetworkInterfaceResourceProps
¶ -
description
¶ AWS::EC2::NetworkInterface.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-description
Type: string or Token
or None
-
groupSet
¶ AWS::EC2::NetworkInterface.GroupSet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-groupset
Type: Token
or string orToken
or None
-
interfaceType
¶ AWS::EC2::NetworkInterface.InterfaceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-interfacetype
Type: string or Token
or None
-
ipv6AddressCount
¶ AWS::EC2::NetworkInterface.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-ipv6addresscount
Type: number or Token
or None
-
ipv6Addresses
¶ AWS::EC2::NetworkInterface.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-ec2-networkinterface-ipv6addresses
Type: Token
orInstanceIpv6AddressProperty
or None
-
privateIpAddress
¶ AWS::EC2::NetworkInterface.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-privateipaddress
Type: string or Token
or None
-
privateIpAddresses
¶ AWS::EC2::NetworkInterface.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-privateipaddresses
Type: Token
orToken
orPrivateIpAddressSpecificationProperty
or None
-
secondaryPrivateIpAddressCount
¶ AWS::EC2::NetworkInterface.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-secondaryprivateipcount
Type: number or Token
or None
-
sourceDestCheck
¶ AWS::EC2::NetworkInterface.SourceDestCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-sourcedestcheck
Type: boolean or Token
or None
-
subnetId
¶ AWS::EC2::NetworkInterface.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-subnetid
Type: string or Token
AWS::EC2::NetworkInterface.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-network-interface.html#cfn-awsec2networkinterface-tags
Type: Token
orToken
orTag
or None
-
NetworkInterfaceSecondaryPrivateIpAddresses¶
PlacementGroupResource¶
-
class
_aws-cdk_resources.ec2.
PlacementGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PlacementGroupResource is a part of - name (string) –
- props (
PlacementGroupResourceProps
or None) – the properties of this PlacementGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
PlacementGroupResourceProps (interface)¶
RouteResource¶
-
class
_aws-cdk_resources.ec2.
RouteResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RouteResource is a part of - name (string) –
- props (
RouteResourceProps
or None) – the properties of this RouteResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
RouteResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
RouteResourceProps
¶ -
destinationCidrBlock
¶ AWS::EC2::Route.DestinationCidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock
Type: string or Token
or None
-
destinationIpv6CidrBlock
¶ AWS::EC2::Route.DestinationIpv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock
Type: string or Token
or None
-
egressOnlyInternetGatewayId
¶ AWS::EC2::Route.EgressOnlyInternetGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid
Type: string or Token
or None
-
gatewayId
¶ AWS::EC2::Route.GatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid
Type: string or Token
or None
-
instanceId
¶ AWS::EC2::Route.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid
Type: string or Token
or None
-
natGatewayId
¶ AWS::EC2::Route.NatGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid
Type: string or Token
or None
-
networkInterfaceId
¶ AWS::EC2::Route.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid
Type: string or Token
or None
-
routeTableId
¶ AWS::EC2::Route.RouteTableId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid
Type: string or Token
-
vpcPeeringConnectionId
¶ AWS::EC2::Route.VpcPeeringConnectionId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid
Type: string or Token
or None
-
RouteTableResource¶
-
class
_aws-cdk_resources.ec2.
RouteTableResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RouteTableResource is a part of - name (string) –
- props (
RouteTableResourceProps
or None) – the properties of this RouteTableResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
RouteTableResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
RouteTableResourceProps
¶ AWS::EC2::RouteTable.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html#cfn-ec2-routetable-tags
Type: Token
orToken
orTag
or None
-
vpcId
¶ AWS::EC2::RouteTable.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route-table.html#cfn-ec2-routetable-vpcid
Type: string or Token
SecurityGroupEgressResource¶
-
class
_aws-cdk_resources.ec2.
SecurityGroupEgressResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SecurityGroupEgressResource is a part of - name (string) –
- props (
SecurityGroupEgressResourceProps
or None) – the properties of this SecurityGroupEgressResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SecurityGroupEgressResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SecurityGroupEgressResourceProps
¶ -
cidrIp
¶ AWS::EC2::SecurityGroupEgress.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidrip
Type: string or Token
or None
-
cidrIpv6
¶ AWS::EC2::SecurityGroupEgress.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-cidripv6
Type: string or Token
or None
-
description
¶ AWS::EC2::SecurityGroupEgress.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-description
Type: string or Token
or None
-
destinationPrefixListId
¶ AWS::EC2::SecurityGroupEgress.DestinationPrefixListId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationprefixlistid
Type: string or Token
or None
-
destinationSecurityGroupId
¶ AWS::EC2::SecurityGroupEgress.DestinationSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid
Type: string or Token
or None
-
fromPort
¶ AWS::EC2::SecurityGroupEgress.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-fromport
Type: number or Token
or None
-
groupId
¶ AWS::EC2::SecurityGroupEgress.GroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-groupid
Type: string or Token
-
ipProtocol
¶ AWS::EC2::SecurityGroupEgress.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-ipprotocol
Type: string or Token
-
toPort
¶ AWS::EC2::SecurityGroupEgress.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-security-group-egress.html#cfn-ec2-securitygroupegress-toport
Type: number or Token
or None
-
SecurityGroupId¶
SecurityGroupIngressResource¶
-
class
_aws-cdk_resources.ec2.
SecurityGroupIngressResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SecurityGroupIngressResource is a part of - name (string) –
- props (
SecurityGroupIngressResourceProps
or None) – the properties of this SecurityGroupIngressResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SecurityGroupIngressResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SecurityGroupIngressResourceProps
¶ -
cidrIp
¶ AWS::EC2::SecurityGroupIngress.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidrip
Type: string or Token
or None
-
cidrIpv6
¶ AWS::EC2::SecurityGroupIngress.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-cidripv6
Type: string or Token
or None
-
description
¶ AWS::EC2::SecurityGroupIngress.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-description
Type: string or Token
or None
-
fromPort
¶ AWS::EC2::SecurityGroupIngress.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-fromport
Type: number or Token
or None
-
groupId
¶ AWS::EC2::SecurityGroupIngress.GroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupid
Type: string or Token
or None
-
groupName
¶ AWS::EC2::SecurityGroupIngress.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-groupname
Type: string or Token
or None
-
ipProtocol
¶ AWS::EC2::SecurityGroupIngress.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-ipprotocol
Type: string or Token
-
sourceSecurityGroupId
¶ AWS::EC2::SecurityGroupIngress.SourceSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupid
Type: string or Token
or None
-
sourceSecurityGroupName
¶ AWS::EC2::SecurityGroupIngress.SourceSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupname
Type: string or Token
or None
-
sourceSecurityGroupOwnerId
¶ AWS::EC2::SecurityGroupIngress.SourceSecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-sourcesecuritygroupownerid
Type: string or Token
or None
-
toPort
¶ AWS::EC2::SecurityGroupIngress.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-ingress.html#cfn-ec2-security-group-ingress-toport
Type: number or Token
or None
-
SecurityGroupResource¶
-
class
_aws-cdk_resources.ec2.
SecurityGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SecurityGroupResource is a part of - name (string) –
- props (
SecurityGroupResourceProps
or None) – the properties of this SecurityGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
securityGroupId
¶ Type: SecurityGroupId
(readonly)
-
securityGroupVpcId
¶ Type: SecurityGroupVpcId
(readonly)
-
class
EgressProperty
¶ -
cidrIp
¶ SecurityGroupResource.EgressProperty.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip
Type: string or Token
or None
-
cidrIpv6
¶ SecurityGroupResource.EgressProperty.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6
Type: string or Token
or None
-
description
¶ SecurityGroupResource.EgressProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description
Type: string or Token
or None
-
destinationPrefixListId
¶ SecurityGroupResource.EgressProperty.DestinationPrefixListId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destinationprefixlistid
Type: string or Token
or None
-
destinationSecurityGroupId
¶ SecurityGroupResource.EgressProperty.DestinationSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-destsecgroupid
Type: string or Token
or None
-
fromPort
¶ SecurityGroupResource.EgressProperty.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport
Type: number or Token
or None
-
ipProtocol
¶ SecurityGroupResource.EgressProperty.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol
Type: string or Token
-
toPort
¶ SecurityGroupResource.EgressProperty.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport
Type: number or Token
or None
-
-
class
IngressProperty
¶ -
cidrIp
¶ SecurityGroupResource.IngressProperty.CidrIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidrip
Type: string or Token
or None
-
cidrIpv6
¶ SecurityGroupResource.IngressProperty.CidrIpv6 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-cidripv6
Type: string or Token
or None
-
description
¶ SecurityGroupResource.IngressProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-description
Type: string or Token
or None
-
fromPort
¶ SecurityGroupResource.IngressProperty.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-fromport
Type: number or Token
or None
-
ipProtocol
¶ SecurityGroupResource.IngressProperty.IpProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-ipprotocol
Type: string or Token
-
sourceSecurityGroupId
¶ SecurityGroupResource.IngressProperty.SourceSecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupid
Type: string or Token
or None
-
sourceSecurityGroupName
¶ SecurityGroupResource.IngressProperty.SourceSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupname
Type: string or Token
or None
-
sourceSecurityGroupOwnerId
¶ SecurityGroupResource.IngressProperty.SourceSecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupownerid
Type: string or Token
or None
-
toPort
¶ SecurityGroupResource.IngressProperty.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-toport
Type: number or Token
or None
-
- parent (
SecurityGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SecurityGroupResourceProps
¶ -
groupDescription
¶ AWS::EC2::SecurityGroup.GroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupdescription
Type: string or Token
-
groupName
¶ AWS::EC2::SecurityGroup.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-groupname
Type: string or Token
or None
-
securityGroupEgress
¶ AWS::EC2::SecurityGroup.SecurityGroupEgress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupegress
Type: Token
orToken
orEgressProperty
or None
-
securityGroupIngress
¶ AWS::EC2::SecurityGroup.SecurityGroupIngress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-securitygroupingress
Type: Token
orToken
orIngressProperty
or None
AWS::EC2::SecurityGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-tags
Type: Token
orToken
orTag
or None
-
vpcId
¶ AWS::EC2::SecurityGroup.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html#cfn-ec2-securitygroup-vpcid
Type: string or Token
or None
-
SecurityGroupVpcId¶
SpotFleetResource¶
-
class
_aws-cdk_resources.ec2.
SpotFleetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SpotFleetResource is a part of - name (string) –
- props (
SpotFleetResourceProps
or None) – the properties of this SpotFleetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
BlockDeviceMappingProperty
¶ -
deviceName
¶ SpotFleetResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-devicename
Type: string or Token
-
ebs
¶ SpotFleetResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-ebs
Type: Token
orEbsBlockDeviceProperty
or None
-
noDevice
¶ SpotFleetResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-nodevice
Type: string or Token
or None
-
virtualName
¶ SpotFleetResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings.html#cfn-ec2-spotfleet-blockdevicemapping-virtualname
Type: string or Token
or None
-
-
class
EbsBlockDeviceProperty
¶ -
deleteOnTermination
¶ SpotFleetResource.EbsBlockDeviceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-deleteontermination
Type: boolean or Token
or None
-
encrypted
¶ SpotFleetResource.EbsBlockDeviceProperty.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-encrypted
Type: boolean or Token
or None
-
iops
¶ SpotFleetResource.EbsBlockDeviceProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-iops
Type: number or Token
or None
-
snapshotId
¶ SpotFleetResource.EbsBlockDeviceProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-snapshotid
Type: string or Token
or None
-
volumeSize
¶ SpotFleetResource.EbsBlockDeviceProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumesize
Type: number or Token
or None
-
volumeType
¶ SpotFleetResource.EbsBlockDeviceProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-blockdevicemappings-ebs.html#cfn-ec2-spotfleet-ebsblockdevice-volumetype
Type: string or Token
or None
-
-
class
GroupIdentifierProperty
¶ -
groupId
¶ SpotFleetResource.GroupIdentifierProperty.GroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-securitygroups.html#cfn-ec2-spotfleet-groupidentifier-groupid
Type: string or Token
-
-
class
IamInstanceProfileSpecificationProperty
¶ -
arn
¶ SpotFleetResource.IamInstanceProfileSpecificationProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-iaminstanceprofile.html#cfn-ec2-spotfleet-iaminstanceprofilespecification-arn
Type: string or Token
or None
-
-
class
InstanceIpv6AddressProperty
¶ -
ipv6Address
¶ SpotFleetResource.InstanceIpv6AddressProperty.Ipv6Address http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instanceipv6address.html#cfn-ec2-spotfleet-instanceipv6address-ipv6address
Type: string or Token
-
-
class
InstanceNetworkInterfaceSpecificationProperty
¶ -
associatePublicIpAddress
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.AssociatePublicIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-associatepublicipaddress
Type: boolean or Token
or None
-
deleteOnTermination
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deleteontermination
Type: boolean or Token
or None
-
description
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-description
Type: string or Token
or None
-
deviceIndex
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.DeviceIndex http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-deviceindex
Type: number or Token
or None
-
groups
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-groups
Type: Token
or string orToken
or None
-
ipv6AddressCount
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Ipv6AddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresscount
Type: number or Token
or None
-
ipv6Addresses
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.Ipv6Addresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-ipv6addresses
Type: Token
orToken
orInstanceIpv6AddressProperty
or None
-
networkInterfaceId
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.NetworkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-networkinterfaceid
Type: string or Token
or None
-
privateIpAddresses
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.PrivateIpAddresses http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-privateipaddresses
Type: Token
orToken
orPrivateIpAddressSpecificationProperty
or None
-
secondaryPrivateIpAddressCount
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.SecondaryPrivateIpAddressCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-secondaryprivateipaddresscount
Type: number or Token
or None
-
subnetId
¶ SpotFleetResource.InstanceNetworkInterfaceSpecificationProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces.html#cfn-ec2-spotfleet-instancenetworkinterfacespecification-subnetid
Type: string or Token
or None
-
-
class
PrivateIpAddressSpecificationProperty
¶ -
primary
¶ SpotFleetResource.PrivateIpAddressSpecificationProperty.Primary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html#cfn-ec2-spotfleet-privateipaddressspecification-primary
Type: boolean or Token
or None
-
privateIpAddress
¶ SpotFleetResource.PrivateIpAddressSpecificationProperty.PrivateIpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-networkinterfaces-privateipaddresses.html#cfn-ec2-spotfleet-privateipaddressspecification-privateipaddress
Type: string or Token
-
-
class
SpotFleetLaunchSpecificationProperty
¶ -
blockDeviceMappings
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-blockdevicemappings
Type: Token
orToken
orBlockDeviceMappingProperty
or None
-
ebsOptimized
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ebsoptimized
Type: boolean or Token
or None
-
iamInstanceProfile
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.IamInstanceProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-iaminstanceprofile
Type: Token
orIamInstanceProfileSpecificationProperty
or None
-
imageId
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.ImageId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-imageid
Type: string or Token
-
instanceType
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-instancetype
Type: string or Token
-
kernelId
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.KernelId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-kernelid
Type: string or Token
or None
-
keyName
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-keyname
Type: string or Token
or None
-
monitoring
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.Monitoring http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-monitoring
Type: Token
orSpotFleetMonitoringProperty
or None
-
networkInterfaces
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.NetworkInterfaces http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-networkinterfaces
Type: Token
orToken
orInstanceNetworkInterfaceSpecificationProperty
or None
-
placement
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.Placement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-placement
Type: Token
orSpotPlacementProperty
or None
-
ramdiskId
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.RamdiskId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-ramdiskid
Type: string or Token
or None
-
securityGroups
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-securitygroups
Type: Token
orToken
orGroupIdentifierProperty
or None
-
spotPrice
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.SpotPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-spotprice
Type: string or Token
or None
-
subnetId
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-subnetid
Type: string or Token
or None
-
tagSpecifications
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.TagSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-tagspecifications
Type: Token
orToken
orSpotFleetTagSpecificationProperty
or None
-
userData
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.UserData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-userdata
Type: string or Token
or None
-
weightedCapacity
¶ SpotFleetResource.SpotFleetLaunchSpecificationProperty.WeightedCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications.html#cfn-ec2-spotfleet-spotfleetlaunchspecification-weightedcapacity
Type: number or Token
or None
-
-
class
SpotFleetMonitoringProperty
¶ -
enabled
¶ SpotFleetResource.SpotFleetMonitoringProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-monitoring.html#cfn-ec2-spotfleet-spotfleetmonitoring-enabled
Type: boolean or Token
or None
-
-
class
SpotFleetRequestConfigDataProperty
¶ -
allocationStrategy
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.AllocationStrategy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-allocationstrategy
Type: string or Token
or None
-
excessCapacityTerminationPolicy
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ExcessCapacityTerminationPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-excesscapacityterminationpolicy
Type: string or Token
or None
-
iamFleetRole
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.IamFleetRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-iamfleetrole
Type: string or Token
-
launchSpecifications
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.LaunchSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications
Type: Token
orToken
orSpotFleetLaunchSpecificationProperty
or None
-
replaceUnhealthyInstances
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ReplaceUnhealthyInstances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-replaceunhealthyinstances
Type: boolean or Token
or None
-
spotPrice
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.SpotPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-spotprice
Type: string or Token
or None
-
targetCapacity
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.TargetCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-targetcapacity
Type: number or Token
-
terminateInstancesWithExpiration
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.TerminateInstancesWithExpiration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-terminateinstanceswithexpiration
Type: boolean or Token
or None
-
type
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-type
Type: string or Token
or None
-
validFrom
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ValidFrom http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validfrom
Type: string or Token
or None
-
validUntil
¶ SpotFleetResource.SpotFleetRequestConfigDataProperty.ValidUntil http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata-validuntil
Type: string or Token
or None
-
-
class
SpotFleetTagSpecificationProperty
¶ -
resourceType
¶ SpotFleetResource.SpotFleetTagSpecificationProperty.ResourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-tagspecifications.html#cfn-ec2-spotfleet-spotfleettagspecification-resourcetype
Type: string or Token
or None
-
-
class
SpotPlacementProperty
¶ -
availabilityZone
¶ SpotFleetResource.SpotPlacementProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-availabilityzone
Type: string or Token
or None
-
groupName
¶ SpotFleetResource.SpotPlacementProperty.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetrequestconfigdata-launchspecifications-placement.html#cfn-ec2-spotfleet-spotplacement-groupname
Type: string or Token
or None
-
- parent (
SpotFleetResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SpotFleetResourceProps
¶ -
spotFleetRequestConfigData
¶ AWS::EC2::SpotFleet.SpotFleetRequestConfigData http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-spotfleet.html#cfn-ec2-spotfleet-spotfleetrequestconfigdata
Type: Token
orSpotFleetRequestConfigDataProperty
-
SubnetAvailabilityZone¶
SubnetCidrBlockResource¶
-
class
_aws-cdk_resources.ec2.
SubnetCidrBlockResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubnetCidrBlockResource is a part of - name (string) –
- props (
SubnetCidrBlockResourceProps
or None) – the properties of this SubnetCidrBlockResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SubnetCidrBlockResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SubnetCidrBlockResourceProps
¶ -
ipv6CidrBlock
¶ AWS::EC2::SubnetCidrBlock.Ipv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-ipv6cidrblock
Type: string or Token
-
subnetId
¶ AWS::EC2::SubnetCidrBlock.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnetcidrblock.html#cfn-ec2-subnetcidrblock-subnetid
Type: string or Token
-
SubnetIpv6CidrBlocks¶
SubnetNetworkAclAssociationAssociationId¶
SubnetNetworkAclAssociationId¶
SubnetNetworkAclAssociationResource¶
-
class
_aws-cdk_resources.ec2.
SubnetNetworkAclAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubnetNetworkAclAssociationResource is a part of - name (string) –
- props (
SubnetNetworkAclAssociationResourceProps
or None) – the properties of this SubnetNetworkAclAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
subnetNetworkAclAssociationAssociationId
¶ Type: SubnetNetworkAclAssociationAssociationId
(readonly)
- parent (
SubnetNetworkAclAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SubnetNetworkAclAssociationResourceProps
¶ -
networkAclId
¶ AWS::EC2::SubnetNetworkAclAssociation.NetworkAclId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-networkaclid
Type: string or Token
-
subnetId
¶ AWS::EC2::SubnetNetworkAclAssociation.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-network-acl-assoc.html#cfn-ec2-subnetnetworkaclassociation-associationid
Type: string or Token
-
SubnetResource¶
-
class
_aws-cdk_resources.ec2.
SubnetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubnetResource is a part of - name (string) –
- props (
SubnetResourceProps
or None) – the properties of this SubnetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
subnetAvailabilityZone
¶ Type: SubnetAvailabilityZone
(readonly)
-
subnetIpv6CidrBlocks
¶ Type: SubnetIpv6CidrBlocks
(readonly)
-
subnetNetworkAclAssociationId
¶ Type: SubnetNetworkAclAssociationId
(readonly)
-
subnetVpcId
¶ Type: SubnetVpcId
(readonly)
- parent (
SubnetResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SubnetResourceProps
¶ -
assignIpv6AddressOnCreation
¶ AWS::EC2::Subnet.AssignIpv6AddressOnCreation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-assignipv6addressoncreation
Type: boolean or Token
or None
-
availabilityZone
¶ AWS::EC2::Subnet.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-availabilityzone
Type: string or Token
or None
-
cidrBlock
¶ AWS::EC2::Subnet.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-cidrblock
Type: string or Token
-
ipv6CidrBlock
¶ AWS::EC2::Subnet.Ipv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-ipv6cidrblock
Type: string or Token
or None
-
mapPublicIpOnLaunch
¶ AWS::EC2::Subnet.MapPublicIpOnLaunch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-mappubliciponlaunch
Type: boolean or Token
or None
AWS::EC2::Subnet.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-ec2-subnet-tags
Type: Token
orToken
orTag
or None
-
vpcId
¶ AWS::EC2::Subnet.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html#cfn-awsec2subnet-prop-vpcid
Type: string or Token
-
SubnetRouteTableAssociationResource¶
-
class
_aws-cdk_resources.ec2.
SubnetRouteTableAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubnetRouteTableAssociationResource is a part of - name (string) –
- props (
SubnetRouteTableAssociationResourceProps
or None) – the properties of this SubnetRouteTableAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SubnetRouteTableAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
SubnetRouteTableAssociationResourceProps
¶ -
routeTableId
¶ AWS::EC2::SubnetRouteTableAssociation.RouteTableId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html#cfn-ec2-subnetroutetableassociation-routetableid
Type: string or Token
-
subnetId
¶ AWS::EC2::SubnetRouteTableAssociation.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet-route-table-assoc.html#cfn-ec2-subnetroutetableassociation-subnetid
Type: string or Token
-
SubnetVpcId¶
TrunkInterfaceAssociationResource¶
-
class
_aws-cdk_resources.ec2.
TrunkInterfaceAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TrunkInterfaceAssociationResource is a part of - name (string) –
- props (
TrunkInterfaceAssociationResourceProps
or None) – the properties of this TrunkInterfaceAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
TrunkInterfaceAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
TrunkInterfaceAssociationResourceProps
¶ -
branchInterfaceId
¶ AWS::EC2::TrunkInterfaceAssociation.BranchInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-branchinterfaceid
Type: string or Token
-
greKey
¶ AWS::EC2::TrunkInterfaceAssociation.GREKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-grekey
Type: number or Token
or None
-
trunkInterfaceId
¶ AWS::EC2::TrunkInterfaceAssociation.TrunkInterfaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-trunkinterfaceid
Type: string or Token
-
vlanId
¶ AWS::EC2::TrunkInterfaceAssociation.VLANId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trunkinterfaceassociation.html#cfn-ec2-trunkinterfaceassociation-vlanid
Type: number or Token
or None
-
VPCCidrBlock¶
VPCCidrBlockAssociations¶
VPCCidrBlockResource¶
-
class
_aws-cdk_resources.ec2.
VPCCidrBlockResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPCCidrBlockResource is a part of - name (string) –
- props (
VPCCidrBlockResourceProps
or None) – the properties of this VPCCidrBlockResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPCCidrBlockResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPCCidrBlockResourceProps
¶ -
amazonProvidedIpv6CidrBlock
¶ AWS::EC2::VPCCidrBlock.AmazonProvidedIpv6CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-amazonprovidedipv6cidrblock
Type: boolean or Token
or None
-
cidrBlock
¶ AWS::EC2::VPCCidrBlock.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-cidrblock
Type: string or Token
or None
-
vpcId
¶ AWS::EC2::VPCCidrBlock.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html#cfn-ec2-vpccidrblock-vpcid
Type: string or Token
-
VPCDHCPOptionsAssociationResource¶
-
class
_aws-cdk_resources.ec2.
VPCDHCPOptionsAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPCDHCPOptionsAssociationResource is a part of - name (string) –
- props (
VPCDHCPOptionsAssociationResourceProps
or None) – the properties of this VPCDHCPOptionsAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPCDHCPOptionsAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPCDHCPOptionsAssociationResourceProps
¶ -
dhcpOptionsId
¶ AWS::EC2::VPCDHCPOptionsAssociation.DhcpOptionsId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html#cfn-ec2-vpcdhcpoptionsassociation-dhcpoptionsid
Type: string or Token
-
vpcId
¶ AWS::EC2::VPCDHCPOptionsAssociation.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-dhcp-options-assoc.html#cfn-ec2-vpcdhcpoptionsassociation-vpcid
Type: string or Token
-
VPCDefaultNetworkAcl¶
VPCDefaultSecurityGroup¶
VPCEndpointResource¶
-
class
_aws-cdk_resources.ec2.
VPCEndpointResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPCEndpointResource is a part of - name (string) –
- props (
VPCEndpointResourceProps
or None) – the properties of this VPCEndpointResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPCEndpointResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPCEndpointResourceProps
¶ -
policyDocument
¶ AWS::EC2::VPCEndpoint.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument
Type: json or Token
or None
-
routeTableIds
¶ AWS::EC2::VPCEndpoint.RouteTableIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids
Type: Token
or string orToken
or None
-
serviceName
¶ AWS::EC2::VPCEndpoint.ServiceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename
Type: string or Token
-
vpcId
¶ AWS::EC2::VPCEndpoint.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid
Type: string or Token
-
VPCGatewayAttachmentResource¶
-
class
_aws-cdk_resources.ec2.
VPCGatewayAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPCGatewayAttachmentResource is a part of - name (string) –
- props (
VPCGatewayAttachmentResourceProps
or None) – the properties of this VPCGatewayAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPCGatewayAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPCGatewayAttachmentResourceProps
¶ -
internetGatewayId
¶ AWS::EC2::VPCGatewayAttachment.InternetGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-internetgatewayid
Type: string or Token
or None
-
vpcId
¶ AWS::EC2::VPCGatewayAttachment.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpcid
Type: string or Token
-
vpnGatewayId
¶ AWS::EC2::VPCGatewayAttachment.VpnGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html#cfn-ec2-vpcgatewayattachment-vpngatewayid
Type: string or Token
or None
-
VPCIpv6CidrBlocks¶
VPCPeeringConnectionResource¶
-
class
_aws-cdk_resources.ec2.
VPCPeeringConnectionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPCPeeringConnectionResource is a part of - name (string) –
- props (
VPCPeeringConnectionResourceProps
or None) – the properties of this VPCPeeringConnectionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPCPeeringConnectionResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPCPeeringConnectionResourceProps
¶ -
peerOwnerId
¶ AWS::EC2::VPCPeeringConnection.PeerOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerownerid
Type: string or Token
or None
-
peerRoleArn
¶ AWS::EC2::VPCPeeringConnection.PeerRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peerrolearn
Type: string or Token
or None
-
peerVpcId
¶ AWS::EC2::VPCPeeringConnection.PeerVpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-peervpcid
Type: string or Token
AWS::EC2::VPCPeeringConnection.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-tags
Type: Token
orToken
orTag
or None
-
vpcId
¶ AWS::EC2::VPCPeeringConnection.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcpeeringconnection.html#cfn-ec2-vpcpeeringconnection-vpcid
Type: string or Token
-
VPCResource¶
-
class
_aws-cdk_resources.ec2.
VPCResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPCResource is a part of - name (string) –
- props (
VPCResourceProps
or None) – the properties of this VPCResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
vpcCidrBlock
¶ Type: VPCCidrBlock
(readonly)
-
vpcCidrBlockAssociations
¶ Type: VPCCidrBlockAssociations
(readonly)
-
vpcDefaultNetworkAcl
¶ Type: VPCDefaultNetworkAcl
(readonly)
-
vpcDefaultSecurityGroup
¶ Type: VPCDefaultSecurityGroup
(readonly)
-
vpcIpv6CidrBlocks
¶ Type: VPCIpv6CidrBlocks
(readonly)
- parent (
VPCResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPCResourceProps
¶ -
cidrBlock
¶ AWS::EC2::VPC.CidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-cidrblock
Type: string or Token
-
enableDnsHostnames
¶ AWS::EC2::VPC.EnableDnsHostnames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsHostnames
Type: boolean or Token
or None
-
enableDnsSupport
¶ AWS::EC2::VPC.EnableDnsSupport http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-EnableDnsSupport
Type: boolean or Token
or None
-
instanceTenancy
¶ AWS::EC2::VPC.InstanceTenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-instancetenancy
Type: string or Token
or None
AWS::EC2::VPC.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-aws-ec2-vpc-tags
Type: Token
orToken
orTag
or None
-
VPNConnectionResource¶
-
class
_aws-cdk_resources.ec2.
VPNConnectionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPNConnectionResource is a part of - name (string) –
- props (
VPNConnectionResourceProps
or None) – the properties of this VPNConnectionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
VpnTunnelOptionsSpecificationProperty
¶ VPNConnectionResource.VpnTunnelOptionsSpecificationProperty.PreSharedKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-presharedkey
Type: string or Token
or None
-
tunnelInsideCidr
¶ VPNConnectionResource.VpnTunnelOptionsSpecificationProperty.TunnelInsideCidr http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html#cfn-ec2-vpnconnection-vpntunneloptionsspecification-tunnelinsidecidr
Type: string or Token
or None
- parent (
VPNConnectionResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPNConnectionResourceProps
¶ -
customerGatewayId
¶ AWS::EC2::VPNConnection.CustomerGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-customergatewayid
Type: string or Token
-
staticRoutesOnly
¶ AWS::EC2::VPNConnection.StaticRoutesOnly http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-StaticRoutesOnly
Type: boolean or Token
or None
AWS::EC2::VPNConnection.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-tags
Type: Token
orToken
orTag
or None
-
type
¶ AWS::EC2::VPNConnection.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-type
Type: string or Token
-
vpnGatewayId
¶ AWS::EC2::VPNConnection.VpnGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpngatewayid
Type: string or Token
-
vpnTunnelOptionsSpecifications
¶ AWS::EC2::VPNConnection.VpnTunnelOptionsSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection.html#cfn-ec2-vpnconnection-vpntunneloptionsspecifications
Type: Token
orToken
orVpnTunnelOptionsSpecificationProperty
or None
-
VPNConnectionRouteResource¶
-
class
_aws-cdk_resources.ec2.
VPNConnectionRouteResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPNConnectionRouteResource is a part of - name (string) –
- props (
VPNConnectionRouteResourceProps
or None) – the properties of this VPNConnectionRouteResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPNConnectionRouteResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPNConnectionRouteResourceProps
¶ -
destinationCidrBlock
¶ AWS::EC2::VPNConnectionRoute.DestinationCidrBlock http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html#cfn-ec2-vpnconnectionroute-cidrblock
Type: string or Token
-
vpnConnectionId
¶ AWS::EC2::VPNConnectionRoute.VpnConnectionId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-connection-route.html#cfn-ec2-vpnconnectionroute-connectionid
Type: string or Token
-
VPNGatewayResource¶
-
class
_aws-cdk_resources.ec2.
VPNGatewayResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPNGatewayResource is a part of - name (string) –
- props (
VPNGatewayResourceProps
or None) – the properties of this VPNGatewayResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPNGatewayResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPNGatewayResourceProps
¶ -
amazonSideAsn
¶ AWS::EC2::VPNGateway.AmazonSideAsn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-amazonsideasn
Type: number or Token
or None
AWS::EC2::VPNGateway.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-tags
Type: Token
orToken
orTag
or None
-
type
¶ AWS::EC2::VPNGateway.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gateway.html#cfn-ec2-vpngateway-type
Type: string or Token
-
VPNGatewayRoutePropagationResource¶
-
class
_aws-cdk_resources.ec2.
VPNGatewayRoutePropagationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VPNGatewayRoutePropagationResource is a part of - name (string) –
- props (
VPNGatewayRoutePropagationResourceProps
or None) – the properties of this VPNGatewayRoutePropagationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VPNGatewayRoutePropagationResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VPNGatewayRoutePropagationResourceProps
¶ -
routeTableIds
¶ AWS::EC2::VPNGatewayRoutePropagation.RouteTableIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html#cfn-ec2-vpngatewayrouteprop-routetableids
Type: Token
or string orToken
-
vpnGatewayId
¶ AWS::EC2::VPNGatewayRoutePropagation.VpnGatewayId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpn-gatewayrouteprop.html#cfn-ec2-vpngatewayrouteprop-vpngatewayid
Type: string or Token
-
VolumeAttachmentResource¶
-
class
_aws-cdk_resources.ec2.
VolumeAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VolumeAttachmentResource is a part of - name (string) –
- props (
VolumeAttachmentResourceProps
or None) – the properties of this VolumeAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VolumeAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VolumeAttachmentResourceProps
¶ -
device
¶ AWS::EC2::VolumeAttachment.Device http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-device
Type: string or Token
-
instanceId
¶ AWS::EC2::VolumeAttachment.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-instanceid
Type: string or Token
-
volumeId
¶ AWS::EC2::VolumeAttachment.VolumeId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volumeattachment.html#cfn-ec2-ebs-volumeattachment-volumeid
Type: string or Token
-
VolumeResource¶
-
class
_aws-cdk_resources.ec2.
VolumeResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VolumeResource is a part of - name (string) –
- props (
VolumeResourceProps
or None) – the properties of this VolumeResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VolumeResourceProps (interface)¶
-
class
_aws-cdk_resources.ec2.
VolumeResourceProps
¶ -
autoEnableIo
¶ AWS::EC2::Volume.AutoEnableIO http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-autoenableio
Type: boolean or Token
or None
-
availabilityZone
¶ AWS::EC2::Volume.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-availabilityzone
Type: string or Token
-
encrypted
¶ AWS::EC2::Volume.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-encrypted
Type: boolean or Token
or None
-
iops
¶ AWS::EC2::Volume.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-iops
Type: number or Token
or None
-
kmsKeyId
¶ AWS::EC2::Volume.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-kmskeyid
Type: string or Token
or None
-
size
¶ AWS::EC2::Volume.Size http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-size
Type: number or Token
or None
-
snapshotId
¶ AWS::EC2::Volume.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-snapshotid
Type: string or Token
or None
AWS::EC2::Volume.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-tags
Type: Token
orToken
orTag
or None
-
volumeType
¶ AWS::EC2::Volume.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html#cfn-ec2-ebs-volume-volumetype
Type: string or Token
or None
-
ecr¶
RepositoryArn¶
RepositoryResource¶
-
class
_aws-cdk_resources.ecr.
RepositoryResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RepositoryResource is a part of - name (string) –
- props (
RepositoryResourceProps
or None) – the properties of this RepositoryResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
repositoryArn
¶ Type: RepositoryArn
(readonly)
-
class
LifecyclePolicyProperty
¶ -
lifecyclePolicyText
¶ RepositoryResource.LifecyclePolicyProperty.LifecyclePolicyText http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext
Type: string or Token
or None
-
registryId
¶ RepositoryResource.LifecyclePolicyProperty.RegistryId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid
Type: string or Token
or None
-
- parent (
RepositoryResourceProps (interface)¶
-
class
_aws-cdk_resources.ecr.
RepositoryResourceProps
¶ -
lifecyclePolicy
¶ AWS::ECR::Repository.LifecyclePolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy
Type: Token
orLifecyclePolicyProperty
or None
-
repositoryName
¶ AWS::ECR::Repository.RepositoryName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname
Type: string or Token
or None
-
repositoryPolicyText
¶ AWS::ECR::Repository.RepositoryPolicyText http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext
Type: json or Token
or None
-
ecs¶
ClusterArn¶
ClusterResource¶
-
class
_aws-cdk_resources.ecs.
ClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterResource is a part of - name (string) –
- props (
ClusterResourceProps
or None) – the properties of this ClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
clusterArn
¶ Type: ClusterArn
(readonly)
- parent (
ClusterResourceProps (interface)¶
ServiceName¶
ServiceResource¶
-
class
_aws-cdk_resources.ecs.
ServiceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ServiceResource is a part of - name (string) –
- props (
ServiceResourceProps
or None) – the properties of this ServiceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
serviceName
¶ Type: ServiceName
(readonly)
-
class
AwsVpcConfigurationProperty
¶ -
assignPublicIp
¶ ServiceResource.AwsVpcConfigurationProperty.AssignPublicIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-assignpublicip
Type: string or Token
or None
-
securityGroups
¶ ServiceResource.AwsVpcConfigurationProperty.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-securitygroups
Type: Token
or string orToken
or None
-
subnets
¶ ServiceResource.AwsVpcConfigurationProperty.Subnets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html#cfn-ecs-service-awsvpcconfiguration-subnets
Type: Token
or string orToken
-
-
class
DeploymentConfigurationProperty
¶ -
maximumPercent
¶ ServiceResource.DeploymentConfigurationProperty.MaximumPercent http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-maximumpercent
Type: number or Token
or None
-
minimumHealthyPercent
¶ ServiceResource.DeploymentConfigurationProperty.MinimumHealthyPercent http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html#cfn-ecs-service-deploymentconfiguration-minimumhealthypercent
Type: number or Token
or None
-
-
class
LoadBalancerProperty
¶ -
containerName
¶ ServiceResource.LoadBalancerProperty.ContainerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-containername
Type: string or Token
or None
-
containerPort
¶ ServiceResource.LoadBalancerProperty.ContainerPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-containerport
Type: number or Token
-
loadBalancerName
¶ ServiceResource.LoadBalancerProperty.LoadBalancerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-loadbalancername
Type: string or Token
or None
-
targetGroupArn
¶ ServiceResource.LoadBalancerProperty.TargetGroupArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancers.html#cfn-ecs-service-loadbalancers-targetgrouparn
Type: string or Token
or None
-
-
class
NetworkConfigurationProperty
¶ -
awsvpcConfiguration
¶ ServiceResource.NetworkConfigurationProperty.AwsvpcConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html#cfn-ecs-service-networkconfiguration-awsvpcconfiguration
Type: Token
orAwsVpcConfigurationProperty
or None
-
-
class
PlacementConstraintProperty
¶ -
expression
¶ ServiceResource.PlacementConstraintProperty.Expression http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-expression
Type: string or Token
or None
-
type
¶ ServiceResource.PlacementConstraintProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html#cfn-ecs-service-placementconstraint-type
Type: string or Token
-
-
class
PlacementStrategyProperty
¶ -
field
¶ ServiceResource.PlacementStrategyProperty.Field http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-field
Type: string or Token
or None
-
type
¶ ServiceResource.PlacementStrategyProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html#cfn-ecs-service-placementstrategy-type
Type: string or Token
-
-
class
ServiceRegistryProperty
¶ -
port
¶ ServiceResource.ServiceRegistryProperty.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-port
Type: number or Token
or None
-
registryArn
¶ ServiceResource.ServiceRegistryProperty.RegistryArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html#cfn-ecs-service-serviceregistry-registryarn
Type: string or Token
or None
-
- parent (
ServiceResourceProps (interface)¶
-
class
_aws-cdk_resources.ecs.
ServiceResourceProps
¶ -
cluster
¶ AWS::ECS::Service.Cluster http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster
Type: string or Token
or None
-
deploymentConfiguration
¶ AWS::ECS::Service.DeploymentConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration
Type: Token
orDeploymentConfigurationProperty
or None
-
desiredCount
¶ AWS::ECS::Service.DesiredCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount
Type: number or Token
or None
-
healthCheckGracePeriodSeconds
¶ AWS::ECS::Service.HealthCheckGracePeriodSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds
Type: number or Token
or None
-
launchType
¶ AWS::ECS::Service.LaunchType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype
Type: string or Token
or None
-
loadBalancers
¶ AWS::ECS::Service.LoadBalancers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers
Type: Token
orToken
orLoadBalancerProperty
or None
-
networkConfiguration
¶ AWS::ECS::Service.NetworkConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration
Type: Token
orNetworkConfigurationProperty
or None
-
placementConstraints
¶ AWS::ECS::Service.PlacementConstraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints
Type: Token
orToken
orPlacementConstraintProperty
or None
-
placementStrategies
¶ AWS::ECS::Service.PlacementStrategies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies
Type: Token
orToken
orPlacementStrategyProperty
or None
-
platformVersion
¶ AWS::ECS::Service.PlatformVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion
Type: string or Token
or None
-
role
¶ AWS::ECS::Service.Role http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role
Type: string or Token
or None
-
serviceName
¶ AWS::ECS::Service.ServiceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename
Type: string or Token
or None
-
serviceRegistries
¶ AWS::ECS::Service.ServiceRegistries http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries
Type: Token
orToken
orServiceRegistryProperty
or None
-
taskDefinition
¶ AWS::ECS::Service.TaskDefinition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition
Type: string or Token
-
TaskDefinitionResource¶
-
class
_aws-cdk_resources.ecs.
TaskDefinitionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TaskDefinitionResource is a part of - name (string) –
- props (
TaskDefinitionResourceProps
or None) – the properties of this TaskDefinitionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ContainerDefinitionProperty
¶ -
command
¶ TaskDefinitionResource.ContainerDefinitionProperty.Command http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-command
Type: Token
or string orToken
or None
-
cpu
¶ TaskDefinitionResource.ContainerDefinitionProperty.Cpu http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-cpu
Type: number or Token
or None
-
disableNetworking
¶ TaskDefinitionResource.ContainerDefinitionProperty.DisableNetworking http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-disablenetworking
Type: boolean or Token
or None
-
dnsSearchDomains
¶ TaskDefinitionResource.ContainerDefinitionProperty.DnsSearchDomains http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnssearchdomains
Type: Token
or string orToken
or None
-
dnsServers
¶ TaskDefinitionResource.ContainerDefinitionProperty.DnsServers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dnsservers
Type: Token
or string orToken
or None
-
dockerLabels
¶ TaskDefinitionResource.ContainerDefinitionProperty.DockerLabels http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockerlabels
Type: Token
or string orToken
or None
-
dockerSecurityOptions
¶ TaskDefinitionResource.ContainerDefinitionProperty.DockerSecurityOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-dockersecurityoptions
Type: Token
or string orToken
or None
-
entryPoint
¶ TaskDefinitionResource.ContainerDefinitionProperty.EntryPoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-entrypoint
Type: Token
or string orToken
or None
-
environment
¶ TaskDefinitionResource.ContainerDefinitionProperty.Environment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-environment
Type: Token
orToken
orKeyValuePairProperty
or None
-
essential
¶ TaskDefinitionResource.ContainerDefinitionProperty.Essential http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-essential
Type: boolean or Token
or None
-
extraHosts
¶ TaskDefinitionResource.ContainerDefinitionProperty.ExtraHosts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-extrahosts
Type: Token
orToken
orHostEntryProperty
or None
-
healthCheck
¶ TaskDefinitionResource.ContainerDefinitionProperty.HealthCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-healthcheck
Type: Token
orHealthCheckProperty
or None
-
hostname
¶ TaskDefinitionResource.ContainerDefinitionProperty.Hostname http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-hostname
Type: string or Token
or None
-
image
¶ TaskDefinitionResource.ContainerDefinitionProperty.Image http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-image
Type: string or Token
or None
-
links
¶ TaskDefinitionResource.ContainerDefinitionProperty.Links http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-links
Type: Token
or string orToken
or None
-
linuxParameters
¶ TaskDefinitionResource.ContainerDefinitionProperty.LinuxParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-linuxparameters
Type: Token
orLinuxParametersProperty
or None
-
logConfiguration
¶ TaskDefinitionResource.ContainerDefinitionProperty.LogConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration
Type: Token
orLogConfigurationProperty
or None
-
memory
¶ TaskDefinitionResource.ContainerDefinitionProperty.Memory http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memory
Type: number or Token
or None
-
memoryReservation
¶ TaskDefinitionResource.ContainerDefinitionProperty.MemoryReservation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-memoryreservation
Type: number or Token
or None
-
mountPoints
¶ TaskDefinitionResource.ContainerDefinitionProperty.MountPoints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints
Type: Token
orToken
orMountPointProperty
or None
-
name
¶ TaskDefinitionResource.ContainerDefinitionProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-name
Type: string or Token
or None
-
portMappings
¶ TaskDefinitionResource.ContainerDefinitionProperty.PortMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-portmappings
Type: Token
orToken
orPortMappingProperty
or None
-
privileged
¶ TaskDefinitionResource.ContainerDefinitionProperty.Privileged http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-privileged
Type: boolean or Token
or None
-
readonlyRootFilesystem
¶ TaskDefinitionResource.ContainerDefinitionProperty.ReadonlyRootFilesystem http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-readonlyrootfilesystem
Type: boolean or Token
or None
-
ulimits
¶ TaskDefinitionResource.ContainerDefinitionProperty.Ulimits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-ulimits
Type: Token
orToken
orUlimitProperty
or None
-
user
¶ TaskDefinitionResource.ContainerDefinitionProperty.User http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-user
Type: string or Token
or None
-
volumesFrom
¶ TaskDefinitionResource.ContainerDefinitionProperty.VolumesFrom http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom
Type: Token
orToken
orVolumeFromProperty
or None
-
workingDirectory
¶ TaskDefinitionResource.ContainerDefinitionProperty.WorkingDirectory http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html#cfn-ecs-taskdefinition-containerdefinition-workingdirectory
Type: string or Token
or None
-
-
class
DeviceProperty
¶ -
containerPath
¶ TaskDefinitionResource.DeviceProperty.ContainerPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-containerpath
Type: string or Token
or None
-
hostPath
¶ TaskDefinitionResource.DeviceProperty.HostPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-hostpath
Type: string or Token
-
permissions
¶ TaskDefinitionResource.DeviceProperty.Permissions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-device.html#cfn-ecs-taskdefinition-device-permissions
Type: Token
or string orToken
or None
-
-
class
HealthCheckProperty
¶ -
command
¶ TaskDefinitionResource.HealthCheckProperty.Command http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command
Type: Token
or string orToken
-
interval
¶ TaskDefinitionResource.HealthCheckProperty.Interval http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-interval
Type: number or Token
or None
-
retries
¶ TaskDefinitionResource.HealthCheckProperty.Retries http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-retries
Type: number or Token
or None
-
startPeriod
¶ TaskDefinitionResource.HealthCheckProperty.StartPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-startperiod
Type: number or Token
or None
-
timeout
¶ TaskDefinitionResource.HealthCheckProperty.Timeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-timeout
Type: number or Token
or None
-
-
class
HostEntryProperty
¶ -
hostname
¶ TaskDefinitionResource.HostEntryProperty.Hostname http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-hostname
Type: string or Token
-
ipAddress
¶ TaskDefinitionResource.HostEntryProperty.IpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html#cfn-ecs-taskdefinition-containerdefinition-hostentry-ipaddress
Type: string or Token
-
-
class
HostVolumePropertiesProperty
¶ -
sourcePath
¶ TaskDefinitionResource.HostVolumePropertiesProperty.SourcePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html#cfn-ecs-taskdefinition-volumes-host-sourcepath
Type: string or Token
or None
-
-
class
KernelCapabilitiesProperty
¶ -
add
¶ TaskDefinitionResource.KernelCapabilitiesProperty.Add http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-add
Type: Token
or string orToken
or None
-
drop
¶ TaskDefinitionResource.KernelCapabilitiesProperty.Drop http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html#cfn-ecs-taskdefinition-kernelcapabilities-drop
Type: Token
or string orToken
or None
-
-
class
KeyValuePairProperty
¶ -
name
¶ TaskDefinitionResource.KeyValuePairProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-name
Type: string or Token
or None
-
value
¶ TaskDefinitionResource.KeyValuePairProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html#cfn-ecs-taskdefinition-containerdefinition-environment-value
Type: string or Token
or None
-
-
class
LinuxParametersProperty
¶ -
capabilities
¶ TaskDefinitionResource.LinuxParametersProperty.Capabilities http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-capabilities
Type: Token
orKernelCapabilitiesProperty
or None
-
devices
¶ TaskDefinitionResource.LinuxParametersProperty.Devices http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-devices
Type: Token
orToken
orDeviceProperty
or None
-
initProcessEnabled
¶ TaskDefinitionResource.LinuxParametersProperty.InitProcessEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-initprocessenabled
Type: boolean or Token
or None
-
-
class
LogConfigurationProperty
¶ -
logDriver
¶ TaskDefinitionResource.LogConfigurationProperty.LogDriver http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-logdriver
Type: string or Token
-
options
¶ TaskDefinitionResource.LogConfigurationProperty.Options http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html#cfn-ecs-taskdefinition-containerdefinition-logconfiguration-options
Type: Token
or string orToken
or None
-
-
class
MountPointProperty
¶ -
containerPath
¶ TaskDefinitionResource.MountPointProperty.ContainerPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-containerpath
Type: string or Token
or None
-
readOnly
¶ TaskDefinitionResource.MountPointProperty.ReadOnly http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-readonly
Type: boolean or Token
or None
-
sourceVolume
¶ TaskDefinitionResource.MountPointProperty.SourceVolume http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html#cfn-ecs-taskdefinition-containerdefinition-mountpoints-sourcevolume
Type: string or Token
or None
-
-
class
PortMappingProperty
¶ -
containerPort
¶ TaskDefinitionResource.PortMappingProperty.ContainerPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-containerport
Type: number or Token
or None
-
hostPort
¶ TaskDefinitionResource.PortMappingProperty.HostPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-readonly
Type: number or Token
or None
-
protocol
¶ TaskDefinitionResource.PortMappingProperty.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html#cfn-ecs-taskdefinition-containerdefinition-portmappings-sourcevolume
Type: string or Token
or None
-
-
class
TaskDefinitionPlacementConstraintProperty
¶ -
expression
¶ TaskDefinitionResource.TaskDefinitionPlacementConstraintProperty.Expression http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-expression
Type: string or Token
or None
-
type
¶ TaskDefinitionResource.TaskDefinitionPlacementConstraintProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html#cfn-ecs-taskdefinition-taskdefinitionplacementconstraint-type
Type: string or Token
-
-
class
UlimitProperty
¶ -
hardLimit
¶ TaskDefinitionResource.UlimitProperty.HardLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-hardlimit
Type: number or Token
-
name
¶ TaskDefinitionResource.UlimitProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-name
Type: string or Token
-
softLimit
¶ TaskDefinitionResource.UlimitProperty.SoftLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html#cfn-ecs-taskdefinition-containerdefinition-ulimit-softlimit
Type: number or Token
-
-
class
VolumeFromProperty
¶ -
readOnly
¶ TaskDefinitionResource.VolumeFromProperty.ReadOnly http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-readonly
Type: boolean or Token
or None
-
sourceContainer
¶ TaskDefinitionResource.VolumeFromProperty.SourceContainer http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html#cfn-ecs-taskdefinition-containerdefinition-volumesfrom-sourcecontainer
Type: string or Token
or None
-
-
class
VolumeProperty
¶ -
host
¶ TaskDefinitionResource.VolumeProperty.Host http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-host
Type: Token
orHostVolumePropertiesProperty
or None
-
name
¶ TaskDefinitionResource.VolumeProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html#cfn-ecs-taskdefinition-volumes-name
Type: string or Token
or None
-
- parent (
TaskDefinitionResourceProps (interface)¶
-
class
_aws-cdk_resources.ecs.
TaskDefinitionResourceProps
¶ -
containerDefinitions
¶ AWS::ECS::TaskDefinition.ContainerDefinitions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-containerdefinitions
Type: Token
orToken
orContainerDefinitionProperty
or None
-
cpu
¶ AWS::ECS::TaskDefinition.Cpu http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-cpu
Type: string or Token
or None
-
executionRoleArn
¶ AWS::ECS::TaskDefinition.ExecutionRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-executionrolearn
Type: string or Token
or None
-
family
¶ AWS::ECS::TaskDefinition.Family http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-family
Type: string or Token
or None
-
memory
¶ AWS::ECS::TaskDefinition.Memory http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-memory
Type: string or Token
or None
-
networkMode
¶ AWS::ECS::TaskDefinition.NetworkMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-networkmode
Type: string or Token
or None
-
placementConstraints
¶ AWS::ECS::TaskDefinition.PlacementConstraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-placementconstraints
Type: Token
orToken
orTaskDefinitionPlacementConstraintProperty
or None
-
requiresCompatibilities
¶ AWS::ECS::TaskDefinition.RequiresCompatibilities http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-requirescompatibilities
Type: Token
or string orToken
or None
-
taskRoleArn
¶ AWS::ECS::TaskDefinition.TaskRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-taskrolearn
Type: string or Token
or None
-
volumes
¶ AWS::ECS::TaskDefinition.Volumes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-volumes
Type: Token
orToken
orVolumeProperty
or None
-
efs¶
FileSystemResource¶
-
class
_aws-cdk_resources.efs.
FileSystemResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this FileSystemResource is a part of - name (string) –
- props (
FileSystemResourceProps
or None) – the properties of this FileSystemResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ElasticFileSystemTagProperty
¶ -
key
¶ FileSystemResource.ElasticFileSystemTagProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemtags.html#cfn-efs-filesystem-filesystemtags-key
Type: string or Token
-
value
¶ FileSystemResource.ElasticFileSystemTagProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemtags.html#cfn-efs-filesystem-filesystemtags-value
Type: string or Token
-
- parent (
FileSystemResourceProps (interface)¶
-
class
_aws-cdk_resources.efs.
FileSystemResourceProps
¶ -
encrypted
¶ AWS::EFS::FileSystem.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-encrypted
Type: boolean or Token
or None
-
fileSystemTags
¶ AWS::EFS::FileSystem.FileSystemTags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemtags
Type: Token
orToken
orElasticFileSystemTagProperty
or None
-
kmsKeyId
¶ AWS::EFS::FileSystem.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-kmskeyid
Type: string or Token
or None
-
performanceMode
¶ AWS::EFS::FileSystem.PerformanceMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-performancemode
Type: string or Token
or None
-
MountTargetResource¶
-
class
_aws-cdk_resources.efs.
MountTargetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MountTargetResource is a part of - name (string) –
- props (
MountTargetResourceProps
or None) – the properties of this MountTargetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
MountTargetResourceProps (interface)¶
-
class
_aws-cdk_resources.efs.
MountTargetResourceProps
¶ -
fileSystemId
¶ AWS::EFS::MountTarget.FileSystemId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-filesystemid
Type: string or Token
-
ipAddress
¶ AWS::EFS::MountTarget.IpAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddress
Type: string or Token
or None
-
securityGroups
¶ AWS::EFS::MountTarget.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-securitygroups
Type: Token
or string orToken
-
subnetId
¶ AWS::EFS::MountTarget.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-subnetid
Type: string or Token
-
eks¶
ClusterArn¶
ClusterCertificateAuthorityData¶
ClusterEndpoint¶
ClusterResource¶
-
class
_aws-cdk_resources.eks.
ClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterResource is a part of - name (string) –
- props (
ClusterResourceProps
or None) – the properties of this ClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
clusterEndpoint
¶ Type: ClusterEndpoint
(readonly)
-
clusterArn
¶ Type: ClusterArn
(readonly)
-
clusterCertificateAuthorityData
¶ Type: ClusterCertificateAuthorityData
(readonly)
-
class
ResourcesVpcConfigProperty
¶ -
securityGroupIds
¶ ClusterResource.ResourcesVpcConfigProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-securitygroupids
Type: Token
or string orToken
or None
-
subnetIds
¶ ClusterResource.ResourcesVpcConfigProperty.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-subnetids
Type: Token
or string orToken
-
- parent (
ClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.eks.
ClusterResourceProps
¶ -
version
¶ AWS::EKS::Cluster.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-version
Type: string or Token
or None
-
roleArn
¶ AWS::EKS::Cluster.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-rolearn
Type: string or Token
-
resourcesVpcConfig
¶ AWS::EKS::Cluster.ResourcesVpcConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-resourcesvpcconfig
Type: Token
orResourcesVpcConfigProperty
-
clusterName
¶ AWS::EKS::Cluster.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-name
Type: string or Token
or None
-
elasticache¶
CacheClusterConfigurationEndpointAddress¶
CacheClusterConfigurationEndpointPort¶
CacheClusterRedisEndpointAddress¶
CacheClusterRedisEndpointPort¶
CacheClusterResource¶
-
class
_aws-cdk_resources.elasticache.
CacheClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CacheClusterResource is a part of - name (string) –
- props (
CacheClusterResourceProps
or None) – the properties of this CacheClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
cacheClusterConfigurationEndpointAddress
¶ Type: CacheClusterConfigurationEndpointAddress
(readonly)
-
cacheClusterConfigurationEndpointPort
¶ Type: CacheClusterConfigurationEndpointPort
(readonly)
-
cacheClusterRedisEndpointAddress
¶ Type: CacheClusterRedisEndpointAddress
(readonly)
-
cacheClusterRedisEndpointPort
¶ Type: CacheClusterRedisEndpointPort
(readonly)
- parent (
CacheClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticache.
CacheClusterResourceProps
¶ -
azMode
¶ AWS::ElastiCache::CacheCluster.AZMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-azmode
Type: string or Token
or None
-
autoMinorVersionUpgrade
¶ AWS::ElastiCache::CacheCluster.AutoMinorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-autominorversionupgrade
Type: boolean or Token
or None
-
cacheNodeType
¶ AWS::ElastiCache::CacheCluster.CacheNodeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachenodetype
Type: string or Token
-
cacheParameterGroupName
¶ AWS::ElastiCache::CacheCluster.CacheParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cacheparametergroupname
Type: string or Token
or None
-
cacheSecurityGroupNames
¶ AWS::ElastiCache::CacheCluster.CacheSecurityGroupNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames
Type: Token
or string orToken
or None
-
cacheSubnetGroupName
¶ AWS::ElastiCache::CacheCluster.CacheSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname
Type: string or Token
or None
-
clusterName
¶ AWS::ElastiCache::CacheCluster.ClusterName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-clustername
Type: string or Token
or None
-
engine
¶ AWS::ElastiCache::CacheCluster.Engine http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engine
Type: string or Token
-
engineVersion
¶ AWS::ElastiCache::CacheCluster.EngineVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-engineversion
Type: string or Token
or None
-
notificationTopicArn
¶ AWS::ElastiCache::CacheCluster.NotificationTopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-notificationtopicarn
Type: string or Token
or None
-
numCacheNodes
¶ AWS::ElastiCache::CacheCluster.NumCacheNodes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-numcachenodes
Type: number or Token
-
port
¶ AWS::ElastiCache::CacheCluster.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-port
Type: number or Token
or None
-
preferredAvailabilityZone
¶ AWS::ElastiCache::CacheCluster.PreferredAvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone
Type: string or Token
or None
-
preferredAvailabilityZones
¶ AWS::ElastiCache::CacheCluster.PreferredAvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones
Type: Token
or string orToken
or None
-
preferredMaintenanceWindow
¶ AWS::ElastiCache::CacheCluster.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow
Type: string or Token
or None
-
snapshotArns
¶ AWS::ElastiCache::CacheCluster.SnapshotArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotarns
Type: Token
or string orToken
or None
-
snapshotName
¶ AWS::ElastiCache::CacheCluster.SnapshotName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotname
Type: string or Token
or None
-
snapshotRetentionLimit
¶ AWS::ElastiCache::CacheCluster.SnapshotRetentionLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit
Type: number or Token
or None
-
snapshotWindow
¶ AWS::ElastiCache::CacheCluster.SnapshotWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-snapshotwindow
Type: string or Token
or None
AWS::ElastiCache::CacheCluster.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-tags
Type: Token
orToken
orTag
or None
-
vpcSecurityGroupIds
¶ AWS::ElastiCache::CacheCluster.VpcSecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cache-cluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids
Type: Token
or string orToken
or None
-
ParameterGroupResource¶
-
class
_aws-cdk_resources.elasticache.
ParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ParameterGroupResource is a part of - name (string) –
- props (
ParameterGroupResourceProps
or None) – the properties of this ParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticache.
ParameterGroupResourceProps
¶ -
cacheParameterGroupFamily
¶ AWS::ElastiCache::ParameterGroup.CacheParameterGroupFamily http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-cacheparametergroupfamily
Type: string or Token
-
description
¶ AWS::ElastiCache::ParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-description
Type: string or Token
-
properties
¶ AWS::ElastiCache::ParameterGroup.Properties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-properties
Type: Token
or string orToken
or None
-
ReplicationGroupConfigurationEndPointAddress¶
ReplicationGroupConfigurationEndPointPort¶
ReplicationGroupPrimaryEndPointAddress¶
ReplicationGroupPrimaryEndPointPort¶
ReplicationGroupReadEndPointAddresses¶
ReplicationGroupReadEndPointAddressesList¶
ReplicationGroupReadEndPointPorts¶
ReplicationGroupReadEndPointPortsList¶
ReplicationGroupResource¶
-
class
_aws-cdk_resources.elasticache.
ReplicationGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReplicationGroupResource is a part of - name (string) –
- props (
ReplicationGroupResourceProps
or None) – the properties of this ReplicationGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
replicationGroupConfigurationEndPointAddress
¶ Type: ReplicationGroupConfigurationEndPointAddress
(readonly)
-
replicationGroupConfigurationEndPointPort
¶ Type: ReplicationGroupConfigurationEndPointPort
(readonly)
-
replicationGroupPrimaryEndPointAddress
¶ Type: ReplicationGroupPrimaryEndPointAddress
(readonly)
-
replicationGroupPrimaryEndPointPort
¶ Type: ReplicationGroupPrimaryEndPointPort
(readonly)
-
replicationGroupReadEndPointAddresses
¶ Type: ReplicationGroupReadEndPointAddresses
(readonly)
-
replicationGroupReadEndPointAddressesList
¶ Type: ReplicationGroupReadEndPointAddressesList
(readonly)
-
replicationGroupReadEndPointPorts
¶ Type: ReplicationGroupReadEndPointPorts
(readonly)
-
replicationGroupReadEndPointPortsList
¶ Type: ReplicationGroupReadEndPointPortsList
(readonly)
-
class
NodeGroupConfigurationProperty
¶ -
primaryAvailabilityZone
¶ ReplicationGroupResource.NodeGroupConfigurationProperty.PrimaryAvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-primaryavailabilityzone
Type: string or Token
or None
-
replicaAvailabilityZones
¶ ReplicationGroupResource.NodeGroupConfigurationProperty.ReplicaAvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicaavailabilityzones
Type: Token
or string orToken
or None
-
replicaCount
¶ ReplicationGroupResource.NodeGroupConfigurationProperty.ReplicaCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicacount
Type: number or Token
or None
-
slots
¶ ReplicationGroupResource.NodeGroupConfigurationProperty.Slots http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-slots
Type: string or Token
or None
-
- parent (
ReplicationGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticache.
ReplicationGroupResourceProps
¶ -
atRestEncryptionEnabled
¶ AWS::ElastiCache::ReplicationGroup.AtRestEncryptionEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled
Type: boolean or Token
or None
-
authToken
¶ AWS::ElastiCache::ReplicationGroup.AuthToken http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken
Type: string or Token
or None
-
autoMinorVersionUpgrade
¶ AWS::ElastiCache::ReplicationGroup.AutoMinorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-autominorversionupgrade
Type: boolean or Token
or None
-
automaticFailoverEnabled
¶ AWS::ElastiCache::ReplicationGroup.AutomaticFailoverEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-automaticfailoverenabled
Type: boolean or Token
or None
-
cacheNodeType
¶ AWS::ElastiCache::ReplicationGroup.CacheNodeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachenodetype
Type: string or Token
or None
-
cacheParameterGroupName
¶ AWS::ElastiCache::ReplicationGroup.CacheParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cacheparametergroupname
Type: string or Token
or None
-
cacheSecurityGroupNames
¶ AWS::ElastiCache::ReplicationGroup.CacheSecurityGroupNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesecuritygroupnames
Type: Token
or string orToken
or None
-
cacheSubnetGroupName
¶ AWS::ElastiCache::ReplicationGroup.CacheSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesubnetgroupname
Type: string or Token
or None
-
engine
¶ AWS::ElastiCache::ReplicationGroup.Engine http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engine
Type: string or Token
or None
-
engineVersion
¶ AWS::ElastiCache::ReplicationGroup.EngineVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engineversion
Type: string or Token
or None
-
nodeGroupConfiguration
¶ AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration
Type: Token
orToken
orNodeGroupConfigurationProperty
or None
-
notificationTopicArn
¶ AWS::ElastiCache::ReplicationGroup.NotificationTopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-notificationtopicarn
Type: string or Token
or None
-
numCacheClusters
¶ AWS::ElastiCache::ReplicationGroup.NumCacheClusters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numcacheclusters
Type: number or Token
or None
-
numNodeGroups
¶ AWS::ElastiCache::ReplicationGroup.NumNodeGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups
Type: number or Token
or None
-
port
¶ AWS::ElastiCache::ReplicationGroup.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-port
Type: number or Token
or None
-
preferredCacheClusterAZs
¶ AWS::ElastiCache::ReplicationGroup.PreferredCacheClusterAZs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredcacheclusterazs
Type: Token
or string orToken
or None
-
preferredMaintenanceWindow
¶ AWS::ElastiCache::ReplicationGroup.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredmaintenancewindow
Type: string or Token
or None
-
primaryClusterId
¶ AWS::ElastiCache::ReplicationGroup.PrimaryClusterId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-primaryclusterid
Type: string or Token
or None
-
replicasPerNodeGroup
¶ AWS::ElastiCache::ReplicationGroup.ReplicasPerNodeGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicaspernodegroup
Type: number or Token
or None
-
replicationGroupDescription
¶ AWS::ElastiCache::ReplicationGroup.ReplicationGroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupdescription
Type: string or Token
-
replicationGroupId
¶ AWS::ElastiCache::ReplicationGroup.ReplicationGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupid
Type: string or Token
or None
-
securityGroupIds
¶ AWS::ElastiCache::ReplicationGroup.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-securitygroupids
Type: Token
or string orToken
or None
-
snapshotArns
¶ AWS::ElastiCache::ReplicationGroup.SnapshotArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotarns
Type: Token
or string orToken
or None
-
snapshotName
¶ AWS::ElastiCache::ReplicationGroup.SnapshotName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotname
Type: string or Token
or None
-
snapshotRetentionLimit
¶ AWS::ElastiCache::ReplicationGroup.SnapshotRetentionLimit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotretentionlimit
Type: number or Token
or None
-
snapshotWindow
¶ AWS::ElastiCache::ReplicationGroup.SnapshotWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotwindow
Type: string or Token
or None
-
snapshottingClusterId
¶ AWS::ElastiCache::ReplicationGroup.SnapshottingClusterId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshottingclusterid
Type: string or Token
or None
AWS::ElastiCache::ReplicationGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-tags
Type: Token
orToken
orTag
or None
-
transitEncryptionEnabled
¶ AWS::ElastiCache::ReplicationGroup.TransitEncryptionEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionenabled
Type: boolean or Token
or None
-
SecurityGroupIngressResource¶
-
class
_aws-cdk_resources.elasticache.
SecurityGroupIngressResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SecurityGroupIngressResource is a part of - name (string) –
- props (
SecurityGroupIngressResourceProps
or None) – the properties of this SecurityGroupIngressResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SecurityGroupIngressResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticache.
SecurityGroupIngressResourceProps
¶ -
cacheSecurityGroupName
¶ AWS::ElastiCache::SecurityGroupIngress.CacheSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-cachesecuritygroupname
Type: string or Token
-
ec2SecurityGroupName
¶ AWS::ElastiCache::SecurityGroupIngress.EC2SecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupname
Type: string or Token
-
ec2SecurityGroupOwnerId
¶ AWS::ElastiCache::SecurityGroupIngress.EC2SecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-security-group-ingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupownerid
Type: string or Token
or None
-
SecurityGroupResource¶
-
class
_aws-cdk_resources.elasticache.
SecurityGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SecurityGroupResource is a part of - name (string) –
- props (
SecurityGroupResourceProps
or None) – the properties of this SecurityGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SecurityGroupResourceProps (interface)¶
SubnetGroupResource¶
-
class
_aws-cdk_resources.elasticache.
SubnetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubnetGroupResource is a part of - name (string) –
- props (
SubnetGroupResourceProps
or None) – the properties of this SubnetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SubnetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticache.
SubnetGroupResourceProps
¶ -
cacheSubnetGroupName
¶ AWS::ElastiCache::SubnetGroup.CacheSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-cachesubnetgroupname
Type: string or Token
or None
-
description
¶ AWS::ElastiCache::SubnetGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-description
Type: string or Token
-
subnetIds
¶ AWS::ElastiCache::SubnetGroup.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-subnetids
Type: Token
or string orToken
-
elasticbeanstalk¶
ApplicationResource¶
-
class
_aws-cdk_resources.elasticbeanstalk.
ApplicationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApplicationResource is a part of - name (string) –
- props (
ApplicationResourceProps
or None) – the properties of this ApplicationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ApplicationResourceLifecycleConfigProperty
¶ -
serviceRole
¶ ApplicationResource.ApplicationResourceLifecycleConfigProperty.ServiceRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-servicerole
Type: string or Token
or None
-
versionLifecycleConfig
¶ ApplicationResource.ApplicationResourceLifecycleConfigProperty.VersionLifecycleConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationresourcelifecycleconfig.html#cfn-elasticbeanstalk-application-applicationresourcelifecycleconfig-versionlifecycleconfig
Type: Token
orApplicationVersionLifecycleConfigProperty
or None
-
-
class
ApplicationVersionLifecycleConfigProperty
¶ -
maxAgeRule
¶ ApplicationResource.ApplicationVersionLifecycleConfigProperty.MaxAgeRule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxagerule
Type: Token
orMaxAgeRuleProperty
or None
-
maxCountRule
¶ ApplicationResource.ApplicationVersionLifecycleConfigProperty.MaxCountRule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-applicationversionlifecycleconfig.html#cfn-elasticbeanstalk-application-applicationversionlifecycleconfig-maxcountrule
Type: Token
orMaxCountRuleProperty
or None
-
-
class
MaxAgeRuleProperty
¶ -
deleteSourceFromS3
¶ ApplicationResource.MaxAgeRuleProperty.DeleteSourceFromS3 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-deletesourcefroms3
Type: boolean or Token
or None
-
enabled
¶ ApplicationResource.MaxAgeRuleProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-enabled
Type: boolean or Token
or None
-
maxAgeInDays
¶ ApplicationResource.MaxAgeRuleProperty.MaxAgeInDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxagerule.html#cfn-elasticbeanstalk-application-maxagerule-maxageindays
Type: number or Token
or None
-
-
class
MaxCountRuleProperty
¶ -
deleteSourceFromS3
¶ ApplicationResource.MaxCountRuleProperty.DeleteSourceFromS3 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-deletesourcefroms3
Type: boolean or Token
or None
-
enabled
¶ ApplicationResource.MaxCountRuleProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-enabled
Type: boolean or Token
or None
-
maxCount
¶ ApplicationResource.MaxCountRuleProperty.MaxCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-application-maxcountrule.html#cfn-elasticbeanstalk-application-maxcountrule-maxcount
Type: number or Token
or None
-
- parent (
ApplicationResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticbeanstalk.
ApplicationResourceProps
¶ -
applicationName
¶ AWS::ElasticBeanstalk::Application.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html#cfn-elasticbeanstalk-application-name
Type: string or Token
or None
-
description
¶ AWS::ElasticBeanstalk::Application.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html#cfn-elasticbeanstalk-application-description
Type: string or Token
or None
-
resourceLifecycleConfig
¶ AWS::ElasticBeanstalk::Application.ResourceLifecycleConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk.html#cfn-elasticbeanstalk-application-resourcelifecycleconfig
Type: Token
orApplicationResourceLifecycleConfigProperty
or None
-
ApplicationVersionResource¶
-
class
_aws-cdk_resources.elasticbeanstalk.
ApplicationVersionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApplicationVersionResource is a part of - name (string) –
- props (
ApplicationVersionResourceProps
or None) – the properties of this ApplicationVersionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
SourceBundleProperty
¶ -
s3Bucket
¶ ApplicationVersionResource.SourceBundleProperty.S3Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html#cfn-beanstalk-sourcebundle-s3bucket
Type: string or Token
-
s3Key
¶ ApplicationVersionResource.SourceBundleProperty.S3Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html#cfn-beanstalk-sourcebundle-s3key
Type: string or Token
-
- parent (
ApplicationVersionResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticbeanstalk.
ApplicationVersionResourceProps
¶ -
applicationName
¶ AWS::ElasticBeanstalk::ApplicationVersion.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html#cfn-elasticbeanstalk-applicationversion-applicationname
Type: string or Token
-
description
¶ AWS::ElasticBeanstalk::ApplicationVersion.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html#cfn-elasticbeanstalk-applicationversion-description
Type: string or Token
or None
-
sourceBundle
¶ AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-version.html#cfn-elasticbeanstalk-applicationversion-sourcebundle
Type: Token
orSourceBundleProperty
-
ConfigurationTemplateResource¶
-
class
_aws-cdk_resources.elasticbeanstalk.
ConfigurationTemplateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ConfigurationTemplateResource is a part of - name (string) –
- props (
ConfigurationTemplateResourceProps
or None) – the properties of this ConfigurationTemplateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ConfigurationOptionSettingProperty
¶ -
namespace
¶ ConfigurationTemplateResource.ConfigurationOptionSettingProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-namespace
Type: string or Token
-
optionName
¶ ConfigurationTemplateResource.ConfigurationOptionSettingProperty.OptionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-optionname
Type: string or Token
-
resourceName
¶ ConfigurationTemplateResource.ConfigurationOptionSettingProperty.ResourceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-resourcename
Type: string or Token
or None
-
value
¶ ConfigurationTemplateResource.ConfigurationOptionSettingProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-configurationoptionsetting.html#cfn-elasticbeanstalk-configurationtemplate-configurationoptionsetting-value
Type: string or Token
or None
-
-
class
SourceConfigurationProperty
¶ -
applicationName
¶ ConfigurationTemplateResource.SourceConfigurationProperty.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-applicationname
Type: string or Token
-
templateName
¶ ConfigurationTemplateResource.SourceConfigurationProperty.TemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-configurationtemplate-sourceconfiguration.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration-templatename
Type: string or Token
-
- parent (
ConfigurationTemplateResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticbeanstalk.
ConfigurationTemplateResourceProps
¶ -
applicationName
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-applicationname
Type: string or Token
-
description
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-description
Type: string or Token
or None
-
environmentId
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.EnvironmentId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-environmentid
Type: string or Token
or None
-
optionSettings
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.OptionSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-optionsettings
Type: Token
orToken
orConfigurationOptionSettingProperty
or None
-
platformArn
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.PlatformArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-platformarn
Type: string or Token
or None
-
solutionStackName
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.SolutionStackName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-solutionstackname
Type: string or Token
or None
-
sourceConfiguration
¶ AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticbeanstalk-configurationtemplate.html#cfn-elasticbeanstalk-configurationtemplate-sourceconfiguration
Type: Token
orSourceConfigurationProperty
or None
-
EnvironmentEndpointUrl¶
EnvironmentResource¶
-
class
_aws-cdk_resources.elasticbeanstalk.
EnvironmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EnvironmentResource is a part of - name (string) –
- props (
EnvironmentResourceProps
or None) – the properties of this EnvironmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
environmentEndpointUrl
¶ Type: EnvironmentEndpointUrl
(readonly)
-
class
OptionSettingProperty
¶ -
namespace
¶ EnvironmentResource.OptionSettingProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-beanstalk-optionsettings-namespace
Type: string or Token
-
optionName
¶ EnvironmentResource.OptionSettingProperty.OptionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-beanstalk-optionsettings-optionname
Type: string or Token
-
resourceName
¶ EnvironmentResource.OptionSettingProperty.ResourceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-elasticbeanstalk-environment-optionsetting-resourcename
Type: string or Token
or None
-
value
¶ EnvironmentResource.OptionSettingProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-option-settings.html#cfn-beanstalk-optionsettings-value
Type: string or Token
or None
-
-
class
TierProperty
¶ -
name
¶ EnvironmentResource.TierProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html#cfn-beanstalk-env-tier-name
Type: string or Token
or None
-
type
¶ EnvironmentResource.TierProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html#cfn-beanstalk-env-tier-type
Type: string or Token
or None
-
version
¶ EnvironmentResource.TierProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment-tier.html#cfn-beanstalk-env-tier-version
Type: string or Token
or None
-
- parent (
EnvironmentResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticbeanstalk.
EnvironmentResourceProps
¶ -
applicationName
¶ AWS::ElasticBeanstalk::Environment.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-applicationname
Type: string or Token
-
cnamePrefix
¶ AWS::ElasticBeanstalk::Environment.CNAMEPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-cnameprefix
Type: string or Token
or None
-
description
¶ AWS::ElasticBeanstalk::Environment.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-description
Type: string or Token
or None
-
environmentName
¶ AWS::ElasticBeanstalk::Environment.EnvironmentName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-name
Type: string or Token
or None
-
optionSettings
¶ AWS::ElasticBeanstalk::Environment.OptionSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-optionsettings
Type: Token
orToken
orOptionSettingProperty
or None
-
platformArn
¶ AWS::ElasticBeanstalk::Environment.PlatformArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn
Type: string or Token
or None
-
solutionStackName
¶ AWS::ElasticBeanstalk::Environment.SolutionStackName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-solutionstackname
Type: string or Token
or None
AWS::ElasticBeanstalk::Environment.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-elasticbeanstalk-environment-tags
Type: Token
orToken
orTag
or None
-
templateName
¶ AWS::ElasticBeanstalk::Environment.TemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-templatename
Type: string or Token
or None
-
tier
¶ AWS::ElasticBeanstalk::Environment.Tier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-tier
Type: Token
orTierProperty
or None
-
versionLabel
¶ AWS::ElasticBeanstalk::Environment.VersionLabel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-versionlabel
Type: string or Token
or None
-
elasticloadbalancing¶
LoadBalancerCanonicalHostedZoneName¶
LoadBalancerCanonicalHostedZoneNameId¶
LoadBalancerDnsName¶
LoadBalancerResource¶
-
class
_aws-cdk_resources.elasticloadbalancing.
LoadBalancerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LoadBalancerResource is a part of - name (string) –
- props (
LoadBalancerResourceProps
or None) – the properties of this LoadBalancerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
loadBalancerCanonicalHostedZoneName
¶ Type: LoadBalancerCanonicalHostedZoneName
(readonly)
-
loadBalancerCanonicalHostedZoneNameId
¶ Type: LoadBalancerCanonicalHostedZoneNameId
(readonly)
-
loadBalancerDnsName
¶ Type: LoadBalancerDnsName
(readonly)
-
loadBalancerSourceSecurityGroupGroupName
¶ Type: LoadBalancerSourceSecurityGroupGroupName
(readonly)
-
loadBalancerSourceSecurityGroupOwnerAlias
¶ Type: LoadBalancerSourceSecurityGroupOwnerAlias
(readonly)
-
class
AccessLoggingPolicyProperty
¶ -
emitInterval
¶ LoadBalancerResource.AccessLoggingPolicyProperty.EmitInterval http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-emitinterval
Type: number or Token
or None
-
enabled
¶ LoadBalancerResource.AccessLoggingPolicyProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-enabled
Type: boolean or Token
-
s3BucketName
¶ LoadBalancerResource.AccessLoggingPolicyProperty.S3BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-s3bucketname
Type: string or Token
-
s3BucketPrefix
¶ LoadBalancerResource.AccessLoggingPolicyProperty.S3BucketPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-accessloggingpolicy.html#cfn-elb-accessloggingpolicy-s3bucketprefix
Type: string or Token
or None
-
-
class
AppCookieStickinessPolicyProperty
¶ LoadBalancerResource.AppCookieStickinessPolicyProperty.CookieName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html#cfn-elb-appcookiestickinesspolicy-cookiename
Type: string or Token
-
policyName
¶ LoadBalancerResource.AppCookieStickinessPolicyProperty.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-AppCookieStickinessPolicy.html#cfn-elb-appcookiestickinesspolicy-policyname
Type: string or Token
-
class
ConnectionDrainingPolicyProperty
¶ -
enabled
¶ LoadBalancerResource.ConnectionDrainingPolicyProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html#cfn-elb-connectiondrainingpolicy-enabled
Type: boolean or Token
-
timeout
¶ LoadBalancerResource.ConnectionDrainingPolicyProperty.Timeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectiondrainingpolicy.html#cfn-elb-connectiondrainingpolicy-timeout
Type: number or Token
or None
-
-
class
ConnectionSettingsProperty
¶ -
idleTimeout
¶ LoadBalancerResource.ConnectionSettingsProperty.IdleTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-connectionsettings.html#cfn-elb-connectionsettings-idletimeout
Type: number or Token
-
-
class
HealthCheckProperty
¶ -
healthyThreshold
¶ LoadBalancerResource.HealthCheckProperty.HealthyThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-healthythreshold
Type: string or Token
-
interval
¶ LoadBalancerResource.HealthCheckProperty.Interval http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-interval
Type: string or Token
-
target
¶ LoadBalancerResource.HealthCheckProperty.Target http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-target
Type: string or Token
-
timeout
¶ LoadBalancerResource.HealthCheckProperty.Timeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-timeout
Type: string or Token
-
unhealthyThreshold
¶ LoadBalancerResource.HealthCheckProperty.UnhealthyThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-health-check.html#cfn-elb-healthcheck-unhealthythreshold
Type: string or Token
-
-
class
LBCookieStickinessPolicyProperty
¶ LoadBalancerResource.LBCookieStickinessPolicyProperty.CookieExpirationPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html#cfn-elb-lbcookiestickinesspolicy-cookieexpirationperiod
Type: string or Token
or None
-
policyName
¶ LoadBalancerResource.LBCookieStickinessPolicyProperty.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-LBCookieStickinessPolicy.html#cfn-elb-lbcookiestickinesspolicy-policyname
Type: string or Token
or None
-
class
ListenersProperty
¶ -
instancePort
¶ LoadBalancerResource.ListenersProperty.InstancePort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-instanceport
Type: string or Token
-
instanceProtocol
¶ LoadBalancerResource.ListenersProperty.InstanceProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-instanceprotocol
Type: string or Token
or None
-
loadBalancerPort
¶ LoadBalancerResource.ListenersProperty.LoadBalancerPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-loadbalancerport
Type: string or Token
-
policyNames
¶ LoadBalancerResource.ListenersProperty.PolicyNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-policynames
Type: Token
or string orToken
or None
-
protocol
¶ LoadBalancerResource.ListenersProperty.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-protocol
Type: string or Token
-
sslCertificateId
¶ LoadBalancerResource.ListenersProperty.SSLCertificateId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-listener.html#cfn-ec2-elb-listener-sslcertificateid
Type: string or Token
or None
-
-
class
PoliciesProperty
¶ -
attributes
¶ LoadBalancerResource.PoliciesProperty.Attributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-attributes
Type: Token
or json orToken
-
instancePorts
¶ LoadBalancerResource.PoliciesProperty.InstancePorts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-instanceports
Type: Token
or string orToken
or None
-
loadBalancerPorts
¶ LoadBalancerResource.PoliciesProperty.LoadBalancerPorts http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-loadbalancerports
Type: Token
or string orToken
or None
-
policyName
¶ LoadBalancerResource.PoliciesProperty.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-policyname
Type: string or Token
-
policyType
¶ LoadBalancerResource.PoliciesProperty.PolicyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb-policy.html#cfn-ec2-elb-policy-policytype
Type: string or Token
-
- parent (
LoadBalancerResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticloadbalancing.
LoadBalancerResourceProps
¶ -
accessLoggingPolicy
¶ AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-accessloggingpolicy
Type: Token
orAccessLoggingPolicyProperty
or None
-
appCookieStickinessPolicy
¶ AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-appcookiestickinesspolicy
Type: Token
orToken
orAppCookieStickinessPolicyProperty
or None
-
availabilityZones
¶ AWS::ElasticLoadBalancing::LoadBalancer.AvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-availabilityzones
Type: Token
or string orToken
or None
-
connectionDrainingPolicy
¶ AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-connectiondrainingpolicy
Type: Token
orConnectionDrainingPolicyProperty
or None
-
connectionSettings
¶ AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-connectionsettings
Type: Token
orConnectionSettingsProperty
or None
-
crossZone
¶ AWS::ElasticLoadBalancing::LoadBalancer.CrossZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-crosszone
Type: boolean or Token
or None
-
healthCheck
¶ AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-healthcheck
Type: Token
orHealthCheckProperty
or None
-
instances
¶ AWS::ElasticLoadBalancing::LoadBalancer.Instances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-instances
Type: Token
or string orToken
or None
-
lbCookieStickinessPolicy
¶ AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-lbcookiestickinesspolicy
Type: Token
orToken
orLBCookieStickinessPolicyProperty
or None
-
listeners
¶ AWS::ElasticLoadBalancing::LoadBalancer.Listeners http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-listeners
Type: Token
orToken
orListenersProperty
-
loadBalancerName
¶ AWS::ElasticLoadBalancing::LoadBalancer.LoadBalancerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-elbname
Type: string or Token
or None
-
policies
¶ AWS::ElasticLoadBalancing::LoadBalancer.Policies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-policies
Type: Token
orToken
orPoliciesProperty
or None
-
scheme
¶ AWS::ElasticLoadBalancing::LoadBalancer.Scheme http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-scheme
Type: string or Token
or None
-
securityGroups
¶ AWS::ElasticLoadBalancing::LoadBalancer.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-securitygroups
Type: Token
or string orToken
or None
-
subnets
¶ AWS::ElasticLoadBalancing::LoadBalancer.Subnets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-ec2-elb-subnets
Type: Token
or string orToken
or None
AWS::ElasticLoadBalancing::LoadBalancer.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#cfn-elasticloadbalancing-loadbalancer-tags
Type: Token
orToken
orTag
or None
-
LoadBalancerSourceSecurityGroupGroupName¶
elasticloadbalancingv2¶
ListenerCertificateResource¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
ListenerCertificateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ListenerCertificateResource is a part of - name (string) –
- props (
ListenerCertificateResourceProps
or None) – the properties of this ListenerCertificateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
CertificateProperty
¶ -
certificateArn
¶ ListenerCertificateResource.CertificateProperty.CertificateArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn
Type: string or Token
or None
-
- parent (
ListenerCertificateResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
ListenerCertificateResourceProps
¶ -
certificates
¶ AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-certificates
Type: Token
orToken
orCertificateProperty
-
listenerArn
¶ AWS::ElasticLoadBalancingV2::ListenerCertificate.ListenerArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-listenerarn
Type: string or Token
-
ListenerResource¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
ListenerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ListenerResource is a part of - name (string) –
- props (
ListenerResourceProps
or None) – the properties of this ListenerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActionProperty
¶ -
targetGroupArn
¶ ListenerResource.ActionProperty.TargetGroupArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-targetgrouparn
Type: string or Token
-
type
¶ ListenerResource.ActionProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-type
Type: string or Token
-
-
class
CertificateProperty
¶ -
certificateArn
¶ ListenerResource.CertificateProperty.CertificateArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn
Type: string or Token
or None
-
- parent (
ListenerResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
ListenerResourceProps
¶ -
certificates
¶ AWS::ElasticLoadBalancingV2::Listener.Certificates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates
Type: Token
orToken
orCertificateProperty
or None
-
defaultActions
¶ AWS::ElasticLoadBalancingV2::Listener.DefaultActions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions
Type: Token
orToken
orActionProperty
-
loadBalancerArn
¶ AWS::ElasticLoadBalancingV2::Listener.LoadBalancerArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn
Type: string or Token
-
port
¶ AWS::ElasticLoadBalancingV2::Listener.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port
Type: number or Token
-
protocol
¶ AWS::ElasticLoadBalancingV2::Listener.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol
Type: string or Token
-
sslPolicy
¶ AWS::ElasticLoadBalancingV2::Listener.SslPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy
Type: string or Token
or None
-
ListenerRuleResource¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
ListenerRuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ListenerRuleResource is a part of - name (string) –
- props (
ListenerRuleResourceProps
or None) – the properties of this ListenerRuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActionProperty
¶ -
targetGroupArn
¶ ListenerRuleResource.ActionProperty.TargetGroupArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-targetgrouparn
Type: string or Token
-
type
¶ ListenerRuleResource.ActionProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-type
Type: string or Token
-
-
class
RuleConditionProperty
¶ -
field
¶ ListenerRuleResource.RuleConditionProperty.Field http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-conditions-field
Type: string or Token
or None
-
values
¶ ListenerRuleResource.RuleConditionProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-conditions-values
Type: Token
or string orToken
or None
-
- parent (
ListenerRuleResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
ListenerRuleResourceProps
¶ -
actions
¶ AWS::ElasticLoadBalancingV2::ListenerRule.Actions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-actions
Type: Token
orToken
orActionProperty
-
conditions
¶ AWS::ElasticLoadBalancingV2::ListenerRule.Conditions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-conditions
Type: Token
orToken
orRuleConditionProperty
-
listenerArn
¶ AWS::ElasticLoadBalancingV2::ListenerRule.ListenerArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-listenerarn
Type: string or Token
-
priority
¶ AWS::ElasticLoadBalancingV2::ListenerRule.Priority http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-priority
Type: number or Token
-
LoadBalancerCanonicalHostedZoneId¶
LoadBalancerDnsName¶
LoadBalancerFullName¶
LoadBalancerName¶
LoadBalancerResource¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
LoadBalancerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LoadBalancerResource is a part of - name (string) –
- props (
LoadBalancerResourceProps
or None) – the properties of this LoadBalancerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
loadBalancerCanonicalHostedZoneId
¶ Type: LoadBalancerCanonicalHostedZoneId
(readonly)
-
loadBalancerDnsName
¶ Type: LoadBalancerDnsName
(readonly)
-
loadBalancerFullName
¶ Type: LoadBalancerFullName
(readonly)
-
loadBalancerName
¶ Type: LoadBalancerName
(readonly)
-
loadBalancerSecurityGroups
¶ Type: LoadBalancerSecurityGroups
(readonly)
-
class
LoadBalancerAttributeProperty
¶ -
key
¶ LoadBalancerResource.LoadBalancerAttributeProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-key
Type: string or Token
or None
-
value
¶ LoadBalancerResource.LoadBalancerAttributeProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-value
Type: string or Token
or None
-
-
class
SubnetMappingProperty
¶ -
allocationId
¶ LoadBalancerResource.SubnetMappingProperty.AllocationId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-allocationid
Type: string or Token
-
subnetId
¶ LoadBalancerResource.SubnetMappingProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-subnetid
Type: string or Token
-
- parent (
LoadBalancerResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
LoadBalancerResourceProps
¶ -
ipAddressType
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.IpAddressType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipaddresstype
Type: string or Token
or None
-
loadBalancerAttributes
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes
Type: Token
orToken
orLoadBalancerAttributeProperty
or None
-
loadBalancerName
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-name
Type: string or Token
or None
-
scheme
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.Scheme http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme
Type: string or Token
or None
-
securityGroups
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.SecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-securitygroups
Type: Token
or string orToken
or None
-
subnetMappings
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings
Type: Token
orToken
orSubnetMappingProperty
or None
-
subnets
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.Subnets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnets
Type: Token
or string orToken
or None
AWS::ElasticLoadBalancingV2::LoadBalancer.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags
Type: Token
orToken
orTag
or None
-
type
¶ AWS::ElasticLoadBalancingV2::LoadBalancer.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-type
Type: string or Token
or None
-
LoadBalancerSecurityGroups¶
TargetGroupFullName¶
TargetGroupLoadBalancerArns¶
TargetGroupName¶
TargetGroupResource¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
TargetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TargetGroupResource is a part of - name (string) –
- props (
TargetGroupResourceProps
or None) – the properties of this TargetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
targetGroupLoadBalancerArns
¶ Type: TargetGroupLoadBalancerArns
(readonly)
-
targetGroupFullName
¶ Type: TargetGroupFullName
(readonly)
-
targetGroupName
¶ Type: TargetGroupName
(readonly)
-
class
MatcherProperty
¶ -
httpCode
¶ TargetGroupResource.MatcherProperty.HttpCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html#cfn-elasticloadbalancingv2-targetgroup-matcher-httpcode
Type: string or Token
-
-
class
TargetDescriptionProperty
¶ -
availabilityZone
¶ TargetGroupResource.TargetDescriptionProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-availabilityzone
Type: string or Token
or None
-
id
¶ TargetGroupResource.TargetDescriptionProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-id
Type: string or Token
-
port
¶ TargetGroupResource.TargetDescriptionProperty.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-port
Type: number or Token
or None
-
-
class
TargetGroupAttributeProperty
¶ -
key
¶ TargetGroupResource.TargetGroupAttributeProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-key
Type: string or Token
or None
-
value
¶ TargetGroupResource.TargetGroupAttributeProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-value
Type: string or Token
or None
-
- parent (
TargetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticloadbalancingv2.
TargetGroupResourceProps
¶ -
healthCheckIntervalSeconds
¶ AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckIntervalSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds
Type: number or Token
or None
-
healthCheckPath
¶ AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath
Type: string or Token
or None
-
healthCheckPort
¶ AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport
Type: string or Token
or None
-
healthCheckProtocol
¶ AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckProtocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol
Type: string or Token
or None
-
healthCheckTimeoutSeconds
¶ AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckTimeoutSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds
Type: number or Token
or None
-
healthyThresholdCount
¶ AWS::ElasticLoadBalancingV2::TargetGroup.HealthyThresholdCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount
Type: number or Token
or None
-
matcher
¶ AWS::ElasticLoadBalancingV2::TargetGroup.Matcher http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher
Type: Token
orMatcherProperty
or None
-
targetGroupName
¶ AWS::ElasticLoadBalancingV2::TargetGroup.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name
Type: string or Token
or None
-
port
¶ AWS::ElasticLoadBalancingV2::TargetGroup.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port
Type: number or Token
-
protocol
¶ AWS::ElasticLoadBalancingV2::TargetGroup.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol
Type: string or Token
AWS::ElasticLoadBalancingV2::TargetGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags
Type: Token
orToken
orTag
or None
-
targetGroupAttributes
¶ AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes
Type: Token
orToken
orTargetGroupAttributeProperty
or None
-
targetType
¶ AWS::ElasticLoadBalancingV2::TargetGroup.TargetType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype
Type: string or Token
or None
-
targets
¶ AWS::ElasticLoadBalancingV2::TargetGroup.Targets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets
Type: Token
orToken
orTargetDescriptionProperty
or None
-
unhealthyThresholdCount
¶ AWS::ElasticLoadBalancingV2::TargetGroup.UnhealthyThresholdCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount
Type: number or Token
or None
-
vpcId
¶ AWS::ElasticLoadBalancingV2::TargetGroup.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid
Type: string or Token
-
elasticsearch¶
DomainArn¶
DomainEndpoint¶
DomainResource¶
-
class
_aws-cdk_resources.elasticsearch.
DomainResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DomainResource is a part of - name (string) –
- props (
DomainResourceProps
or None) – the properties of this DomainResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
domainArn
¶ Type: DomainArn
(readonly)
-
domainEndpoint
¶ Type: DomainEndpoint
(readonly)
-
class
EBSOptionsProperty
¶ -
ebsEnabled
¶ DomainResource.EBSOptionsProperty.EBSEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled
Type: boolean or Token
or None
-
iops
¶ DomainResource.EBSOptionsProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops
Type: number or Token
or None
-
volumeSize
¶ DomainResource.EBSOptionsProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize
Type: number or Token
or None
-
volumeType
¶ DomainResource.EBSOptionsProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype
Type: string or Token
or None
-
-
class
ElasticsearchClusterConfigProperty
¶ -
dedicatedMasterCount
¶ DomainResource.ElasticsearchClusterConfigProperty.DedicatedMasterCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount
Type: number or Token
or None
-
dedicatedMasterEnabled
¶ DomainResource.ElasticsearchClusterConfigProperty.DedicatedMasterEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled
Type: boolean or Token
or None
-
dedicatedMasterType
¶ DomainResource.ElasticsearchClusterConfigProperty.DedicatedMasterType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype
Type: string or Token
or None
-
instanceCount
¶ DomainResource.ElasticsearchClusterConfigProperty.InstanceCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount
Type: number or Token
or None
-
instanceType
¶ DomainResource.ElasticsearchClusterConfigProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype
Type: string or Token
or None
-
zoneAwarenessEnabled
¶ DomainResource.ElasticsearchClusterConfigProperty.ZoneAwarenessEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled
Type: boolean or Token
or None
-
-
class
EncryptionAtRestOptionsProperty
¶ -
enabled
¶ DomainResource.EncryptionAtRestOptionsProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled
Type: boolean or Token
or None
-
kmsKeyId
¶ DomainResource.EncryptionAtRestOptionsProperty.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid
Type: string or Token
or None
-
-
class
SnapshotOptionsProperty
¶ -
automatedSnapshotStartHour
¶ DomainResource.SnapshotOptionsProperty.AutomatedSnapshotStartHour http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour
Type: number or Token
or None
-
-
class
VPCOptionsProperty
¶ -
securityGroupIds
¶ DomainResource.VPCOptionsProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids
Type: Token
or string orToken
or None
-
subnetIds
¶ DomainResource.VPCOptionsProperty.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids
Type: Token
or string orToken
or None
-
- parent (
DomainResourceProps (interface)¶
-
class
_aws-cdk_resources.elasticsearch.
DomainResourceProps
¶ -
accessPolicies
¶ AWS::Elasticsearch::Domain.AccessPolicies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies
Type: json or Token
or None
-
advancedOptions
¶ AWS::Elasticsearch::Domain.AdvancedOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions
Type: Token
or string orToken
or None
-
domainName
¶ AWS::Elasticsearch::Domain.DomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname
Type: string or Token
or None
-
ebsOptions
¶ AWS::Elasticsearch::Domain.EBSOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions
Type: Token
orEBSOptionsProperty
or None
-
elasticsearchClusterConfig
¶ AWS::Elasticsearch::Domain.ElasticsearchClusterConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig
Type: Token
orElasticsearchClusterConfigProperty
or None
-
elasticsearchVersion
¶ AWS::Elasticsearch::Domain.ElasticsearchVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion
Type: string or Token
or None
-
encryptionAtRestOptions
¶ AWS::Elasticsearch::Domain.EncryptionAtRestOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions
Type: Token
orEncryptionAtRestOptionsProperty
or None
-
snapshotOptions
¶ AWS::Elasticsearch::Domain.SnapshotOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions
Type: Token
orSnapshotOptionsProperty
or None
AWS::Elasticsearch::Domain.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags
Type: Token
orToken
orTag
or None
-
vpcOptions
¶ AWS::Elasticsearch::Domain.VPCOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions
Type: Token
orVPCOptionsProperty
or None
-
emr¶
ClusterMasterPublicDns¶
ClusterResource¶
-
class
_aws-cdk_resources.emr.
ClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterResource is a part of - name (string) –
- props (
ClusterResourceProps
or None) – the properties of this ClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
clusterMasterPublicDns
¶ Type: ClusterMasterPublicDns
(readonly)
-
class
ApplicationProperty
¶ -
additionalInfo
¶ ClusterResource.ApplicationProperty.AdditionalInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-additionalinfo
Type: Token
or string orToken
or None
-
args
¶ ClusterResource.ApplicationProperty.Args http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-args
Type: Token
or string orToken
or None
-
name
¶ ClusterResource.ApplicationProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-name
Type: string or Token
or None
-
version
¶ ClusterResource.ApplicationProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html#cfn-elasticmapreduce-cluster-application-version
Type: string or Token
or None
-
-
class
AutoScalingPolicyProperty
¶ -
constraints
¶ ClusterResource.AutoScalingPolicyProperty.Constraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html#cfn-elasticmapreduce-cluster-autoscalingpolicy-constraints
Type: Token
orScalingConstraintsProperty
-
rules
¶ ClusterResource.AutoScalingPolicyProperty.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html#cfn-elasticmapreduce-cluster-autoscalingpolicy-rules
Type: Token
orToken
orScalingRuleProperty
-
-
class
BootstrapActionConfigProperty
¶ -
name
¶ ClusterResource.BootstrapActionConfigProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html#cfn-elasticmapreduce-cluster-bootstrapactionconfig-name
Type: string or Token
-
scriptBootstrapAction
¶ ClusterResource.BootstrapActionConfigProperty.ScriptBootstrapAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html#cfn-elasticmapreduce-cluster-bootstrapactionconfig-scriptbootstrapaction
Type: Token
orScriptBootstrapActionConfigProperty
-
-
class
CloudWatchAlarmDefinitionProperty
¶ -
comparisonOperator
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.ComparisonOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-comparisonoperator
Type: string or Token
-
dimensions
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.Dimensions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-dimensions
Type: Token
orToken
orMetricDimensionProperty
or None
-
evaluationPeriods
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.EvaluationPeriods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-evaluationperiods
Type: number or Token
or None
-
metricName
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-metricname
Type: string or Token
-
namespace
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-namespace
Type: string or Token
or None
-
period
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.Period http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-period
Type: number or Token
-
statistic
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.Statistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-statistic
Type: string or Token
or None
-
threshold
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.Threshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-threshold
Type: number or Token
-
unit
¶ ClusterResource.CloudWatchAlarmDefinitionProperty.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-cluster-cloudwatchalarmdefinition-unit
Type: string or Token
or None
-
-
class
ConfigurationProperty
¶ -
classification
¶ ClusterResource.ConfigurationProperty.Classification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-classification
Type: string or Token
or None
-
configurationProperties
¶ ClusterResource.ConfigurationProperty.ConfigurationProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-configurationproperties
Type: Token
or string orToken
or None
-
configurations
¶ ClusterResource.ConfigurationProperty.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html#cfn-elasticmapreduce-cluster-configuration-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
-
class
EbsBlockDeviceConfigProperty
¶ -
volumeSpecification
¶ ClusterResource.EbsBlockDeviceConfigProperty.VolumeSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html#cfn-elasticmapreduce-cluster-ebsblockdeviceconfig-volumespecification
Type: Token
orVolumeSpecificationProperty
-
volumesPerInstance
¶ ClusterResource.EbsBlockDeviceConfigProperty.VolumesPerInstance http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html#cfn-elasticmapreduce-cluster-ebsblockdeviceconfig-volumesperinstance
Type: number or Token
or None
-
-
class
EbsConfigurationProperty
¶ -
ebsBlockDeviceConfigs
¶ ClusterResource.EbsConfigurationProperty.EbsBlockDeviceConfigs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html#cfn-elasticmapreduce-cluster-ebsconfiguration-ebsblockdeviceconfigs
Type: Token
orToken
orEbsBlockDeviceConfigProperty
or None
-
ebsOptimized
¶ ClusterResource.EbsConfigurationProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsconfiguration.html#cfn-elasticmapreduce-cluster-ebsconfiguration-ebsoptimized
Type: boolean or Token
or None
-
-
class
InstanceFleetConfigProperty
¶ -
instanceTypeConfigs
¶ ClusterResource.InstanceFleetConfigProperty.InstanceTypeConfigs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-instancetypeconfigs
Type: Token
orToken
orInstanceTypeConfigProperty
or None
-
launchSpecifications
¶ ClusterResource.InstanceFleetConfigProperty.LaunchSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-launchspecifications
Type: Token
orInstanceFleetProvisioningSpecificationsProperty
or None
-
name
¶ ClusterResource.InstanceFleetConfigProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-name
Type: string or Token
or None
-
targetOnDemandCapacity
¶ ClusterResource.InstanceFleetConfigProperty.TargetOnDemandCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-targetondemandcapacity
Type: number or Token
or None
-
targetSpotCapacity
¶ ClusterResource.InstanceFleetConfigProperty.TargetSpotCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html#cfn-elasticmapreduce-cluster-instancefleetconfig-targetspotcapacity
Type: number or Token
or None
-
-
class
InstanceFleetProvisioningSpecificationsProperty
¶ -
spotSpecification
¶ ClusterResource.InstanceFleetProvisioningSpecificationsProperty.SpotSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-cluster-instancefleetprovisioningspecifications-spotspecification
Type: Token
orSpotProvisioningSpecificationProperty
-
-
class
InstanceGroupConfigProperty
¶ -
autoScalingPolicy
¶ ClusterResource.InstanceGroupConfigProperty.AutoScalingPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-autoscalingpolicy
Type: Token
orAutoScalingPolicyProperty
or None
-
bidPrice
¶ ClusterResource.InstanceGroupConfigProperty.BidPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-bidprice
Type: string or Token
or None
-
configurations
¶ ClusterResource.InstanceGroupConfigProperty.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
ebsConfiguration
¶ ClusterResource.InstanceGroupConfigProperty.EbsConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-ebsconfiguration
Type: Token
orEbsConfigurationProperty
or None
-
instanceCount
¶ ClusterResource.InstanceGroupConfigProperty.InstanceCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-instancecount
Type: number or Token
-
instanceType
¶ ClusterResource.InstanceGroupConfigProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-instancetype
Type: string or Token
-
market
¶ ClusterResource.InstanceGroupConfigProperty.Market http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-market
Type: string or Token
or None
-
name
¶ ClusterResource.InstanceGroupConfigProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html#cfn-elasticmapreduce-cluster-instancegroupconfig-name
Type: string or Token
or None
-
-
class
InstanceTypeConfigProperty
¶ -
bidPrice
¶ ClusterResource.InstanceTypeConfigProperty.BidPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-bidprice
Type: string or Token
or None
-
bidPriceAsPercentageOfOnDemandPrice
¶ ClusterResource.InstanceTypeConfigProperty.BidPriceAsPercentageOfOnDemandPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-bidpriceaspercentageofondemandprice
Type: number or Token
or None
-
configurations
¶ ClusterResource.InstanceTypeConfigProperty.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
ebsConfiguration
¶ ClusterResource.InstanceTypeConfigProperty.EbsConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-ebsconfiguration
Type: Token
orEbsConfigurationProperty
or None
-
instanceType
¶ ClusterResource.InstanceTypeConfigProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-instancetype
Type: string or Token
-
weightedCapacity
¶ ClusterResource.InstanceTypeConfigProperty.WeightedCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancetypeconfig.html#cfn-elasticmapreduce-cluster-instancetypeconfig-weightedcapacity
Type: number or Token
or None
-
-
class
JobFlowInstancesConfigProperty
¶ -
additionalMasterSecurityGroups
¶ ClusterResource.JobFlowInstancesConfigProperty.AdditionalMasterSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-additionalmastersecuritygroups
Type: Token
or string orToken
or None
-
additionalSlaveSecurityGroups
¶ ClusterResource.JobFlowInstancesConfigProperty.AdditionalSlaveSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-additionalslavesecuritygroups
Type: Token
or string orToken
or None
-
coreInstanceFleet
¶ ClusterResource.JobFlowInstancesConfigProperty.CoreInstanceFleet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-coreinstancefleet
Type: Token
orInstanceFleetConfigProperty
or None
-
coreInstanceGroup
¶ ClusterResource.JobFlowInstancesConfigProperty.CoreInstanceGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-coreinstancegroup
Type: Token
orInstanceGroupConfigProperty
or None
-
ec2KeyName
¶ ClusterResource.JobFlowInstancesConfigProperty.Ec2KeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2keyname
Type: string or Token
or None
-
ec2SubnetId
¶ ClusterResource.JobFlowInstancesConfigProperty.Ec2SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-ec2subnetid
Type: string or Token
or None
-
emrManagedMasterSecurityGroup
¶ ClusterResource.JobFlowInstancesConfigProperty.EmrManagedMasterSecurityGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-emrmanagedmastersecuritygroup
Type: string or Token
or None
-
emrManagedSlaveSecurityGroup
¶ ClusterResource.JobFlowInstancesConfigProperty.EmrManagedSlaveSecurityGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-emrmanagedslavesecuritygroup
Type: string or Token
or None
-
hadoopVersion
¶ ClusterResource.JobFlowInstancesConfigProperty.HadoopVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-hadoopversion
Type: string or Token
or None
-
masterInstanceFleet
¶ ClusterResource.JobFlowInstancesConfigProperty.MasterInstanceFleet http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-masterinstancefleet
Type: Token
orInstanceFleetConfigProperty
or None
-
masterInstanceGroup
¶ ClusterResource.JobFlowInstancesConfigProperty.MasterInstanceGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-masterinstancegroup
Type: Token
orInstanceGroupConfigProperty
or None
-
placement
¶ ClusterResource.JobFlowInstancesConfigProperty.Placement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-placement
Type: Token
orPlacementTypeProperty
or None
-
serviceAccessSecurityGroup
¶ ClusterResource.JobFlowInstancesConfigProperty.ServiceAccessSecurityGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-serviceaccesssecuritygroup
Type: string or Token
or None
-
terminationProtected
¶ ClusterResource.JobFlowInstancesConfigProperty.TerminationProtected http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-jobflowinstancesconfig.html#cfn-elasticmapreduce-cluster-jobflowinstancesconfig-terminationprotected
Type: boolean or Token
or None
-
-
class
MetricDimensionProperty
¶ -
key
¶ ClusterResource.MetricDimensionProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html#cfn-elasticmapreduce-cluster-metricdimension-key
Type: string or Token
-
value
¶ ClusterResource.MetricDimensionProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-metricdimension.html#cfn-elasticmapreduce-cluster-metricdimension-value
Type: string or Token
-
-
class
PlacementTypeProperty
¶ -
availabilityZone
¶ ClusterResource.PlacementTypeProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementtype.html#cfn-elasticmapreduce-cluster-placementtype-availabilityzone
Type: string or Token
-
-
class
ScalingActionProperty
¶ -
market
¶ ClusterResource.ScalingActionProperty.Market http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html#cfn-elasticmapreduce-cluster-scalingaction-market
Type: string or Token
or None
-
simpleScalingPolicyConfiguration
¶ ClusterResource.ScalingActionProperty.SimpleScalingPolicyConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingaction.html#cfn-elasticmapreduce-cluster-scalingaction-simplescalingpolicyconfiguration
Type: Token
orSimpleScalingPolicyConfigurationProperty
-
-
class
ScalingConstraintsProperty
¶ -
maxCapacity
¶ ClusterResource.ScalingConstraintsProperty.MaxCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html#cfn-elasticmapreduce-cluster-scalingconstraints-maxcapacity
Type: number or Token
-
minCapacity
¶ ClusterResource.ScalingConstraintsProperty.MinCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html#cfn-elasticmapreduce-cluster-scalingconstraints-mincapacity
Type: number or Token
-
-
class
ScalingRuleProperty
¶ -
action
¶ ClusterResource.ScalingRuleProperty.Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-action
Type: Token
orScalingActionProperty
-
description
¶ ClusterResource.ScalingRuleProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-description
Type: string or Token
or None
-
name
¶ ClusterResource.ScalingRuleProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-name
Type: string or Token
-
trigger
¶ ClusterResource.ScalingRuleProperty.Trigger http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-trigger
Type: Token
orScalingTriggerProperty
-
-
class
ScalingTriggerProperty
¶ -
cloudWatchAlarmDefinition
¶ ClusterResource.ScalingTriggerProperty.CloudWatchAlarmDefinition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingtrigger.html#cfn-elasticmapreduce-cluster-scalingtrigger-cloudwatchalarmdefinition
Type: Token
orCloudWatchAlarmDefinitionProperty
-
-
class
ScriptBootstrapActionConfigProperty
¶ -
args
¶ ClusterResource.ScriptBootstrapActionConfigProperty.Args http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html#cfn-elasticmapreduce-cluster-scriptbootstrapactionconfig-args
Type: Token
or string orToken
or None
-
path
¶ ClusterResource.ScriptBootstrapActionConfigProperty.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html#cfn-elasticmapreduce-cluster-scriptbootstrapactionconfig-path
Type: string or Token
-
-
class
SimpleScalingPolicyConfigurationProperty
¶ -
adjustmentType
¶ ClusterResource.SimpleScalingPolicyConfigurationProperty.AdjustmentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-adjustmenttype
Type: string or Token
or None
-
coolDown
¶ ClusterResource.SimpleScalingPolicyConfigurationProperty.CoolDown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-cooldown
Type: number or Token
or None
-
scalingAdjustment
¶ ClusterResource.SimpleScalingPolicyConfigurationProperty.ScalingAdjustment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-cluster-simplescalingpolicyconfiguration-scalingadjustment
Type: number or Token
-
-
class
SpotProvisioningSpecificationProperty
¶ -
blockDurationMinutes
¶ ClusterResource.SpotProvisioningSpecificationProperty.BlockDurationMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-blockdurationminutes
Type: number or Token
or None
-
timeoutAction
¶ ClusterResource.SpotProvisioningSpecificationProperty.TimeoutAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-timeoutaction
Type: string or Token
-
timeoutDurationMinutes
¶ ClusterResource.SpotProvisioningSpecificationProperty.TimeoutDurationMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html#cfn-elasticmapreduce-cluster-spotprovisioningspecification-timeoutdurationminutes
Type: number or Token
-
-
class
VolumeSpecificationProperty
¶ -
iops
¶ ClusterResource.VolumeSpecificationProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-iops
Type: number or Token
or None
-
sizeInGb
¶ ClusterResource.VolumeSpecificationProperty.SizeInGB http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-sizeingb
Type: number or Token
-
volumeType
¶ ClusterResource.VolumeSpecificationProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html#cfn-elasticmapreduce-cluster-volumespecification-volumetype
Type: string or Token
-
- parent (
ClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.emr.
ClusterResourceProps
¶ -
additionalInfo
¶ AWS::EMR::Cluster.AdditionalInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-additionalinfo
Type: json or Token
or None
-
applications
¶ AWS::EMR::Cluster.Applications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-applications
Type: Token
orToken
orApplicationProperty
or None
-
autoScalingRole
¶ AWS::EMR::Cluster.AutoScalingRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-autoscalingrole
Type: string or Token
or None
-
bootstrapActions
¶ AWS::EMR::Cluster.BootstrapActions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-bootstrapactions
Type: Token
orToken
orBootstrapActionConfigProperty
or None
-
configurations
¶ AWS::EMR::Cluster.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
customAmiId
¶ AWS::EMR::Cluster.CustomAmiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-customamiid
Type: string or Token
or None
-
ebsRootVolumeSize
¶ AWS::EMR::Cluster.EbsRootVolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-ebsrootvolumesize
Type: number or Token
or None
-
instances
¶ AWS::EMR::Cluster.Instances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-instances
Type: Token
orJobFlowInstancesConfigProperty
-
jobFlowRole
¶ AWS::EMR::Cluster.JobFlowRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-jobflowrole
Type: string or Token
-
logUri
¶ AWS::EMR::Cluster.LogUri http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-loguri
Type: string or Token
or None
-
clusterName
¶ AWS::EMR::Cluster.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-name
Type: string or Token
-
releaseLabel
¶ AWS::EMR::Cluster.ReleaseLabel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-releaselabel
Type: string or Token
or None
-
scaleDownBehavior
¶ AWS::EMR::Cluster.ScaleDownBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-scaledownbehavior
Type: string or Token
or None
-
securityConfiguration
¶ AWS::EMR::Cluster.SecurityConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-securityconfiguration
Type: string or Token
or None
-
serviceRole
¶ AWS::EMR::Cluster.ServiceRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-servicerole
Type: string or Token
AWS::EMR::Cluster.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-tags
Type: Token
orToken
orTag
or None
-
visibleToAllUsers
¶ AWS::EMR::Cluster.VisibleToAllUsers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-cluster.html#cfn-elasticmapreduce-cluster-visibletoallusers
Type: boolean or Token
or None
-
InstanceFleetConfigResource¶
-
class
_aws-cdk_resources.emr.
InstanceFleetConfigResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InstanceFleetConfigResource is a part of - name (string) –
- props (
InstanceFleetConfigResourceProps
or None) – the properties of this InstanceFleetConfigResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ConfigurationProperty
¶ -
classification
¶ InstanceFleetConfigResource.ConfigurationProperty.Classification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-classification
Type: string or Token
or None
-
configurationProperties
¶ InstanceFleetConfigResource.ConfigurationProperty.ConfigurationProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-configurationproperties
Type: Token
or string orToken
or None
-
configurations
¶ InstanceFleetConfigResource.ConfigurationProperty.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#cfn-elasticmapreduce-instancefleetconfig-configuration-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
-
class
EbsBlockDeviceConfigProperty
¶ -
volumeSpecification
¶ InstanceFleetConfigResource.EbsBlockDeviceConfigProperty.VolumeSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html#cfn-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig-volumespecification
Type: Token
orVolumeSpecificationProperty
-
volumesPerInstance
¶ InstanceFleetConfigResource.EbsBlockDeviceConfigProperty.VolumesPerInstance http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html#cfn-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig-volumesperinstance
Type: number or Token
or None
-
-
class
EbsConfigurationProperty
¶ -
ebsBlockDeviceConfigs
¶ InstanceFleetConfigResource.EbsConfigurationProperty.EbsBlockDeviceConfigs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html#cfn-elasticmapreduce-instancefleetconfig-ebsconfiguration-ebsblockdeviceconfigs
Type: Token
orToken
orEbsBlockDeviceConfigProperty
or None
-
ebsOptimized
¶ InstanceFleetConfigResource.EbsConfigurationProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsconfiguration.html#cfn-elasticmapreduce-instancefleetconfig-ebsconfiguration-ebsoptimized
Type: boolean or Token
or None
-
-
class
InstanceFleetProvisioningSpecificationsProperty
¶ -
spotSpecification
¶ InstanceFleetConfigResource.InstanceFleetProvisioningSpecificationsProperty.SpotSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications.html#cfn-elasticmapreduce-instancefleetconfig-instancefleetprovisioningspecifications-spotspecification
Type: Token
orSpotProvisioningSpecificationProperty
-
-
class
InstanceTypeConfigProperty
¶ -
bidPrice
¶ InstanceFleetConfigResource.InstanceTypeConfigProperty.BidPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-bidprice
Type: string or Token
or None
-
bidPriceAsPercentageOfOnDemandPrice
¶ InstanceFleetConfigResource.InstanceTypeConfigProperty.BidPriceAsPercentageOfOnDemandPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-bidpriceaspercentageofondemandprice
Type: number or Token
or None
-
configurations
¶ InstanceFleetConfigResource.InstanceTypeConfigProperty.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
ebsConfiguration
¶ InstanceFleetConfigResource.InstanceTypeConfigProperty.EbsConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-ebsconfiguration
Type: Token
orEbsConfigurationProperty
or None
-
instanceType
¶ InstanceFleetConfigResource.InstanceTypeConfigProperty.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-instancetype
Type: string or Token
-
weightedCapacity
¶ InstanceFleetConfigResource.InstanceTypeConfigProperty.WeightedCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-instancetypeconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfig-weightedcapacity
Type: number or Token
or None
-
-
class
SpotProvisioningSpecificationProperty
¶ -
blockDurationMinutes
¶ InstanceFleetConfigResource.SpotProvisioningSpecificationProperty.BlockDurationMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-blockdurationminutes
Type: number or Token
or None
-
timeoutAction
¶ InstanceFleetConfigResource.SpotProvisioningSpecificationProperty.TimeoutAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-timeoutaction
Type: string or Token
-
timeoutDurationMinutes
¶ InstanceFleetConfigResource.SpotProvisioningSpecificationProperty.TimeoutDurationMinutes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html#cfn-elasticmapreduce-instancefleetconfig-spotprovisioningspecification-timeoutdurationminutes
Type: number or Token
-
-
class
VolumeSpecificationProperty
¶ -
iops
¶ InstanceFleetConfigResource.VolumeSpecificationProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-iops
Type: number or Token
or None
-
sizeInGb
¶ InstanceFleetConfigResource.VolumeSpecificationProperty.SizeInGB http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-sizeingb
Type: number or Token
-
volumeType
¶ InstanceFleetConfigResource.VolumeSpecificationProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html#cfn-elasticmapreduce-instancefleetconfig-volumespecification-volumetype
Type: string or Token
-
- parent (
InstanceFleetConfigResourceProps (interface)¶
-
class
_aws-cdk_resources.emr.
InstanceFleetConfigResourceProps
¶ -
clusterId
¶ AWS::EMR::InstanceFleetConfig.ClusterId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-clusterid
Type: string or Token
-
instanceFleetType
¶ AWS::EMR::InstanceFleetConfig.InstanceFleetType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancefleettype
Type: string or Token
-
instanceTypeConfigs
¶ AWS::EMR::InstanceFleetConfig.InstanceTypeConfigs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-instancetypeconfigs
Type: Token
orToken
orInstanceTypeConfigProperty
or None
-
launchSpecifications
¶ AWS::EMR::InstanceFleetConfig.LaunchSpecifications http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-launchspecifications
Type: Token
orInstanceFleetProvisioningSpecificationsProperty
or None
-
instanceFleetConfigName
¶ AWS::EMR::InstanceFleetConfig.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-name
Type: string or Token
or None
-
targetOnDemandCapacity
¶ AWS::EMR::InstanceFleetConfig.TargetOnDemandCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-targetondemandcapacity
Type: number or Token
or None
-
targetSpotCapacity
¶ AWS::EMR::InstanceFleetConfig.TargetSpotCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticmapreduce-instancefleetconfig.html#cfn-elasticmapreduce-instancefleetconfig-targetspotcapacity
Type: number or Token
or None
-
InstanceGroupConfigResource¶
-
class
_aws-cdk_resources.emr.
InstanceGroupConfigResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InstanceGroupConfigResource is a part of - name (string) –
- props (
InstanceGroupConfigResourceProps
or None) – the properties of this InstanceGroupConfigResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AutoScalingPolicyProperty
¶ -
constraints
¶ InstanceGroupConfigResource.AutoScalingPolicyProperty.Constraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy-constraints
Type: Token
orScalingConstraintsProperty
-
rules
¶ InstanceGroupConfigResource.AutoScalingPolicyProperty.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy-rules
Type: Token
orToken
orScalingRuleProperty
-
-
class
CloudWatchAlarmDefinitionProperty
¶ -
comparisonOperator
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.ComparisonOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-comparisonoperator
Type: string or Token
-
dimensions
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.Dimensions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-dimensions
Type: Token
orToken
orMetricDimensionProperty
or None
-
evaluationPeriods
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.EvaluationPeriods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-evaluationperiods
Type: number or Token
or None
-
metricName
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-metricname
Type: string or Token
-
namespace
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.Namespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-namespace
Type: string or Token
or None
-
period
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.Period http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-period
Type: number or Token
-
statistic
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.Statistic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-statistic
Type: string or Token
or None
-
threshold
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.Threshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-threshold
Type: number or Token
-
unit
¶ InstanceGroupConfigResource.CloudWatchAlarmDefinitionProperty.Unit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition.html#cfn-elasticmapreduce-instancegroupconfig-cloudwatchalarmdefinition-unit
Type: string or Token
or None
-
-
class
ConfigurationProperty
¶ -
classification
¶ InstanceGroupConfigResource.ConfigurationProperty.Classification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-classification
Type: string or Token
or None
-
configurationProperties
¶ InstanceGroupConfigResource.ConfigurationProperty.ConfigurationProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-configurationproperties
Type: Token
or string orToken
or None
-
configurations
¶ InstanceGroupConfigResource.ConfigurationProperty.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-configuration.html#cfn-emr-cluster-configuration-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
-
class
EbsBlockDeviceConfigProperty
¶ -
volumeSpecification
¶ InstanceGroupConfigResource.EbsBlockDeviceConfigProperty.VolumeSpecification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification
Type: Token
orVolumeSpecificationProperty
-
volumesPerInstance
¶ InstanceGroupConfigResource.EbsBlockDeviceConfigProperty.VolumesPerInstance http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumesperinstance
Type: number or Token
or None
-
-
class
EbsConfigurationProperty
¶ -
ebsBlockDeviceConfigs
¶ InstanceGroupConfigResource.EbsConfigurationProperty.EbsBlockDeviceConfigs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfigs
Type: Token
orToken
orEbsBlockDeviceConfigProperty
or None
-
ebsOptimized
¶ InstanceGroupConfigResource.EbsConfigurationProperty.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration.html#cfn-emr-ebsconfiguration-ebsoptimized
Type: boolean or Token
or None
-
-
class
MetricDimensionProperty
¶ -
key
¶ InstanceGroupConfigResource.MetricDimensionProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html#cfn-elasticmapreduce-instancegroupconfig-metricdimension-key
Type: string or Token
-
value
¶ InstanceGroupConfigResource.MetricDimensionProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-metricdimension.html#cfn-elasticmapreduce-instancegroupconfig-metricdimension-value
Type: string or Token
-
-
class
ScalingActionProperty
¶ -
market
¶ InstanceGroupConfigResource.ScalingActionProperty.Market http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html#cfn-elasticmapreduce-instancegroupconfig-scalingaction-market
Type: string or Token
or None
-
simpleScalingPolicyConfiguration
¶ InstanceGroupConfigResource.ScalingActionProperty.SimpleScalingPolicyConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingaction.html#cfn-elasticmapreduce-instancegroupconfig-scalingaction-simplescalingpolicyconfiguration
Type: Token
orSimpleScalingPolicyConfigurationProperty
-
-
class
ScalingConstraintsProperty
¶ -
maxCapacity
¶ InstanceGroupConfigResource.ScalingConstraintsProperty.MaxCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html#cfn-elasticmapreduce-instancegroupconfig-scalingconstraints-maxcapacity
Type: number or Token
-
minCapacity
¶ InstanceGroupConfigResource.ScalingConstraintsProperty.MinCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingconstraints.html#cfn-elasticmapreduce-instancegroupconfig-scalingconstraints-mincapacity
Type: number or Token
-
-
class
ScalingRuleProperty
¶ -
action
¶ InstanceGroupConfigResource.ScalingRuleProperty.Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-action
Type: Token
orScalingActionProperty
-
description
¶ InstanceGroupConfigResource.ScalingRuleProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-description
Type: string or Token
or None
-
name
¶ InstanceGroupConfigResource.ScalingRuleProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-name
Type: string or Token
-
trigger
¶ InstanceGroupConfigResource.ScalingRuleProperty.Trigger http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingrule.html#cfn-elasticmapreduce-instancegroupconfig-scalingrule-trigger
Type: Token
orScalingTriggerProperty
-
-
class
ScalingTriggerProperty
¶ -
cloudWatchAlarmDefinition
¶ InstanceGroupConfigResource.ScalingTriggerProperty.CloudWatchAlarmDefinition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-scalingtrigger.html#cfn-elasticmapreduce-instancegroupconfig-scalingtrigger-cloudwatchalarmdefinition
Type: Token
orCloudWatchAlarmDefinitionProperty
-
-
class
SimpleScalingPolicyConfigurationProperty
¶ -
adjustmentType
¶ InstanceGroupConfigResource.SimpleScalingPolicyConfigurationProperty.AdjustmentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-adjustmenttype
Type: string or Token
or None
-
coolDown
¶ InstanceGroupConfigResource.SimpleScalingPolicyConfigurationProperty.CoolDown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-cooldown
Type: number or Token
or None
-
scalingAdjustment
¶ InstanceGroupConfigResource.SimpleScalingPolicyConfigurationProperty.ScalingAdjustment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration.html#cfn-elasticmapreduce-instancegroupconfig-simplescalingpolicyconfiguration-scalingadjustment
Type: number or Token
-
-
class
VolumeSpecificationProperty
¶ -
iops
¶ InstanceGroupConfigResource.VolumeSpecificationProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-iops
Type: number or Token
or None
-
sizeInGb
¶ InstanceGroupConfigResource.VolumeSpecificationProperty.SizeInGB http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-sizeingb
Type: number or Token
-
volumeType
¶ InstanceGroupConfigResource.VolumeSpecificationProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html#cfn-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification-volumetype
Type: string or Token
-
- parent (
InstanceGroupConfigResourceProps (interface)¶
-
class
_aws-cdk_resources.emr.
InstanceGroupConfigResourceProps
¶ -
autoScalingPolicy
¶ AWS::EMR::InstanceGroupConfig.AutoScalingPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-elasticmapreduce-instancegroupconfig-autoscalingpolicy
Type: Token
orAutoScalingPolicyProperty
or None
-
bidPrice
¶ AWS::EMR::InstanceGroupConfig.BidPrice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-bidprice
Type: string or Token
or None
-
configurations
¶ AWS::EMR::InstanceGroupConfig.Configurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-configurations
Type: Token
orToken
orConfigurationProperty
or None
-
ebsConfiguration
¶ AWS::EMR::InstanceGroupConfig.EbsConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-ebsconfiguration
Type: Token
orEbsConfigurationProperty
or None
-
instanceCount
¶ AWS::EMR::InstanceGroupConfig.InstanceCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfiginstancecount-
Type: number or Token
-
instanceRole
¶ AWS::EMR::InstanceGroupConfig.InstanceRole http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-instancerole
Type: string or Token
-
instanceType
¶ AWS::EMR::InstanceGroupConfig.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-instancetype
Type: string or Token
-
jobFlowId
¶ AWS::EMR::InstanceGroupConfig.JobFlowId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-jobflowid
Type: string or Token
-
market
¶ AWS::EMR::InstanceGroupConfig.Market http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-market
Type: string or Token
or None
-
instanceGroupConfigName
¶ AWS::EMR::InstanceGroupConfig.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-instancegroupconfig.html#cfn-emr-instancegroupconfig-name
Type: string or Token
or None
-
SecurityConfigurationResource¶
-
class
_aws-cdk_resources.emr.
SecurityConfigurationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SecurityConfigurationResource is a part of - name (string) –
- props (
SecurityConfigurationResourceProps
or None) – the properties of this SecurityConfigurationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SecurityConfigurationResourceProps (interface)¶
-
class
_aws-cdk_resources.emr.
SecurityConfigurationResourceProps
¶ -
securityConfigurationName
¶ AWS::EMR::SecurityConfiguration.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html#cfn-emr-securityconfiguration-name
Type: string or Token
or None
-
securityConfiguration
¶ AWS::EMR::SecurityConfiguration.SecurityConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-securityconfiguration.html#cfn-emr-securityconfiguration-securityconfiguration
Type: json or Token
-
StepResource¶
-
class
_aws-cdk_resources.emr.
StepResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StepResource is a part of - name (string) –
- props (
StepResourceProps
or None) – the properties of this StepResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
HadoopJarStepConfigProperty
¶ -
args
¶ StepResource.HadoopJarStepConfigProperty.Args http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-args
Type: Token
or string orToken
or None
-
jar
¶ StepResource.HadoopJarStepConfigProperty.Jar http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-jar
Type: string or Token
-
mainClass
¶ StepResource.HadoopJarStepConfigProperty.MainClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-mainclass
Type: string or Token
or None
-
stepProperties
¶ StepResource.HadoopJarStepConfigProperty.StepProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-hadoopjarstepconfig.html#cfn-elasticmapreduce-step-hadoopjarstepconfig-stepproperties
Type: Token
orToken
orKeyValueProperty
or None
-
-
class
KeyValueProperty
¶ -
key
¶ StepResource.KeyValueProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-keyvalue.html#cfn-elasticmapreduce-step-keyvalue-key
Type: string or Token
or None
-
value
¶ StepResource.KeyValueProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-step-keyvalue.html#cfn-elasticmapreduce-step-keyvalue-value
Type: string or Token
or None
-
- parent (
StepResourceProps (interface)¶
-
class
_aws-cdk_resources.emr.
StepResourceProps
¶ -
actionOnFailure
¶ AWS::EMR::Step.ActionOnFailure http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-actiononfailure
Type: string or Token
-
hadoopJarStep
¶ AWS::EMR::Step.HadoopJarStep http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-hadoopjarstep
Type: Token
orHadoopJarStepConfigProperty
-
jobFlowId
¶ AWS::EMR::Step.JobFlowId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-jobflowid
Type: string or Token
-
stepName
¶ AWS::EMR::Step.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-name
Type: string or Token
-
events¶
RuleArn¶
RuleResource¶
-
class
_aws-cdk_resources.events.
RuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RuleResource is a part of - name (string) –
- props (
RuleResourceProps
or None) – the properties of this RuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
ruleArn
¶ Type: RuleArn
(readonly)
-
class
EcsParametersProperty
¶ -
taskCount
¶ RuleResource.EcsParametersProperty.TaskCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount
Type: number or Token
or None
-
taskDefinitionArn
¶ RuleResource.EcsParametersProperty.TaskDefinitionArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn
Type: string or Token
-
-
class
InputTransformerProperty
¶ -
inputPathsMap
¶ RuleResource.InputTransformerProperty.InputPathsMap http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap
Type: Token
or string orToken
or None
-
inputTemplate
¶ RuleResource.InputTransformerProperty.InputTemplate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate
Type: string or Token
-
-
class
KinesisParametersProperty
¶ -
partitionKeyPath
¶ RuleResource.KinesisParametersProperty.PartitionKeyPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath
Type: string or Token
-
-
class
RunCommandParametersProperty
¶ -
runCommandTargets
¶ RuleResource.RunCommandParametersProperty.RunCommandTargets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets
Type: Token
orToken
orRunCommandTargetProperty
-
-
class
RunCommandTargetProperty
¶ -
key
¶ RuleResource.RunCommandTargetProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key
Type: string or Token
-
values
¶ RuleResource.RunCommandTargetProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values
Type: Token
or string orToken
-
-
class
TargetProperty
¶ -
arn
¶ RuleResource.TargetProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn
Type: string or Token
-
ecsParameters
¶ RuleResource.TargetProperty.EcsParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters
Type: Token
orEcsParametersProperty
or None
-
id
¶ RuleResource.TargetProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id
Type: string or Token
-
input
¶ RuleResource.TargetProperty.Input http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input
Type: string or Token
or None
-
inputPath
¶ RuleResource.TargetProperty.InputPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath
Type: string or Token
or None
-
inputTransformer
¶ RuleResource.TargetProperty.InputTransformer http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer
Type: Token
orInputTransformerProperty
or None
-
kinesisParameters
¶ RuleResource.TargetProperty.KinesisParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters
Type: Token
orKinesisParametersProperty
or None
-
roleArn
¶ RuleResource.TargetProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn
Type: string or Token
or None
-
runCommandParameters
¶ RuleResource.TargetProperty.RunCommandParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters
Type: Token
orRunCommandParametersProperty
or None
-
- parent (
RuleResourceProps (interface)¶
-
class
_aws-cdk_resources.events.
RuleResourceProps
¶ -
description
¶ AWS::Events::Rule.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description
Type: string or Token
or None
-
eventPattern
¶ AWS::Events::Rule.EventPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern
Type: json or Token
or None
-
ruleName
¶ AWS::Events::Rule.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name
Type: string or Token
or None
-
roleArn
¶ AWS::Events::Rule.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn
Type: string or Token
or None
-
scheduleExpression
¶ AWS::Events::Rule.ScheduleExpression http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression
Type: string or Token
or None
-
state
¶ AWS::Events::Rule.State http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state
Type: string or Token
or None
-
targets
¶ AWS::Events::Rule.Targets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets
Type: Token
orToken
orTargetProperty
or None
-
gamelift¶
AliasResource¶
-
class
_aws-cdk_resources.gamelift.
AliasResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AliasResource is a part of - name (string) –
- props (
AliasResourceProps
or None) – the properties of this AliasResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
RoutingStrategyProperty
¶ -
fleetId
¶ AliasResource.RoutingStrategyProperty.FleetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-fleetid
Type: string or Token
or None
-
message
¶ AliasResource.RoutingStrategyProperty.Message http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-message
Type: string or Token
or None
-
type
¶ AliasResource.RoutingStrategyProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-alias-routingstrategy.html#cfn-gamelift-alias-routingstrategy-type
Type: string or Token
-
- parent (
AliasResourceProps (interface)¶
-
class
_aws-cdk_resources.gamelift.
AliasResourceProps
¶ -
description
¶ AWS::GameLift::Alias.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-description
Type: string or Token
or None
-
aliasName
¶ AWS::GameLift::Alias.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-name
Type: string or Token
-
routingStrategy
¶ AWS::GameLift::Alias.RoutingStrategy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-alias.html#cfn-gamelift-alias-routingstrategy
Type: Token
orRoutingStrategyProperty
-
BuildResource¶
-
class
_aws-cdk_resources.gamelift.
BuildResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this BuildResource is a part of - name (string) –
- props (
BuildResourceProps
or None) – the properties of this BuildResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
S3LocationProperty
¶ -
bucket
¶ BuildResource.S3LocationProperty.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-bucket
Type: string or Token
-
key
¶ BuildResource.S3LocationProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-key
Type: string or Token
-
roleArn
¶ BuildResource.S3LocationProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html#cfn-gamelift-build-storage-rolearn
Type: string or Token
-
- parent (
BuildResourceProps (interface)¶
-
class
_aws-cdk_resources.gamelift.
BuildResourceProps
¶ -
buildName
¶ AWS::GameLift::Build.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name
Type: string or Token
or None
-
storageLocation
¶ AWS::GameLift::Build.StorageLocation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation
Type: Token
orS3LocationProperty
or None
-
version
¶ AWS::GameLift::Build.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version
Type: string or Token
or None
-
FleetResource¶
-
class
_aws-cdk_resources.gamelift.
FleetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this FleetResource is a part of - name (string) –
- props (
FleetResourceProps
or None) – the properties of this FleetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
IpPermissionProperty
¶ -
fromPort
¶ FleetResource.IpPermissionProperty.FromPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-fromport
Type: number or Token
-
ipRange
¶ FleetResource.IpPermissionProperty.IpRange http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-iprange
Type: string or Token
-
protocol
¶ FleetResource.IpPermissionProperty.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-protocol
Type: string or Token
-
toPort
¶ FleetResource.IpPermissionProperty.ToPort http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ec2inboundpermission.html#cfn-gamelift-fleet-ec2inboundpermissions-toport
Type: number or Token
-
- parent (
FleetResourceProps (interface)¶
-
class
_aws-cdk_resources.gamelift.
FleetResourceProps
¶ -
buildId
¶ AWS::GameLift::Fleet.BuildId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-buildid
Type: string or Token
-
description
¶ AWS::GameLift::Fleet.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-description
Type: string or Token
or None
-
desiredEc2Instances
¶ AWS::GameLift::Fleet.DesiredEC2Instances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances
Type: number or Token
-
ec2InboundPermissions
¶ AWS::GameLift::Fleet.EC2InboundPermissions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2inboundpermissions
Type: Token
orToken
orIpPermissionProperty
or None
-
ec2InstanceType
¶ AWS::GameLift::Fleet.EC2InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-ec2instancetype
Type: string or Token
-
logPaths
¶ AWS::GameLift::Fleet.LogPaths http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-logpaths
Type: Token
or string orToken
or None
-
maxSize
¶ AWS::GameLift::Fleet.MaxSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize
Type: number or Token
or None
-
minSize
¶ AWS::GameLift::Fleet.MinSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize
Type: number or Token
or None
-
fleetName
¶ AWS::GameLift::Fleet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-name
Type: string or Token
-
serverLaunchParameters
¶ AWS::GameLift::Fleet.ServerLaunchParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchparameters
Type: string or Token
or None
-
serverLaunchPath
¶ AWS::GameLift::Fleet.ServerLaunchPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-serverlaunchpath
Type: string or Token
-
glue¶
ClassifierResource¶
-
class
_aws-cdk_resources.glue.
ClassifierResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClassifierResource is a part of - name (string) –
- props (
ClassifierResourceProps
or None) – the properties of this ClassifierResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
GrokClassifierProperty
¶ -
customPatterns
¶ ClassifierResource.GrokClassifierProperty.CustomPatterns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-custompatterns
Type: string or Token
or None
-
grokPattern
¶ ClassifierResource.GrokClassifierProperty.GrokPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-grokpattern
Type: string or Token
-
classification
¶ ClassifierResource.GrokClassifierProperty.Classification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-classification
Type: string or Token
-
name
¶ ClassifierResource.GrokClassifierProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-name
Type: string or Token
or None
-
- parent (
ClassifierResourceProps (interface)¶
ConnectionResource¶
-
class
_aws-cdk_resources.glue.
ConnectionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ConnectionResource is a part of - name (string) –
- props (
ConnectionResourceProps
or None) – the properties of this ConnectionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ConnectionInputProperty
¶ -
description
¶ ConnectionResource.ConnectionInputProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description
Type: string or Token
or None
-
connectionType
¶ ConnectionResource.ConnectionInputProperty.ConnectionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype
Type: string or Token
-
matchCriteria
¶ ConnectionResource.ConnectionInputProperty.MatchCriteria http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria
Type: Token
or string orToken
or None
-
physicalConnectionRequirements
¶ ConnectionResource.ConnectionInputProperty.PhysicalConnectionRequirements http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements
Type: Token
orPhysicalConnectionRequirementsProperty
or None
-
connectionProperties
¶ ConnectionResource.ConnectionInputProperty.ConnectionProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties
Type: json or Token
-
name
¶ ConnectionResource.ConnectionInputProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-name
Type: string or Token
or None
-
-
class
PhysicalConnectionRequirementsProperty
¶ -
availabilityZone
¶ ConnectionResource.PhysicalConnectionRequirementsProperty.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-availabilityzone
Type: string or Token
or None
-
securityGroupIdList
¶ ConnectionResource.PhysicalConnectionRequirementsProperty.SecurityGroupIdList http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-securitygroupidlist
Type: Token
or string orToken
or None
-
subnetId
¶ ConnectionResource.PhysicalConnectionRequirementsProperty.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-subnetid
Type: string or Token
or None
-
- parent (
ConnectionResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
ConnectionResourceProps
¶ -
connectionInput
¶ AWS::Glue::Connection.ConnectionInput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-connectioninput
Type: Token
orConnectionInputProperty
-
catalogId
¶ AWS::Glue::Connection.CatalogId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-catalogid
Type: string or Token
-
CrawlerResource¶
-
class
_aws-cdk_resources.glue.
CrawlerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CrawlerResource is a part of - name (string) –
- props (
CrawlerResourceProps
or None) – the properties of this CrawlerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
JdbcTargetProperty
¶ -
connectionName
¶ CrawlerResource.JdbcTargetProperty.ConnectionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-connectionname
Type: string or Token
or None
-
path
¶ CrawlerResource.JdbcTargetProperty.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-path
Type: string or Token
or None
-
exclusions
¶ CrawlerResource.JdbcTargetProperty.Exclusions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-exclusions
Type: Token
or string orToken
or None
-
-
class
S3TargetProperty
¶ -
path
¶ CrawlerResource.S3TargetProperty.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path
Type: string or Token
or None
-
exclusions
¶ CrawlerResource.S3TargetProperty.Exclusions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions
Type: Token
or string orToken
or None
-
-
class
ScheduleProperty
¶ -
scheduleExpression
¶ CrawlerResource.ScheduleProperty.ScheduleExpression http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html#cfn-glue-crawler-schedule-scheduleexpression
Type: string or Token
or None
-
-
class
SchemaChangePolicyProperty
¶ -
updateBehavior
¶ CrawlerResource.SchemaChangePolicyProperty.UpdateBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-updatebehavior
Type: string or Token
or None
-
deleteBehavior
¶ CrawlerResource.SchemaChangePolicyProperty.DeleteBehavior http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-deletebehavior
Type: string or Token
or None
-
-
class
TargetsProperty
¶ -
s3Targets
¶ CrawlerResource.TargetsProperty.S3Targets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-s3targets
Type: Token
orToken
orS3TargetProperty
or None
-
jdbcTargets
¶ CrawlerResource.TargetsProperty.JdbcTargets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-jdbctargets
Type: Token
orToken
orJdbcTargetProperty
or None
-
- parent (
CrawlerResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
CrawlerResourceProps
¶ -
role
¶ AWS::Glue::Crawler.Role http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-role
Type: string or Token
-
classifiers
¶ AWS::Glue::Crawler.Classifiers http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-classifiers
Type: Token
or string orToken
or None
-
description
¶ AWS::Glue::Crawler.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-description
Type: string or Token
or None
-
schemaChangePolicy
¶ AWS::Glue::Crawler.SchemaChangePolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schemachangepolicy
Type: Token
orSchemaChangePolicyProperty
or None
-
schedule
¶ AWS::Glue::Crawler.Schedule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schedule
Type: Token
orScheduleProperty
or None
-
databaseName
¶ AWS::Glue::Crawler.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-databasename
Type: string or Token
-
targets
¶ AWS::Glue::Crawler.Targets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-targets
Type: Token
orTargetsProperty
-
tablePrefix
¶ AWS::Glue::Crawler.TablePrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tableprefix
Type: string or Token
or None
-
crawlerName
¶ AWS::Glue::Crawler.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-name
Type: string or Token
or None
-
DatabaseResource¶
-
class
_aws-cdk_resources.glue.
DatabaseResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DatabaseResource is a part of - name (string) –
- props (
DatabaseResourceProps
or None) – the properties of this DatabaseResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
DatabaseInputProperty
¶ -
locationUri
¶ DatabaseResource.DatabaseInputProperty.LocationUri http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-locationuri
Type: string or Token
or None
-
description
¶ DatabaseResource.DatabaseInputProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-description
Type: string or Token
or None
-
parameters
¶ DatabaseResource.DatabaseInputProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-parameters
Type: json or Token
or None
-
name
¶ DatabaseResource.DatabaseInputProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-name
Type: string or Token
or None
-
- parent (
DatabaseResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
DatabaseResourceProps
¶ -
databaseInput
¶ AWS::Glue::Database.DatabaseInput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-databaseinput
Type: Token
orDatabaseInputProperty
-
catalogId
¶ AWS::Glue::Database.CatalogId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-catalogid
Type: string or Token
-
DevEndpointResource¶
-
class
_aws-cdk_resources.glue.
DevEndpointResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DevEndpointResource is a part of - name (string) –
- props (
DevEndpointResourceProps
or None) – the properties of this DevEndpointResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DevEndpointResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
DevEndpointResourceProps
¶ -
extraJarsS3Path
¶ AWS::Glue::DevEndpoint.ExtraJarsS3Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrajarss3path
Type: string or Token
or None
-
endpointName
¶ AWS::Glue::DevEndpoint.EndpointName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-endpointname
Type: string or Token
or None
-
publicKey
¶ AWS::Glue::DevEndpoint.PublicKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickey
Type: string or Token
-
numberOfNodes
¶ AWS::Glue::DevEndpoint.NumberOfNodes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofnodes
Type: number or Token
or None
-
subnetId
¶ AWS::Glue::DevEndpoint.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-subnetid
Type: string or Token
or None
-
extraPythonLibsS3Path
¶ AWS::Glue::DevEndpoint.ExtraPythonLibsS3Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrapythonlibss3path
Type: string or Token
or None
-
securityGroupIds
¶ AWS::Glue::DevEndpoint.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securitygroupids
Type: Token
or string orToken
or None
-
roleArn
¶ AWS::Glue::DevEndpoint.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-rolearn
Type: string or Token
-
JobResource¶
-
class
_aws-cdk_resources.glue.
JobResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this JobResource is a part of - name (string) –
- props (
JobResourceProps
or None) – the properties of this JobResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ConnectionsListProperty
¶ -
connections
¶ JobResource.ConnectionsListProperty.Connections http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html#cfn-glue-job-connectionslist-connections
Type: Token
or string orToken
or None
-
-
class
ExecutionPropertyProperty
¶ -
maxConcurrentRuns
¶ JobResource.ExecutionPropertyProperty.MaxConcurrentRuns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html#cfn-glue-job-executionproperty-maxconcurrentruns
Type: number or Token
or None
-
-
class
JobCommandProperty
¶ -
scriptLocation
¶ JobResource.JobCommandProperty.ScriptLocation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-scriptlocation
Type: string or Token
or None
-
name
¶ JobResource.JobCommandProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-name
Type: string or Token
or None
-
- parent (
JobResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
JobResourceProps
¶ -
role
¶ AWS::Glue::Job.Role http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-role
Type: string or Token
-
defaultArguments
¶ AWS::Glue::Job.DefaultArguments http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-defaultarguments
Type: json or Token
or None
-
connections
¶ AWS::Glue::Job.Connections http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-connections
Type: Token
orConnectionsListProperty
or None
-
maxRetries
¶ AWS::Glue::Job.MaxRetries http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxretries
Type: number or Token
or None
-
description
¶ AWS::Glue::Job.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-description
Type: string or Token
or None
-
logUri
¶ AWS::Glue::Job.LogUri http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-loguri
Type: string or Token
or None
-
command
¶ AWS::Glue::Job.Command http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-command
Type: Token
orJobCommandProperty
-
allocatedCapacity
¶ AWS::Glue::Job.AllocatedCapacity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-allocatedcapacity
Type: number or Token
or None
-
executionProperty
¶ AWS::Glue::Job.ExecutionProperty http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionproperty
Type: Token
orExecutionPropertyProperty
or None
-
jobName
¶ AWS::Glue::Job.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-name
Type: string or Token
or None
-
PartitionResource¶
-
class
_aws-cdk_resources.glue.
PartitionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PartitionResource is a part of - name (string) –
- props (
PartitionResourceProps
or None) – the properties of this PartitionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ColumnProperty
¶ -
comment
¶ PartitionResource.ColumnProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-comment
Type: string or Token
or None
-
type
¶ PartitionResource.ColumnProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-type
Type: string or Token
or None
-
name
¶ PartitionResource.ColumnProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-name
Type: string or Token
-
-
class
OrderProperty
¶ -
column
¶ PartitionResource.OrderProperty.Column http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-column
Type: string or Token
-
sortOrder
¶ PartitionResource.OrderProperty.SortOrder http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-sortorder
Type: number or Token
or None
-
-
class
PartitionInputProperty
¶ -
parameters
¶ PartitionResource.PartitionInputProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-parameters
Type: json or Token
or None
-
storageDescriptor
¶ PartitionResource.PartitionInputProperty.StorageDescriptor http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-storagedescriptor
Type: Token
orStorageDescriptorProperty
or None
-
values
¶ PartitionResource.PartitionInputProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-values
Type: Token
or string orToken
-
-
class
SerdeInfoProperty
¶ -
parameters
¶ PartitionResource.SerdeInfoProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-parameters
Type: json or Token
or None
-
serializationLibrary
¶ PartitionResource.SerdeInfoProperty.SerializationLibrary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-serializationlibrary
Type: string or Token
or None
-
name
¶ PartitionResource.SerdeInfoProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-name
Type: string or Token
or None
-
-
class
SkewedInfoProperty
¶ -
skewedColumnNames
¶ PartitionResource.SkewedInfoProperty.SkewedColumnNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnnames
Type: Token
or string orToken
or None
-
skewedColumnValues
¶ PartitionResource.SkewedInfoProperty.SkewedColumnValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvalues
Type: Token
or string orToken
or None
-
skewedColumnValueLocationMaps
¶ PartitionResource.SkewedInfoProperty.SkewedColumnValueLocationMaps http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvaluelocationmaps
Type: json or Token
or None
-
-
class
StorageDescriptorProperty
¶ -
storedAsSubDirectories
¶ PartitionResource.StorageDescriptorProperty.StoredAsSubDirectories http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-storedassubdirectories
Type: boolean or Token
or None
-
parameters
¶ PartitionResource.StorageDescriptorProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-parameters
Type: json or Token
or None
-
bucketColumns
¶ PartitionResource.StorageDescriptorProperty.BucketColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-bucketcolumns
Type: Token
or string orToken
or None
-
skewedInfo
¶ PartitionResource.StorageDescriptorProperty.SkewedInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-skewedinfo
Type: Token
orSkewedInfoProperty
or None
-
inputFormat
¶ PartitionResource.StorageDescriptorProperty.InputFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-inputformat
Type: string or Token
or None
-
numberOfBuckets
¶ PartitionResource.StorageDescriptorProperty.NumberOfBuckets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-numberofbuckets
Type: number or Token
or None
-
outputFormat
¶ PartitionResource.StorageDescriptorProperty.OutputFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-outputformat
Type: string or Token
or None
-
columns
¶ PartitionResource.StorageDescriptorProperty.Columns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-columns
Type: Token
orToken
orColumnProperty
or None
-
serdeInfo
¶ PartitionResource.StorageDescriptorProperty.SerdeInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-serdeinfo
Type: Token
orSerdeInfoProperty
or None
-
sortColumns
¶ PartitionResource.StorageDescriptorProperty.SortColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-sortcolumns
Type: Token
orToken
orOrderProperty
or None
-
compressed
¶ PartitionResource.StorageDescriptorProperty.Compressed http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-compressed
Type: boolean or Token
or None
-
location
¶ PartitionResource.StorageDescriptorProperty.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-location
Type: string or Token
or None
-
- parent (
PartitionResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
PartitionResourceProps
¶ -
tableName
¶ AWS::Glue::Partition.TableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-tablename
Type: string or Token
-
databaseName
¶ AWS::Glue::Partition.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-databasename
Type: string or Token
-
catalogId
¶ AWS::Glue::Partition.CatalogId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-catalogid
Type: string or Token
-
partitionInput
¶ AWS::Glue::Partition.PartitionInput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-partitioninput
Type: Token
orPartitionInputProperty
-
TableResource¶
-
class
_aws-cdk_resources.glue.
TableResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TableResource is a part of - name (string) –
- props (
TableResourceProps
or None) – the properties of this TableResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ColumnProperty
¶ -
comment
¶ TableResource.ColumnProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-comment
Type: string or Token
or None
-
type
¶ TableResource.ColumnProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-type
Type: string or Token
or None
-
name
¶ TableResource.ColumnProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-name
Type: string or Token
-
-
class
OrderProperty
¶ -
column
¶ TableResource.OrderProperty.Column http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-column
Type: string or Token
-
sortOrder
¶ TableResource.OrderProperty.SortOrder http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-sortorder
Type: number or Token
-
-
class
SerdeInfoProperty
¶ -
parameters
¶ TableResource.SerdeInfoProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-parameters
Type: json or Token
or None
-
serializationLibrary
¶ TableResource.SerdeInfoProperty.SerializationLibrary http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-serializationlibrary
Type: string or Token
or None
-
name
¶ TableResource.SerdeInfoProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-name
Type: string or Token
or None
-
-
class
SkewedInfoProperty
¶ -
skewedColumnNames
¶ TableResource.SkewedInfoProperty.SkewedColumnNames http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnnames
Type: Token
or string orToken
or None
-
skewedColumnValues
¶ TableResource.SkewedInfoProperty.SkewedColumnValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvalues
Type: Token
or string orToken
or None
-
skewedColumnValueLocationMaps
¶ TableResource.SkewedInfoProperty.SkewedColumnValueLocationMaps http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvaluelocationmaps
Type: json or Token
or None
-
-
class
StorageDescriptorProperty
¶ -
storedAsSubDirectories
¶ TableResource.StorageDescriptorProperty.StoredAsSubDirectories http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-storedassubdirectories
Type: boolean or Token
or None
-
parameters
¶ TableResource.StorageDescriptorProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-parameters
Type: json or Token
or None
-
bucketColumns
¶ TableResource.StorageDescriptorProperty.BucketColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-bucketcolumns
Type: Token
or string orToken
or None
-
skewedInfo
¶ TableResource.StorageDescriptorProperty.SkewedInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-skewedinfo
Type: Token
orSkewedInfoProperty
or None
-
inputFormat
¶ TableResource.StorageDescriptorProperty.InputFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-inputformat
Type: string or Token
or None
-
numberOfBuckets
¶ TableResource.StorageDescriptorProperty.NumberOfBuckets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-numberofbuckets
Type: number or Token
or None
-
outputFormat
¶ TableResource.StorageDescriptorProperty.OutputFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-outputformat
Type: string or Token
or None
-
columns
¶ TableResource.StorageDescriptorProperty.Columns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-columns
Type: Token
orToken
orColumnProperty
or None
-
serdeInfo
¶ TableResource.StorageDescriptorProperty.SerdeInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-serdeinfo
Type: Token
orSerdeInfoProperty
or None
-
sortColumns
¶ TableResource.StorageDescriptorProperty.SortColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-sortcolumns
Type: Token
orToken
orOrderProperty
or None
-
compressed
¶ TableResource.StorageDescriptorProperty.Compressed http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-compressed
Type: boolean or Token
or None
-
location
¶ TableResource.StorageDescriptorProperty.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-location
Type: string or Token
or None
-
-
class
TableInputProperty
¶ -
owner
¶ TableResource.TableInputProperty.Owner http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner
Type: string or Token
or None
-
viewOriginalText
¶ TableResource.TableInputProperty.ViewOriginalText http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext
Type: string or Token
or None
-
description
¶ TableResource.TableInputProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description
Type: string or Token
or None
-
tableType
¶ TableResource.TableInputProperty.TableType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype
Type: string or Token
or None
-
parameters
¶ TableResource.TableInputProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters
Type: json or Token
or None
-
viewExpandedText
¶ TableResource.TableInputProperty.ViewExpandedText http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext
Type: string or Token
or None
-
storageDescriptor
¶ TableResource.TableInputProperty.StorageDescriptor http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor
Type: Token
orStorageDescriptorProperty
or None
-
partitionKeys
¶ TableResource.TableInputProperty.PartitionKeys http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys
Type: Token
orToken
orColumnProperty
or None
-
retention
¶ TableResource.TableInputProperty.Retention http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention
Type: number or Token
or None
-
name
¶ TableResource.TableInputProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-name
Type: string or Token
or None
-
- parent (
TableResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
TableResourceProps
¶ -
tableInput
¶ AWS::Glue::Table.TableInput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput
Type: Token
orTableInputProperty
-
databaseName
¶ AWS::Glue::Table.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename
Type: string or Token
-
catalogId
¶ AWS::Glue::Table.CatalogId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid
Type: string or Token
-
TriggerResource¶
-
class
_aws-cdk_resources.glue.
TriggerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TriggerResource is a part of - name (string) –
- props (
TriggerResourceProps
or None) – the properties of this TriggerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActionProperty
¶ -
jobName
¶ TriggerResource.ActionProperty.JobName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-jobname
Type: string or Token
or None
-
arguments
¶ TriggerResource.ActionProperty.Arguments http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-arguments
Type: json or Token
or None
-
-
class
ConditionProperty
¶ -
state
¶ TriggerResource.ConditionProperty.State http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-state
Type: string or Token
or None
-
logicalOperator
¶ TriggerResource.ConditionProperty.LogicalOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-logicaloperator
Type: string or Token
or None
-
jobName
¶ TriggerResource.ConditionProperty.JobName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-jobname
Type: string or Token
or None
-
-
class
PredicateProperty
¶ -
logical
¶ TriggerResource.PredicateProperty.Logical http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-logical
Type: string or Token
or None
-
conditions
¶ TriggerResource.PredicateProperty.Conditions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-conditions
Type: Token
orToken
orConditionProperty
or None
-
- parent (
TriggerResourceProps (interface)¶
-
class
_aws-cdk_resources.glue.
TriggerResourceProps
¶ -
type
¶ AWS::Glue::Trigger.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-type
Type: string or Token
-
description
¶ AWS::Glue::Trigger.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-description
Type: string or Token
or None
-
actions
¶ AWS::Glue::Trigger.Actions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-actions
Type: Token
orToken
orActionProperty
-
schedule
¶ AWS::Glue::Trigger.Schedule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-schedule
Type: string or Token
or None
-
triggerName
¶ AWS::Glue::Trigger.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-name
Type: string or Token
or None
-
predicate
¶ AWS::Glue::Trigger.Predicate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-predicate
Type: Token
orPredicateProperty
or None
-
guardduty¶
DetectorResource¶
-
class
_aws-cdk_resources.guardduty.
DetectorResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DetectorResource is a part of - name (string) –
- props (
DetectorResourceProps
or None) – the properties of this DetectorResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DetectorResourceProps (interface)¶
FilterResource¶
-
class
_aws-cdk_resources.guardduty.
FilterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this FilterResource is a part of - name (string) –
- props (
FilterResourceProps
or None) – the properties of this FilterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ConditionProperty
¶ -
lt
¶ FilterResource.ConditionProperty.Lt http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lt
Type: number or Token
or None
-
gte
¶ FilterResource.ConditionProperty.Gte http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-gte
Type: number or Token
or None
-
neq
¶ FilterResource.ConditionProperty.Neq http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-neq
Type: Token
or string orToken
or None
-
eq
¶ FilterResource.ConditionProperty.Eq http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-eq
Type: Token
or string orToken
or None
-
lte
¶ FilterResource.ConditionProperty.Lte http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-condition.html#cfn-guardduty-filter-condition-lte
Type: number or Token
or None
-
-
class
FindingCriteriaProperty
¶ -
criterion
¶ FilterResource.FindingCriteriaProperty.Criterion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html#cfn-guardduty-filter-findingcriteria-criterion
Type: json or Token
or None
-
itemType
¶ FilterResource.FindingCriteriaProperty.ItemType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html#cfn-guardduty-filter-findingcriteria-itemtype
Type: Token
orConditionProperty
or None
-
- parent (
FilterResourceProps (interface)¶
-
class
_aws-cdk_resources.guardduty.
FilterResourceProps
¶ -
action
¶ AWS::GuardDuty::Filter.Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-action
Type: string or Token
-
description
¶ AWS::GuardDuty::Filter.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-description
Type: string or Token
-
detectorId
¶ AWS::GuardDuty::Filter.DetectorId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-detectorid
Type: string or Token
-
findingCriteria
¶ AWS::GuardDuty::Filter.FindingCriteria http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-findingcriteria
Type: Token
orFindingCriteriaProperty
-
rank
¶ AWS::GuardDuty::Filter.Rank http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-rank
Type: number or Token
-
filterName
¶ AWS::GuardDuty::Filter.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-name
Type: string or Token
or None
-
IPSetResource¶
-
class
_aws-cdk_resources.guardduty.
IPSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this IPSetResource is a part of - name (string) –
- props (
IPSetResourceProps
or None) – the properties of this IPSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
IPSetResourceProps (interface)¶
-
class
_aws-cdk_resources.guardduty.
IPSetResourceProps
¶ -
format
¶ AWS::GuardDuty::IPSet.Format http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-format
Type: string or Token
-
activate
¶ AWS::GuardDuty::IPSet.Activate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-activate
Type: boolean or Token
-
detectorId
¶ AWS::GuardDuty::IPSet.DetectorId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-detectorid
Type: string or Token
-
ipSetName
¶ AWS::GuardDuty::IPSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-name
Type: string or Token
or None
-
location
¶ AWS::GuardDuty::IPSet.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-ipset.html#cfn-guardduty-ipset-location
Type: string or Token
-
MasterResource¶
-
class
_aws-cdk_resources.guardduty.
MasterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MasterResource is a part of - name (string) –
- props (
MasterResourceProps
or None) – the properties of this MasterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
MasterResourceProps (interface)¶
-
class
_aws-cdk_resources.guardduty.
MasterResourceProps
¶ -
detectorId
¶ AWS::GuardDuty::Master.DetectorId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-detectorid
Type: string or Token
-
masterId
¶ AWS::GuardDuty::Master.MasterId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-masterid
Type: string or Token
-
invitationId
¶ AWS::GuardDuty::Master.InvitationId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#cfn-guardduty-master-invitationid
Type: string or Token
or None
-
MemberResource¶
-
class
_aws-cdk_resources.guardduty.
MemberResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MemberResource is a part of - name (string) –
- props (
MemberResourceProps
or None) – the properties of this MemberResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
MemberResourceProps (interface)¶
-
class
_aws-cdk_resources.guardduty.
MemberResourceProps
¶ -
status
¶ AWS::GuardDuty::Member.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-status
Type: string or Token
or None
-
memberId
¶ AWS::GuardDuty::Member.MemberId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-memberid
Type: string or Token
-
email
¶ AWS::GuardDuty::Member.Email http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-email
Type: string or Token
-
message
¶ AWS::GuardDuty::Member.Message http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-message
Type: string or Token
or None
-
disableEmailNotification
¶ AWS::GuardDuty::Member.DisableEmailNotification http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-disableemailnotification
Type: boolean or Token
or None
-
detectorId
¶ AWS::GuardDuty::Member.DetectorId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#cfn-guardduty-member-detectorid
Type: string or Token
-
ThreatIntelSetResource¶
-
class
_aws-cdk_resources.guardduty.
ThreatIntelSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ThreatIntelSetResource is a part of - name (string) –
- props (
ThreatIntelSetResourceProps
or None) – the properties of this ThreatIntelSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ThreatIntelSetResourceProps (interface)¶
-
class
_aws-cdk_resources.guardduty.
ThreatIntelSetResourceProps
¶ -
format
¶ AWS::GuardDuty::ThreatIntelSet.Format http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-format
Type: string or Token
-
activate
¶ AWS::GuardDuty::ThreatIntelSet.Activate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-activate
Type: boolean or Token
-
detectorId
¶ AWS::GuardDuty::ThreatIntelSet.DetectorId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-detectorid
Type: string or Token
-
threatIntelSetName
¶ AWS::GuardDuty::ThreatIntelSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-name
Type: string or Token
or None
-
location
¶ AWS::GuardDuty::ThreatIntelSet.Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatintelset.html#cfn-guardduty-threatintelset-location
Type: string or Token
-
iam¶
AccessKeyResource¶
-
class
_aws-cdk_resources.iam.
AccessKeyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AccessKeyResource is a part of - name (string) –
- props (
AccessKeyResourceProps
or None) – the properties of this AccessKeyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
accessKeySecretAccessKey
¶ Type: AccessKeySecretAccessKey
(readonly)
- parent (
AccessKeyResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
AccessKeyResourceProps
¶ -
serial
¶ AWS::IAM::AccessKey.Serial http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-serial
Type: number or Token
or None
-
status
¶ AWS::IAM::AccessKey.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-status
Type: string or Token
or None
-
userName
¶ AWS::IAM::AccessKey.UserName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html#cfn-iam-accesskey-username
Type: string or Token
-
AccessKeySecretAccessKey¶
GroupArn¶
GroupResource¶
-
class
_aws-cdk_resources.iam.
GroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this GroupResource is a part of - name (string) –
- props (
GroupResourceProps
or None) – the properties of this GroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
groupArn
¶ Type: GroupArn
(readonly)
-
class
PolicyProperty
¶ -
policyDocument
¶ GroupResource.PolicyProperty.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policydocument
Type: json or Token
-
policyName
¶ GroupResource.PolicyProperty.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policyname
Type: string or Token
-
- parent (
GroupResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
GroupResourceProps
¶ -
groupName
¶ AWS::IAM::Group.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-groupname
Type: string or Token
or None
-
managedPolicyArns
¶ AWS::IAM::Group.ManagedPolicyArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-managepolicyarns
Type: Token
or string orToken
or None
-
path
¶ AWS::IAM::Group.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-path
Type: string or Token
or None
-
policies
¶ AWS::IAM::Group.Policies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html#cfn-iam-group-policies
Type: Token
orToken
orPolicyProperty
or None
-
InstanceProfileArn¶
InstanceProfileResource¶
-
class
_aws-cdk_resources.iam.
InstanceProfileResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InstanceProfileResource is a part of - name (string) –
- props (
InstanceProfileResourceProps
or None) – the properties of this InstanceProfileResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
instanceProfileArn
¶ Type: InstanceProfileArn
(readonly)
- parent (
InstanceProfileResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
InstanceProfileResourceProps
¶ -
instanceProfileName
¶ AWS::IAM::InstanceProfile.InstanceProfileName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-instanceprofilename
Type: string or Token
or None
-
path
¶ AWS::IAM::InstanceProfile.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-path
Type: string or Token
or None
-
roles
¶ AWS::IAM::InstanceProfile.Roles http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html#cfn-iam-instanceprofile-roles
Type: Token
or string orToken
-
ManagedPolicyResource¶
-
class
_aws-cdk_resources.iam.
ManagedPolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ManagedPolicyResource is a part of - name (string) –
- props (
ManagedPolicyResourceProps
or None) – the properties of this ManagedPolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ManagedPolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
ManagedPolicyResourceProps
¶ -
description
¶ AWS::IAM::ManagedPolicy.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-description
Type: string or Token
or None
-
groups
¶ AWS::IAM::ManagedPolicy.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-groups
Type: Token
or string orToken
or None
-
managedPolicyName
¶ AWS::IAM::ManagedPolicy.ManagedPolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-managedpolicyname
Type: string or Token
or None
-
path
¶ AWS::IAM::ManagedPolicy.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-ec2-dhcpoptions-path
Type: string or Token
or None
-
policyDocument
¶ AWS::IAM::ManagedPolicy.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-policydocument
Type: json or Token
-
roles
¶ AWS::IAM::ManagedPolicy.Roles http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-roles
Type: Token
or string orToken
or None
-
users
¶ AWS::IAM::ManagedPolicy.Users http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#cfn-iam-managedpolicy-users
Type: Token
or string orToken
or None
-
PolicyResource¶
-
class
_aws-cdk_resources.iam.
PolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PolicyResource is a part of - name (string) –
- props (
PolicyResourceProps
or None) – the properties of this PolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
PolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
PolicyResourceProps
¶ -
groups
¶ AWS::IAM::Policy.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-groups
Type: Token
or string orToken
or None
-
policyDocument
¶ AWS::IAM::Policy.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument
Type: json or Token
-
policyName
¶ AWS::IAM::Policy.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policyname
Type: string or Token
-
roles
¶ AWS::IAM::Policy.Roles http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-roles
Type: Token
or string orToken
or None
-
users
¶ AWS::IAM::Policy.Users http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-users
Type: Token
or string orToken
or None
-
RoleArn¶
RoleId¶
RoleResource¶
-
class
_aws-cdk_resources.iam.
RoleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RoleResource is a part of - name (string) –
- props (
RoleResourceProps
or None) – the properties of this RoleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
roleArn
¶ Type: RoleArn
(readonly)
-
roleId
¶ Type: RoleId
(readonly)
-
class
PolicyProperty
¶ -
policyDocument
¶ RoleResource.PolicyProperty.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policydocument
Type: json or Token
-
policyName
¶ RoleResource.PolicyProperty.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policyname
Type: string or Token
-
- parent (
RoleResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
RoleResourceProps
¶ -
assumeRolePolicyDocument
¶ AWS::IAM::Role.AssumeRolePolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument
Type: json or Token
-
managedPolicyArns
¶ AWS::IAM::Role.ManagedPolicyArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-managepolicyarns
Type: Token
or string orToken
or None
-
maxSessionDuration
¶ AWS::IAM::Role.MaxSessionDuration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-maxsessionduration
Type: number or Token
or None
-
path
¶ AWS::IAM::Role.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path
Type: string or Token
or None
-
policies
¶ AWS::IAM::Role.Policies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies
Type: Token
orToken
orPolicyProperty
or None
-
roleName
¶ AWS::IAM::Role.RoleName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-rolename
Type: string or Token
or None
-
UserArn¶
UserResource¶
-
class
_aws-cdk_resources.iam.
UserResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserResource is a part of - name (string) –
- props (
UserResourceProps
or None) – the properties of this UserResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
userArn
¶ Type: UserArn
(readonly)
-
class
LoginProfileProperty
¶ -
password
¶ UserResource.LoginProfileProperty.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-password
Type: string or Token
-
passwordResetRequired
¶ UserResource.LoginProfileProperty.PasswordResetRequired http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-passwordresetrequired
Type: boolean or Token
or None
-
-
class
PolicyProperty
¶ -
policyDocument
¶ UserResource.PolicyProperty.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policydocument
Type: json or Token
-
policyName
¶ UserResource.PolicyProperty.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html#cfn-iam-policies-policyname
Type: string or Token
-
- parent (
UserResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
UserResourceProps
¶ -
groups
¶ AWS::IAM::User.Groups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-groups
Type: Token
or string orToken
or None
-
loginProfile
¶ AWS::IAM::User.LoginProfile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-loginprofile
Type: Token
orLoginProfileProperty
or None
-
managedPolicyArns
¶ AWS::IAM::User.ManagedPolicyArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-managepolicyarns
Type: Token
or string orToken
or None
-
path
¶ AWS::IAM::User.Path http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-path
Type: string or Token
or None
-
policies
¶ AWS::IAM::User.Policies http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-policies
Type: Token
orToken
orPolicyProperty
or None
-
userName
¶ AWS::IAM::User.UserName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html#cfn-iam-user-username
Type: string or Token
or None
-
UserToGroupAdditionResource¶
-
class
_aws-cdk_resources.iam.
UserToGroupAdditionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserToGroupAdditionResource is a part of - name (string) –
- props (
UserToGroupAdditionResourceProps
or None) – the properties of this UserToGroupAdditionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
UserToGroupAdditionResourceProps (interface)¶
-
class
_aws-cdk_resources.iam.
UserToGroupAdditionResourceProps
¶ -
groupName
¶ AWS::IAM::UserToGroupAddition.GroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html#cfn-iam-addusertogroup-groupname
Type: string or Token
-
users
¶ AWS::IAM::UserToGroupAddition.Users http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html#cfn-iam-addusertogroup-users
Type: Token
or string orToken
-
inspector¶
AssessmentTargetArn¶
AssessmentTargetResource¶
-
class
_aws-cdk_resources.inspector.
AssessmentTargetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AssessmentTargetResource is a part of - name (string) –
- props (
AssessmentTargetResourceProps
or None) – the properties of this AssessmentTargetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
assessmentTargetArn
¶ Type: AssessmentTargetArn
(readonly)
- parent (
AssessmentTargetResourceProps (interface)¶
-
class
_aws-cdk_resources.inspector.
AssessmentTargetResourceProps
¶ -
assessmentTargetName
¶ AWS::Inspector::AssessmentTarget.AssessmentTargetName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#cfn-inspector-assessmenttarget-assessmenttargetname
Type: string or Token
or None
-
resourceGroupArn
¶ AWS::Inspector::AssessmentTarget.ResourceGroupArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttarget.html#cfn-inspector-assessmenttarget-resourcegrouparn
Type: string or Token
-
AssessmentTemplateArn¶
AssessmentTemplateResource¶
-
class
_aws-cdk_resources.inspector.
AssessmentTemplateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AssessmentTemplateResource is a part of - name (string) –
- props (
AssessmentTemplateResourceProps
or None) – the properties of this AssessmentTemplateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
assessmentTemplateArn
¶ Type: AssessmentTemplateArn
(readonly)
- parent (
AssessmentTemplateResourceProps (interface)¶
-
class
_aws-cdk_resources.inspector.
AssessmentTemplateResourceProps
¶ -
assessmentTargetArn
¶ AWS::Inspector::AssessmentTemplate.AssessmentTargetArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttargetarn
Type: string or Token
-
durationInSeconds
¶ AWS::Inspector::AssessmentTemplate.DurationInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-durationinseconds
Type: number or Token
-
assessmentTemplateName
¶ AWS::Inspector::AssessmentTemplate.AssessmentTemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttemplatename
Type: string or Token
or None
-
rulesPackageArns
¶ AWS::Inspector::AssessmentTemplate.RulesPackageArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-rulespackagearns
Type: Token
or string orToken
-
userAttributesForFindings
¶ AWS::Inspector::AssessmentTemplate.UserAttributesForFindings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-userattributesforfindings
Type: Token
orToken
orTag
or None
-
ResourceGroupArn¶
ResourceGroupResource¶
-
class
_aws-cdk_resources.inspector.
ResourceGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ResourceGroupResource is a part of - name (string) –
- props (
ResourceGroupResourceProps
or None) – the properties of this ResourceGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
resourceGroupArn
¶ Type: ResourceGroupArn
(readonly)
- parent (
ResourceGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.inspector.
ResourceGroupResourceProps
¶ -
resourceGroupTags
¶ AWS::Inspector::ResourceGroup.ResourceGroupTags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-resourcegroup.html#cfn-inspector-resourcegroup-resourcegrouptags
Type: Token
orToken
orTag
-
iot¶
CertificateArn¶
CertificateResource¶
-
class
_aws-cdk_resources.iot.
CertificateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CertificateResource is a part of - name (string) –
- props (
CertificateResourceProps
or None) – the properties of this CertificateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
certificateArn
¶ Type: CertificateArn
(readonly)
- parent (
CertificateResourceProps (interface)¶
-
class
_aws-cdk_resources.iot.
CertificateResourceProps
¶ -
certificateSigningRequest
¶ AWS::IoT::Certificate.CertificateSigningRequest http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-certificatesigningrequest
Type: string or Token
-
status
¶ AWS::IoT::Certificate.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-status
Type: string or Token
-
PolicyArn¶
PolicyPrincipalAttachmentResource¶
-
class
_aws-cdk_resources.iot.
PolicyPrincipalAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PolicyPrincipalAttachmentResource is a part of - name (string) –
- props (
PolicyPrincipalAttachmentResourceProps
or None) – the properties of this PolicyPrincipalAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
PolicyPrincipalAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.iot.
PolicyPrincipalAttachmentResourceProps
¶ -
policyName
¶ AWS::IoT::PolicyPrincipalAttachment.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html#cfn-iot-policyprincipalattachment-policyname
Type: string or Token
-
principal
¶ AWS::IoT::PolicyPrincipalAttachment.Principal http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policyprincipalattachment.html#cfn-iot-policyprincipalattachment-principal
Type: string or Token
-
PolicyResource¶
-
class
_aws-cdk_resources.iot.
PolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PolicyResource is a part of - name (string) –
- props (
PolicyResourceProps
or None) – the properties of this PolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
policyArn
¶ Type: PolicyArn
(readonly)
- parent (
PolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.iot.
PolicyResourceProps
¶ -
policyDocument
¶ AWS::IoT::Policy.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policydocument
Type: json or Token
-
policyName
¶ AWS::IoT::Policy.PolicyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policyname
Type: string or Token
or None
-
ThingPrincipalAttachmentResource¶
-
class
_aws-cdk_resources.iot.
ThingPrincipalAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ThingPrincipalAttachmentResource is a part of - name (string) –
- props (
ThingPrincipalAttachmentResourceProps
or None) – the properties of this ThingPrincipalAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ThingPrincipalAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.iot.
ThingPrincipalAttachmentResourceProps
¶ -
principal
¶ AWS::IoT::ThingPrincipalAttachment.Principal http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html#cfn-iot-thingprincipalattachment-principal
Type: string or Token
-
thingName
¶ AWS::IoT::ThingPrincipalAttachment.ThingName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thingprincipalattachment.html#cfn-iot-thingprincipalattachment-thingname
Type: string or Token
-
ThingResource¶
-
class
_aws-cdk_resources.iot.
ThingResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ThingResource is a part of - name (string) –
- props (
ThingResourceProps
or None) – the properties of this ThingResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AttributePayloadProperty
¶ -
attributes
¶ ThingResource.AttributePayloadProperty.Attributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html#cfn-iot-thing-attributepayload-attributes
Type: Token
or string orToken
or None
-
- parent (
ThingResourceProps (interface)¶
-
class
_aws-cdk_resources.iot.
ThingResourceProps
¶ -
attributePayload
¶ AWS::IoT::Thing.AttributePayload http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-attributepayload
Type: Token
orAttributePayloadProperty
or None
-
thingName
¶ AWS::IoT::Thing.ThingName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-thingname
Type: string or Token
or None
-
TopicRuleArn¶
TopicRuleResource¶
-
class
_aws-cdk_resources.iot.
TopicRuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TopicRuleResource is a part of - name (string) –
- props (
TopicRuleResourceProps
or None) – the properties of this TopicRuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
topicRuleArn
¶ Type: TopicRuleArn
(readonly)
-
class
ActionProperty
¶ -
cloudwatchAlarm
¶ TopicRuleResource.ActionProperty.CloudwatchAlarm http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchalarm
Type: Token
orCloudwatchAlarmActionProperty
or None
-
cloudwatchMetric
¶ TopicRuleResource.ActionProperty.CloudwatchMetric http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchmetric
Type: Token
orCloudwatchMetricActionProperty
or None
-
dynamoDb
¶ TopicRuleResource.ActionProperty.DynamoDB http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodb
Type: Token
orDynamoDBActionProperty
or None
-
dynamoDBv2
¶ TopicRuleResource.ActionProperty.DynamoDBv2 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodbv2
Type: Token
orDynamoDBv2ActionProperty
or None
-
elasticsearch
¶ TopicRuleResource.ActionProperty.Elasticsearch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-elasticsearch
Type: Token
orElasticsearchActionProperty
or None
-
firehose
¶ TopicRuleResource.ActionProperty.Firehose http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-firehose
Type: Token
orFirehoseActionProperty
or None
-
kinesis
¶ TopicRuleResource.ActionProperty.Kinesis http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kinesis
Type: Token
orKinesisActionProperty
or None
-
lambda
¶ TopicRuleResource.ActionProperty.Lambda http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-lambda
Type: Token
orLambdaActionProperty
or None
-
republish
¶ TopicRuleResource.ActionProperty.Republish http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-republish
Type: Token
orRepublishActionProperty
or None
-
s3
¶ TopicRuleResource.ActionProperty.S3 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-s3
Type: Token
orS3ActionProperty
or None
-
sns
¶ TopicRuleResource.ActionProperty.Sns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sns
Type: Token
orSnsActionProperty
or None
-
sqs
¶ TopicRuleResource.ActionProperty.Sqs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sqs
Type: Token
orSqsActionProperty
or None
-
-
class
CloudwatchAlarmActionProperty
¶ -
alarmName
¶ TopicRuleResource.CloudwatchAlarmActionProperty.AlarmName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-alarmname
Type: string or Token
-
roleArn
¶ TopicRuleResource.CloudwatchAlarmActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-rolearn
Type: string or Token
-
stateReason
¶ TopicRuleResource.CloudwatchAlarmActionProperty.StateReason http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statereason
Type: string or Token
-
stateValue
¶ TopicRuleResource.CloudwatchAlarmActionProperty.StateValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchalarmaction.html#cfn-iot-topicrule-cloudwatchalarmaction-statevalue
Type: string or Token
-
-
class
CloudwatchMetricActionProperty
¶ -
metricName
¶ TopicRuleResource.CloudwatchMetricActionProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricname
Type: string or Token
-
metricNamespace
¶ TopicRuleResource.CloudwatchMetricActionProperty.MetricNamespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricnamespace
Type: string or Token
-
metricTimestamp
¶ TopicRuleResource.CloudwatchMetricActionProperty.MetricTimestamp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metrictimestamp
Type: string or Token
or None
-
metricUnit
¶ TopicRuleResource.CloudwatchMetricActionProperty.MetricUnit http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricunit
Type: string or Token
-
metricValue
¶ TopicRuleResource.CloudwatchMetricActionProperty.MetricValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricvalue
Type: string or Token
-
roleArn
¶ TopicRuleResource.CloudwatchMetricActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-rolearn
Type: string or Token
-
-
class
DynamoDBActionProperty
¶ -
hashKeyField
¶ TopicRuleResource.DynamoDBActionProperty.HashKeyField http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyfield
Type: string or Token
-
hashKeyType
¶ TopicRuleResource.DynamoDBActionProperty.HashKeyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeytype
Type: string or Token
or None
-
hashKeyValue
¶ TopicRuleResource.DynamoDBActionProperty.HashKeyValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-hashkeyvalue
Type: string or Token
-
payloadField
¶ TopicRuleResource.DynamoDBActionProperty.PayloadField http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-payloadfield
Type: string or Token
or None
-
rangeKeyField
¶ TopicRuleResource.DynamoDBActionProperty.RangeKeyField http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyfield
Type: string or Token
or None
-
rangeKeyType
¶ TopicRuleResource.DynamoDBActionProperty.RangeKeyType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeytype
Type: string or Token
or None
-
rangeKeyValue
¶ TopicRuleResource.DynamoDBActionProperty.RangeKeyValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rangekeyvalue
Type: string or Token
or None
-
roleArn
¶ TopicRuleResource.DynamoDBActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-rolearn
Type: string or Token
-
tableName
¶ TopicRuleResource.DynamoDBActionProperty.TableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbaction.html#cfn-iot-topicrule-dynamodbaction-tablename
Type: string or Token
-
-
class
DynamoDBv2ActionProperty
¶ -
putItem
¶ TopicRuleResource.DynamoDBv2ActionProperty.PutItem http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-putitem
Type: Token
orPutItemInputProperty
or None
-
roleArn
¶ TopicRuleResource.DynamoDBv2ActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-dynamodbv2action.html#cfn-iot-topicrule-dynamodbv2action-rolearn
Type: string or Token
or None
-
-
class
ElasticsearchActionProperty
¶ -
endpoint
¶ TopicRuleResource.ElasticsearchActionProperty.Endpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-endpoint
Type: string or Token
-
id
¶ TopicRuleResource.ElasticsearchActionProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-id
Type: string or Token
-
index
¶ TopicRuleResource.ElasticsearchActionProperty.Index http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-index
Type: string or Token
-
roleArn
¶ TopicRuleResource.ElasticsearchActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-rolearn
Type: string or Token
-
type
¶ TopicRuleResource.ElasticsearchActionProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-elasticsearchaction.html#cfn-iot-topicrule-elasticsearchaction-type
Type: string or Token
-
-
class
FirehoseActionProperty
¶ -
deliveryStreamName
¶ TopicRuleResource.FirehoseActionProperty.DeliveryStreamName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-deliverystreamname
Type: string or Token
-
roleArn
¶ TopicRuleResource.FirehoseActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-rolearn
Type: string or Token
-
separator
¶ TopicRuleResource.FirehoseActionProperty.Separator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-firehoseaction.html#cfn-iot-topicrule-firehoseaction-separator
Type: string or Token
or None
-
-
class
KinesisActionProperty
¶ -
partitionKey
¶ TopicRuleResource.KinesisActionProperty.PartitionKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-partitionkey
Type: string or Token
or None
-
roleArn
¶ TopicRuleResource.KinesisActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-rolearn
Type: string or Token
-
streamName
¶ TopicRuleResource.KinesisActionProperty.StreamName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html#cfn-iot-topicrule-kinesisaction-streamname
Type: string or Token
-
-
class
LambdaActionProperty
¶ -
functionArn
¶ TopicRuleResource.LambdaActionProperty.FunctionArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html#cfn-iot-topicrule-lambdaaction-functionarn
Type: string or Token
or None
-
-
class
PutItemInputProperty
¶ -
tableName
¶ TopicRuleResource.PutItemInputProperty.TableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-putiteminput.html#cfn-iot-topicrule-putiteminput-tablename
Type: string or Token
-
-
class
RepublishActionProperty
¶ -
roleArn
¶ TopicRuleResource.RepublishActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-rolearn
Type: string or Token
-
topic
¶ TopicRuleResource.RepublishActionProperty.Topic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html#cfn-iot-topicrule-republishaction-topic
Type: string or Token
-
-
class
S3ActionProperty
¶ -
bucketName
¶ TopicRuleResource.S3ActionProperty.BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-bucketname
Type: string or Token
-
key
¶ TopicRuleResource.S3ActionProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-key
Type: string or Token
-
roleArn
¶ TopicRuleResource.S3ActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html#cfn-iot-topicrule-s3action-rolearn
Type: string or Token
-
-
class
SnsActionProperty
¶ -
messageFormat
¶ TopicRuleResource.SnsActionProperty.MessageFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-messageformat
Type: string or Token
or None
-
roleArn
¶ TopicRuleResource.SnsActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-rolearn
Type: string or Token
-
targetArn
¶ TopicRuleResource.SnsActionProperty.TargetArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-targetarn
Type: string or Token
-
-
class
SqsActionProperty
¶ -
queueUrl
¶ TopicRuleResource.SqsActionProperty.QueueUrl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-queueurl
Type: string or Token
-
roleArn
¶ TopicRuleResource.SqsActionProperty.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-rolearn
Type: string or Token
-
useBase64
¶ TopicRuleResource.SqsActionProperty.UseBase64 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-sqsaction.html#cfn-iot-topicrule-sqsaction-usebase64
Type: boolean or Token
or None
-
-
class
TopicRulePayloadProperty
¶ -
actions
¶ TopicRuleResource.TopicRulePayloadProperty.Actions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-actions
Type: Token
orToken
orActionProperty
-
awsIotSqlVersion
¶ TopicRuleResource.TopicRulePayloadProperty.AwsIotSqlVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion
Type: string or Token
or None
-
description
¶ TopicRuleResource.TopicRulePayloadProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-description
Type: string or Token
or None
-
ruleDisabled
¶ TopicRuleResource.TopicRulePayloadProperty.RuleDisabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-ruledisabled
Type: boolean or Token
-
sql
¶ TopicRuleResource.TopicRulePayloadProperty.Sql http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql
Type: string or Token
-
- parent (
TopicRuleResourceProps (interface)¶
-
class
_aws-cdk_resources.iot.
TopicRuleResourceProps
¶ -
ruleName
¶ AWS::IoT::TopicRule.RuleName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-rulename
Type: string or Token
or None
-
topicRulePayload
¶ AWS::IoT::TopicRule.TopicRulePayload http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html#cfn-iot-topicrule-topicrulepayload
Type: Token
orTopicRulePayloadProperty
-
kinesis¶
StreamArn¶
StreamResource¶
-
class
_aws-cdk_resources.kinesis.
StreamResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StreamResource is a part of - name (string) –
- props (
StreamResourceProps
or None) – the properties of this StreamResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
streamArn
¶ Type: StreamArn
(readonly)
-
class
StreamEncryptionProperty
¶ -
encryptionType
¶ StreamResource.StreamEncryptionProperty.EncryptionType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-encryptiontype
Type: string or Token
-
keyId
¶ StreamResource.StreamEncryptionProperty.KeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html#cfn-kinesis-stream-streamencryption-keyid
Type: string or Token
-
- parent (
StreamResourceProps (interface)¶
-
class
_aws-cdk_resources.kinesis.
StreamResourceProps
¶ -
streamName
¶ AWS::Kinesis::Stream.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-name
Type: string or Token
or None
-
retentionPeriodHours
¶ AWS::Kinesis::Stream.RetentionPeriodHours http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-retentionperiodhours
Type: number or Token
or None
-
shardCount
¶ AWS::Kinesis::Stream.ShardCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-shardcount
Type: number or Token
-
streamEncryption
¶ AWS::Kinesis::Stream.StreamEncryption http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streamencryption
Type: Token
orStreamEncryptionProperty
or None
AWS::Kinesis::Stream.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-tags
Type: Token
orToken
orTag
or None
-
kinesisanalytics¶
ApplicationOutputResource¶
-
class
_aws-cdk_resources.kinesisanalytics.
ApplicationOutputResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApplicationOutputResource is a part of - name (string) –
- props (
ApplicationOutputResourceProps
or None) – the properties of this ApplicationOutputResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
DestinationSchemaProperty
¶ -
recordFormatType
¶ ApplicationOutputResource.DestinationSchemaProperty.RecordFormatType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-destinationschema.html#cfn-kinesisanalytics-applicationoutput-destinationschema-recordformattype
Type: string or Token
or None
-
-
class
KinesisFirehoseOutputProperty
¶ -
resourceArn
¶ ApplicationOutputResource.KinesisFirehoseOutputProperty.ResourceARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-resourcearn
Type: string or Token
-
roleArn
¶ ApplicationOutputResource.KinesisFirehoseOutputProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisfirehoseoutput-rolearn
Type: string or Token
-
-
class
KinesisStreamsOutputProperty
¶ -
resourceArn
¶ ApplicationOutputResource.KinesisStreamsOutputProperty.ResourceARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-resourcearn
Type: string or Token
-
roleArn
¶ ApplicationOutputResource.KinesisStreamsOutputProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalytics-applicationoutput-kinesisstreamsoutput-rolearn
Type: string or Token
-
-
class
LambdaOutputProperty
¶ -
resourceArn
¶ ApplicationOutputResource.LambdaOutputProperty.ResourceARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-resourcearn
Type: string or Token
-
roleArn
¶ ApplicationOutputResource.LambdaOutputProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-lambdaoutput.html#cfn-kinesisanalytics-applicationoutput-lambdaoutput-rolearn
Type: string or Token
-
-
class
OutputProperty
¶ -
destinationSchema
¶ ApplicationOutputResource.OutputProperty.DestinationSchema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-destinationschema
Type: Token
orDestinationSchemaProperty
-
lambdaOutput
¶ ApplicationOutputResource.OutputProperty.LambdaOutput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-lambdaoutput
Type: Token
orLambdaOutputProperty
or None
-
kinesisFirehoseOutput
¶ ApplicationOutputResource.OutputProperty.KinesisFirehoseOutput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisfirehoseoutput
Type: Token
orKinesisFirehoseOutputProperty
or None
-
kinesisStreamsOutput
¶ ApplicationOutputResource.OutputProperty.KinesisStreamsOutput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-kinesisstreamsoutput
Type: Token
orKinesisStreamsOutputProperty
or None
-
name
¶ ApplicationOutputResource.OutputProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationoutput-output.html#cfn-kinesisanalytics-applicationoutput-output-name
Type: string or Token
or None
-
- parent (
ApplicationOutputResourceProps (interface)¶
-
class
_aws-cdk_resources.kinesisanalytics.
ApplicationOutputResourceProps
¶ -
applicationName
¶ AWS::KinesisAnalytics::ApplicationOutput.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-applicationname
Type: string or Token
-
output
¶ AWS::KinesisAnalytics::ApplicationOutput.Output http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html#cfn-kinesisanalytics-applicationoutput-output
Type: Token
orOutputProperty
-
ApplicationReferenceDataSourceResource¶
-
class
_aws-cdk_resources.kinesisanalytics.
ApplicationReferenceDataSourceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApplicationReferenceDataSourceResource is a part of - name (string) –
- props (
ApplicationReferenceDataSourceResourceProps
or None) – the properties of this ApplicationReferenceDataSourceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
CSVMappingParametersProperty
¶ -
recordRowDelimiter
¶ ApplicationReferenceDataSourceResource.CSVMappingParametersProperty.RecordRowDelimiter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter
Type: string or Token
-
recordColumnDelimiter
¶ ApplicationReferenceDataSourceResource.CSVMappingParametersProperty.RecordColumnDelimiter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordcolumndelimiter
Type: string or Token
-
-
class
JSONMappingParametersProperty
¶ -
recordRowPath
¶ ApplicationReferenceDataSourceResource.JSONMappingParametersProperty.RecordRowPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters-recordrowpath
Type: string or Token
-
-
class
MappingParametersProperty
¶ -
jsonMappingParameters
¶ ApplicationReferenceDataSourceResource.MappingParametersProperty.JSONMappingParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-jsonmappingparameters
Type: Token
orJSONMappingParametersProperty
or None
-
csvMappingParameters
¶ ApplicationReferenceDataSourceResource.MappingParametersProperty.CSVMappingParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-csvmappingparameters
Type: Token
orCSVMappingParametersProperty
or None
-
-
class
RecordColumnProperty
¶ -
mapping
¶ ApplicationReferenceDataSourceResource.RecordColumnProperty.Mapping http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-mapping
Type: string or Token
or None
-
sqlType
¶ ApplicationReferenceDataSourceResource.RecordColumnProperty.SqlType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-sqltype
Type: string or Token
-
name
¶ ApplicationReferenceDataSourceResource.RecordColumnProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-name
Type: string or Token
-
-
class
RecordFormatProperty
¶ -
mappingParameters
¶ ApplicationReferenceDataSourceResource.RecordFormatProperty.MappingParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-mappingparameters
Type: Token
orMappingParametersProperty
or None
-
recordFormatType
¶ ApplicationReferenceDataSourceResource.RecordFormatProperty.RecordFormatType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-recordformattype
Type: string or Token
-
-
class
ReferenceDataSourceProperty
¶ -
referenceSchema
¶ ApplicationReferenceDataSourceResource.ReferenceDataSourceProperty.ReferenceSchema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-referenceschema
Type: Token
orReferenceSchemaProperty
-
tableName
¶ ApplicationReferenceDataSourceResource.ReferenceDataSourceProperty.TableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-tablename
Type: string or Token
or None
-
s3ReferenceDataSource
¶ ApplicationReferenceDataSourceResource.ReferenceDataSourceProperty.S3ReferenceDataSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-s3referencedatasource
Type: Token
orS3ReferenceDataSourceProperty
or None
-
-
class
ReferenceSchemaProperty
¶ -
recordEncoding
¶ ApplicationReferenceDataSourceResource.ReferenceSchemaProperty.RecordEncoding http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordencoding
Type: string or Token
or None
-
recordColumns
¶ ApplicationReferenceDataSourceResource.ReferenceSchemaProperty.RecordColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordcolumns
Type: Token
orToken
orRecordColumnProperty
-
recordFormat
¶ ApplicationReferenceDataSourceResource.ReferenceSchemaProperty.RecordFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordformat
Type: Token
orRecordFormatProperty
-
-
class
S3ReferenceDataSourceProperty
¶ -
bucketArn
¶ ApplicationReferenceDataSourceResource.S3ReferenceDataSourceProperty.BucketARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-bucketarn
Type: string or Token
-
fileKey
¶ ApplicationReferenceDataSourceResource.S3ReferenceDataSourceProperty.FileKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-filekey
Type: string or Token
-
referenceRoleArn
¶ ApplicationReferenceDataSourceResource.S3ReferenceDataSourceProperty.ReferenceRoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-referencerolearn
Type: string or Token
-
- parent (
ApplicationReferenceDataSourceResourceProps (interface)¶
-
class
_aws-cdk_resources.kinesisanalytics.
ApplicationReferenceDataSourceResourceProps
¶ -
applicationName
¶ AWS::KinesisAnalytics::ApplicationReferenceDataSource.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-applicationname
Type: string or Token
-
referenceDataSource
¶ AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource
Type: Token
orReferenceDataSourceProperty
-
ApplicationResource¶
-
class
_aws-cdk_resources.kinesisanalytics.
ApplicationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApplicationResource is a part of - name (string) –
- props (
ApplicationResourceProps
or None) – the properties of this ApplicationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
CSVMappingParametersProperty
¶ -
recordRowDelimiter
¶ ApplicationResource.CSVMappingParametersProperty.RecordRowDelimiter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordrowdelimiter
Type: string or Token
-
recordColumnDelimiter
¶ ApplicationResource.CSVMappingParametersProperty.RecordColumnDelimiter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordcolumndelimiter
Type: string or Token
-
-
class
InputLambdaProcessorProperty
¶ -
resourceArn
¶ ApplicationResource.InputLambdaProcessorProperty.ResourceARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-resourcearn
Type: string or Token
-
roleArn
¶ ApplicationResource.InputLambdaProcessorProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-rolearn
Type: string or Token
-
-
class
InputParallelismProperty
¶ -
count
¶ ApplicationResource.InputParallelismProperty.Count http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html#cfn-kinesisanalytics-application-inputparallelism-count
Type: number or Token
or None
-
-
class
InputProcessingConfigurationProperty
¶ -
inputLambdaProcessor
¶ ApplicationResource.InputProcessingConfigurationProperty.InputLambdaProcessor http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html#cfn-kinesisanalytics-application-inputprocessingconfiguration-inputlambdaprocessor
Type: Token
orInputLambdaProcessorProperty
or None
-
-
class
InputProperty
¶ -
namePrefix
¶ ApplicationResource.InputProperty.NamePrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-nameprefix
Type: string or Token
-
inputSchema
¶ ApplicationResource.InputProperty.InputSchema http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputschema
Type: Token
orInputSchemaProperty
-
kinesisStreamsInput
¶ ApplicationResource.InputProperty.KinesisStreamsInput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisstreamsinput
Type: Token
orKinesisStreamsInputProperty
or None
-
kinesisFirehoseInput
¶ ApplicationResource.InputProperty.KinesisFirehoseInput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisfirehoseinput
Type: Token
orKinesisFirehoseInputProperty
or None
-
inputProcessingConfiguration
¶ ApplicationResource.InputProperty.InputProcessingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputprocessingconfiguration
Type: Token
orInputProcessingConfigurationProperty
or None
-
inputParallelism
¶ ApplicationResource.InputProperty.InputParallelism http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputparallelism
Type: Token
orInputParallelismProperty
or None
-
-
class
InputSchemaProperty
¶ -
recordEncoding
¶ ApplicationResource.InputSchemaProperty.RecordEncoding http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordencoding
Type: string or Token
or None
-
recordColumns
¶ ApplicationResource.InputSchemaProperty.RecordColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordcolumns
Type: Token
orToken
orRecordColumnProperty
-
recordFormat
¶ ApplicationResource.InputSchemaProperty.RecordFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordformat
Type: Token
orRecordFormatProperty
-
-
class
JSONMappingParametersProperty
¶ -
recordRowPath
¶ ApplicationResource.JSONMappingParametersProperty.RecordRowPath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html#cfn-kinesisanalytics-application-jsonmappingparameters-recordrowpath
Type: string or Token
-
-
class
KinesisFirehoseInputProperty
¶ -
resourceArn
¶ ApplicationResource.KinesisFirehoseInputProperty.ResourceARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-resourcearn
Type: string or Token
-
roleArn
¶ ApplicationResource.KinesisFirehoseInputProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-rolearn
Type: string or Token
-
-
class
KinesisStreamsInputProperty
¶ -
resourceArn
¶ ApplicationResource.KinesisStreamsInputProperty.ResourceARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-resourcearn
Type: string or Token
-
roleArn
¶ ApplicationResource.KinesisStreamsInputProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-rolearn
Type: string or Token
-
-
class
MappingParametersProperty
¶ -
jsonMappingParameters
¶ ApplicationResource.MappingParametersProperty.JSONMappingParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-jsonmappingparameters
Type: Token
orJSONMappingParametersProperty
or None
-
csvMappingParameters
¶ ApplicationResource.MappingParametersProperty.CSVMappingParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-csvmappingparameters
Type: Token
orCSVMappingParametersProperty
or None
-
-
class
RecordColumnProperty
¶ -
mapping
¶ ApplicationResource.RecordColumnProperty.Mapping http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-mapping
Type: string or Token
or None
-
sqlType
¶ ApplicationResource.RecordColumnProperty.SqlType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-sqltype
Type: string or Token
-
name
¶ ApplicationResource.RecordColumnProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-name
Type: string or Token
-
-
class
RecordFormatProperty
¶ -
mappingParameters
¶ ApplicationResource.RecordFormatProperty.MappingParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-mappingparameters
Type: Token
orMappingParametersProperty
or None
-
recordFormatType
¶ ApplicationResource.RecordFormatProperty.RecordFormatType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-recordformattype
Type: string or Token
-
- parent (
ApplicationResourceProps (interface)¶
-
class
_aws-cdk_resources.kinesisanalytics.
ApplicationResourceProps
¶ -
applicationName
¶ AWS::KinesisAnalytics::Application.ApplicationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationname
Type: string or Token
or None
-
inputs
¶ AWS::KinesisAnalytics::Application.Inputs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-inputs
Type: Token
orToken
orInputProperty
-
applicationDescription
¶ AWS::KinesisAnalytics::Application.ApplicationDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationdescription
Type: string or Token
or None
-
applicationCode
¶ AWS::KinesisAnalytics::Application.ApplicationCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html#cfn-kinesisanalytics-application-applicationcode
Type: string or Token
or None
-
kinesisfirehose¶
DeliveryStreamArn¶
DeliveryStreamResource¶
-
class
_aws-cdk_resources.kinesisfirehose.
DeliveryStreamResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DeliveryStreamResource is a part of - name (string) –
- props (
DeliveryStreamResourceProps
or None) – the properties of this DeliveryStreamResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
deliveryStreamArn
¶ Type: DeliveryStreamArn
(readonly)
-
class
BufferingHintsProperty
¶ -
intervalInSeconds
¶ DeliveryStreamResource.BufferingHintsProperty.IntervalInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-intervalinseconds
Type: number or Token
-
sizeInMBs
¶ DeliveryStreamResource.BufferingHintsProperty.SizeInMBs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-bufferinghints.html#cfn-kinesisfirehose-deliverystream-bufferinghints-sizeinmbs
Type: number or Token
-
-
class
CloudWatchLoggingOptionsProperty
¶ -
enabled
¶ DeliveryStreamResource.CloudWatchLoggingOptionsProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-enabled
Type: boolean or Token
or None
-
logGroupName
¶ DeliveryStreamResource.CloudWatchLoggingOptionsProperty.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-loggroupname
Type: string or Token
or None
-
logStreamName
¶ DeliveryStreamResource.CloudWatchLoggingOptionsProperty.LogStreamName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html#cfn-kinesisfirehose-deliverystream-cloudwatchloggingoptions-logstreamname
Type: string or Token
or None
-
-
class
CopyCommandProperty
¶ -
copyOptions
¶ DeliveryStreamResource.CopyCommandProperty.CopyOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-copyoptions
Type: string or Token
or None
-
dataTableColumns
¶ DeliveryStreamResource.CopyCommandProperty.DataTableColumns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablecolumns
Type: string or Token
or None
-
dataTableName
¶ DeliveryStreamResource.CopyCommandProperty.DataTableName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-copycommand.html#cfn-kinesisfirehose-deliverystream-copycommand-datatablename
Type: string or Token
-
-
class
ElasticsearchBufferingHintsProperty
¶ -
intervalInSeconds
¶ DeliveryStreamResource.ElasticsearchBufferingHintsProperty.IntervalInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-intervalinseconds
Type: number or Token
-
sizeInMBs
¶ DeliveryStreamResource.ElasticsearchBufferingHintsProperty.SizeInMBs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchbufferinghints.html#cfn-kinesisfirehose-deliverystream-elasticsearchbufferinghints-sizeinmbs
Type: number or Token
-
-
class
ElasticsearchDestinationConfigurationProperty
¶ -
bufferingHints
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.BufferingHints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-bufferinghints
Type: Token
orElasticsearchBufferingHintsProperty
-
cloudWatchLoggingOptions
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.CloudWatchLoggingOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-cloudwatchloggingoptions
Type: Token
orCloudWatchLoggingOptionsProperty
or None
-
domainArn
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.DomainARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-domainarn
Type: string or Token
-
indexName
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.IndexName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexname
Type: string or Token
-
indexRotationPeriod
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.IndexRotationPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-indexrotationperiod
Type: string or Token
-
processingConfiguration
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.ProcessingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-processingconfiguration
Type: Token
orProcessingConfigurationProperty
or None
-
retryOptions
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.RetryOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-retryoptions
Type: Token
orElasticsearchRetryOptionsProperty
-
roleArn
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-rolearn
Type: string or Token
-
s3BackupMode
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.S3BackupMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3backupmode
Type: string or Token
-
s3Configuration
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.S3Configuration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-s3configuration
Type: Token
orS3DestinationConfigurationProperty
-
typeName
¶ DeliveryStreamResource.ElasticsearchDestinationConfigurationProperty.TypeName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-typename
Type: string or Token
-
-
class
ElasticsearchRetryOptionsProperty
¶ -
durationInSeconds
¶ DeliveryStreamResource.ElasticsearchRetryOptionsProperty.DurationInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchretryoptions.html#cfn-kinesisfirehose-deliverystream-elasticsearchretryoptions-durationinseconds
Type: number or Token
-
-
class
EncryptionConfigurationProperty
¶ -
kmsEncryptionConfig
¶ DeliveryStreamResource.EncryptionConfigurationProperty.KMSEncryptionConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-kmsencryptionconfig
Type: Token
orKMSEncryptionConfigProperty
or None
-
noEncryptionConfig
¶ DeliveryStreamResource.EncryptionConfigurationProperty.NoEncryptionConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-encryptionconfiguration.html#cfn-kinesisfirehose-deliverystream-encryptionconfiguration-noencryptionconfig
Type: string or Token
or None
-
-
class
ExtendedS3DestinationConfigurationProperty
¶ -
bucketArn
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.BucketARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bucketarn
Type: string or Token
-
bufferingHints
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.BufferingHints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-bufferinghints
Type: Token
orBufferingHintsProperty
-
cloudWatchLoggingOptions
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.CloudWatchLoggingOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-cloudwatchloggingoptions
Type: Token
orCloudWatchLoggingOptionsProperty
or None
-
compressionFormat
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.CompressionFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-compressionformat
Type: string or Token
-
encryptionConfiguration
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.EncryptionConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-encryptionconfiguration
Type: Token
orEncryptionConfigurationProperty
or None
-
prefix
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-prefix
Type: string or Token
-
processingConfiguration
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.ProcessingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-processingconfiguration
Type: Token
orProcessingConfigurationProperty
or None
-
roleArn
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-rolearn
Type: string or Token
-
s3BackupConfiguration
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.S3BackupConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupconfiguration
Type: Token
orS3DestinationConfigurationProperty
or None
-
s3BackupMode
¶ DeliveryStreamResource.ExtendedS3DestinationConfigurationProperty.S3BackupMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-s3backupmode
Type: string or Token
or None
-
-
class
KMSEncryptionConfigProperty
¶ -
awskmsKeyArn
¶ DeliveryStreamResource.KMSEncryptionConfigProperty.AWSKMSKeyARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kmsencryptionconfig.html#cfn-kinesisfirehose-deliverystream-kmsencryptionconfig-awskmskeyarn
Type: string or Token
-
-
class
KinesisStreamSourceConfigurationProperty
¶ -
kinesisStreamArn
¶ DeliveryStreamResource.KinesisStreamSourceConfigurationProperty.KinesisStreamARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-kinesisstreamarn
Type: string or Token
-
roleArn
¶ DeliveryStreamResource.KinesisStreamSourceConfigurationProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration-rolearn
Type: string or Token
-
-
class
ProcessingConfigurationProperty
¶ -
enabled
¶ DeliveryStreamResource.ProcessingConfigurationProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-enabled
Type: boolean or Token
or None
-
processors
¶ DeliveryStreamResource.ProcessingConfigurationProperty.Processors http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html#cfn-kinesisfirehose-deliverystream-processingconfiguration-processors
Type: Token
orToken
orProcessorProperty
or None
-
-
class
ProcessorParameterProperty
¶ -
parameterName
¶ DeliveryStreamResource.ProcessorParameterProperty.ParameterName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametername
Type: string or Token
-
parameterValue
¶ DeliveryStreamResource.ProcessorParameterProperty.ParameterValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processorparameter.html#cfn-kinesisfirehose-deliverystream-processorparameter-parametervalue
Type: string or Token
-
-
class
ProcessorProperty
¶ -
parameters
¶ DeliveryStreamResource.ProcessorProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-parameters
Type: Token
orToken
orProcessorParameterProperty
-
type
¶ DeliveryStreamResource.ProcessorProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#cfn-kinesisfirehose-deliverystream-processor-type
Type: string or Token
-
-
class
RedshiftDestinationConfigurationProperty
¶ -
cloudWatchLoggingOptions
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.CloudWatchLoggingOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-cloudwatchloggingoptions
Type: Token
orCloudWatchLoggingOptionsProperty
or None
-
clusterJdbcurl
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.ClusterJDBCURL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-clusterjdbcurl
Type: string or Token
-
copyCommand
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.CopyCommand http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-copycommand
Type: Token
orCopyCommandProperty
-
password
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-password
Type: string or Token
-
processingConfiguration
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.ProcessingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-processingconfiguration
Type: Token
orProcessingConfigurationProperty
or None
-
roleArn
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-rolearn
Type: string or Token
-
s3Configuration
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.S3Configuration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-s3configuration
Type: Token
orS3DestinationConfigurationProperty
-
username
¶ DeliveryStreamResource.RedshiftDestinationConfigurationProperty.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration-username
Type: string or Token
-
-
class
S3DestinationConfigurationProperty
¶ -
bucketArn
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.BucketARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bucketarn
Type: string or Token
-
bufferingHints
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.BufferingHints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-bufferinghints
Type: Token
orBufferingHintsProperty
-
cloudWatchLoggingOptions
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.CloudWatchLoggingOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-cloudwatchloggingoptions
Type: Token
orCloudWatchLoggingOptionsProperty
or None
-
compressionFormat
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.CompressionFormat http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat
Type: string or Token
-
encryptionConfiguration
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.EncryptionConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-encryptionconfiguration
Type: Token
orEncryptionConfigurationProperty
or None
-
prefix
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-prefix
Type: string or Token
or None
-
roleArn
¶ DeliveryStreamResource.S3DestinationConfigurationProperty.RoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-rolearn
Type: string or Token
-
-
class
SplunkDestinationConfigurationProperty
¶ -
cloudWatchLoggingOptions
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.CloudWatchLoggingOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-cloudwatchloggingoptions
Type: Token
orCloudWatchLoggingOptionsProperty
or None
-
hecAcknowledgmentTimeoutInSeconds
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.HECAcknowledgmentTimeoutInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds
Type: number or Token
or None
-
hecEndpoint
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.HECEndpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint
Type: string or Token
-
hecEndpointType
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.HECEndpointType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpointtype
Type: string or Token
-
hecToken
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.HECToken http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hectoken
Type: string or Token
-
processingConfiguration
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.ProcessingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-processingconfiguration
Type: Token
orProcessingConfigurationProperty
or None
-
retryOptions
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.RetryOptions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions
Type: Token
orSplunkRetryOptionsProperty
or None
-
s3BackupMode
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.S3BackupMode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3backupmode
Type: string or Token
or None
-
s3Configuration
¶ DeliveryStreamResource.SplunkDestinationConfigurationProperty.S3Configuration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-s3configuration
Type: Token
orS3DestinationConfigurationProperty
-
-
class
SplunkRetryOptionsProperty
¶ -
durationInSeconds
¶ DeliveryStreamResource.SplunkRetryOptionsProperty.DurationInSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds
Type: number or Token
-
- parent (
DeliveryStreamResourceProps (interface)¶
-
class
_aws-cdk_resources.kinesisfirehose.
DeliveryStreamResourceProps
¶ -
deliveryStreamName
¶ AWS::KinesisFirehose::DeliveryStream.DeliveryStreamName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname
Type: string or Token
or None
-
deliveryStreamType
¶ AWS::KinesisFirehose::DeliveryStream.DeliveryStreamType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype
Type: string or Token
or None
-
elasticsearchDestinationConfiguration
¶ AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration
Type: Token
orElasticsearchDestinationConfigurationProperty
or None
-
extendedS3DestinationConfiguration
¶ AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration
Type: Token
orExtendedS3DestinationConfigurationProperty
or None
-
kinesisStreamSourceConfiguration
¶ AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration
Type: Token
orKinesisStreamSourceConfigurationProperty
or None
-
redshiftDestinationConfiguration
¶ AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration
Type: Token
orRedshiftDestinationConfigurationProperty
or None
-
s3DestinationConfiguration
¶ AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration
Type: Token
orS3DestinationConfigurationProperty
or None
-
splunkDestinationConfiguration
¶ AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration
Type: Token
orSplunkDestinationConfigurationProperty
or None
-
kms¶
AliasResource¶
-
class
_aws-cdk_resources.kms.
AliasResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AliasResource is a part of - name (string) –
- props (
AliasResourceProps
or None) – the properties of this AliasResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
AliasResourceProps (interface)¶
-
class
_aws-cdk_resources.kms.
AliasResourceProps
¶ -
aliasName
¶ AWS::KMS::Alias.AliasName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname
Type: string or Token
-
targetKeyId
¶ AWS::KMS::Alias.TargetKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid
Type: string or Token
-
KeyArn¶
KeyResource¶
-
class
_aws-cdk_resources.kms.
KeyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this KeyResource is a part of - name (string) –
- props (
KeyResourceProps
or None) – the properties of this KeyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
keyArn
¶ Type: KeyArn
(readonly)
- parent (
KeyResourceProps (interface)¶
-
class
_aws-cdk_resources.kms.
KeyResourceProps
¶ -
description
¶ AWS::KMS::Key.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description
Type: string or Token
or None
-
enableKeyRotation
¶ AWS::KMS::Key.EnableKeyRotation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation
Type: boolean or Token
or None
-
enabled
¶ AWS::KMS::Key.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled
Type: boolean or Token
or None
-
keyPolicy
¶ AWS::KMS::Key.KeyPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy
Type: json or Token
-
keyUsage
¶ AWS::KMS::Key.KeyUsage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage
Type: string or Token
or None
AWS::KMS::Key.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-tags
Type: Token
orToken
orTag
or None
-
lambda¶
AliasResource¶
-
class
_aws-cdk_resources.lambda.
AliasResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AliasResource is a part of - name (string) –
- props (
AliasResourceProps
or None) – the properties of this AliasResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AliasRoutingConfigurationProperty
¶ -
additionalVersionWeights
¶ AliasResource.AliasRoutingConfigurationProperty.AdditionalVersionWeights http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html#cfn-lambda-alias-aliasroutingconfiguration-additionalversionweights
Type: Token
orToken
orVersionWeightProperty
-
-
class
VersionWeightProperty
¶ -
functionVersion
¶ AliasResource.VersionWeightProperty.FunctionVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion
Type: string or Token
-
functionWeight
¶ AliasResource.VersionWeightProperty.FunctionWeight http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight
Type: number or Token
-
- parent (
AliasResourceProps (interface)¶
-
class
_aws-cdk_resources.lambda.
AliasResourceProps
¶ -
description
¶ AWS::Lambda::Alias.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description
Type: string or Token
or None
-
functionName
¶ AWS::Lambda::Alias.FunctionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname
Type: string or Token
-
functionVersion
¶ AWS::Lambda::Alias.FunctionVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion
Type: string or Token
-
aliasName
¶ AWS::Lambda::Alias.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name
Type: string or Token
-
routingConfig
¶ AWS::Lambda::Alias.RoutingConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig
Type: Token
orAliasRoutingConfigurationProperty
or None
-
EventSourceMappingResource¶
-
class
_aws-cdk_resources.lambda.
EventSourceMappingResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EventSourceMappingResource is a part of - name (string) –
- props (
EventSourceMappingResourceProps
or None) – the properties of this EventSourceMappingResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
EventSourceMappingResourceProps (interface)¶
-
class
_aws-cdk_resources.lambda.
EventSourceMappingResourceProps
¶ -
batchSize
¶ AWS::Lambda::EventSourceMapping.BatchSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize
Type: number or Token
or None
-
enabled
¶ AWS::Lambda::EventSourceMapping.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled
Type: boolean or Token
or None
-
eventSourceArn
¶ AWS::Lambda::EventSourceMapping.EventSourceArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn
Type: string or Token
-
functionName
¶ AWS::Lambda::EventSourceMapping.FunctionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname
Type: string or Token
-
startingPosition
¶ AWS::Lambda::EventSourceMapping.StartingPosition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition
Type: string or Token
or None
-
FunctionArn¶
FunctionResource¶
-
class
_aws-cdk_resources.lambda.
FunctionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this FunctionResource is a part of - name (string) –
- props (
FunctionResourceProps
or None) – the properties of this FunctionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
functionArn
¶ Type: FunctionArn
(readonly)
-
class
CodeProperty
¶ -
s3Bucket
¶ FunctionResource.CodeProperty.S3Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket
Type: string or Token
or None
-
s3Key
¶ FunctionResource.CodeProperty.S3Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key
Type: string or Token
or None
-
s3ObjectVersion
¶ FunctionResource.CodeProperty.S3ObjectVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion
Type: string or Token
or None
-
zipFile
¶ FunctionResource.CodeProperty.ZipFile http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile
Type: string or Token
or None
-
-
class
DeadLetterConfigProperty
¶ -
targetArn
¶ FunctionResource.DeadLetterConfigProperty.TargetArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn
Type: string or Token
or None
-
-
class
EnvironmentProperty
¶ -
variables
¶ FunctionResource.EnvironmentProperty.Variables http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html#cfn-lambda-function-environment-variables
Type: Token
or string orToken
or None
-
-
class
TracingConfigProperty
¶ -
mode
¶ FunctionResource.TracingConfigProperty.Mode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html#cfn-lambda-function-tracingconfig-mode
Type: string or Token
or None
-
-
class
VpcConfigProperty
¶ -
securityGroupIds
¶ FunctionResource.VpcConfigProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-securitygroupids
Type: Token
or string orToken
-
subnetIds
¶ FunctionResource.VpcConfigProperty.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-subnetids
Type: Token
or string orToken
-
- parent (
FunctionResourceProps (interface)¶
-
class
_aws-cdk_resources.lambda.
FunctionResourceProps
¶ -
code
¶ AWS::Lambda::Function.Code http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code
Type: Token
orCodeProperty
-
deadLetterConfig
¶ AWS::Lambda::Function.DeadLetterConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig
Type: Token
orDeadLetterConfigProperty
or None
-
description
¶ AWS::Lambda::Function.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description
Type: string or Token
or None
-
environment
¶ AWS::Lambda::Function.Environment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment
Type: Token
orEnvironmentProperty
or None
-
functionName
¶ AWS::Lambda::Function.FunctionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname
Type: string or Token
or None
-
handler
¶ AWS::Lambda::Function.Handler http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler
Type: string or Token
-
kmsKeyArn
¶ AWS::Lambda::Function.KmsKeyArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn
Type: string or Token
or None
-
memorySize
¶ AWS::Lambda::Function.MemorySize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize
Type: number or Token
or None
-
reservedConcurrentExecutions
¶ AWS::Lambda::Function.ReservedConcurrentExecutions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions
Type: number or Token
or None
-
role
¶ AWS::Lambda::Function.Role http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role
Type: string or Token
-
runtime
¶ AWS::Lambda::Function.Runtime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime
Type: string or Token
AWS::Lambda::Function.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags
Type: Token
orToken
orTag
or None
-
timeout
¶ AWS::Lambda::Function.Timeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout
Type: number or Token
or None
-
tracingConfig
¶ AWS::Lambda::Function.TracingConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig
Type: Token
orTracingConfigProperty
or None
-
vpcConfig
¶ AWS::Lambda::Function.VpcConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig
Type: Token
orVpcConfigProperty
or None
-
PermissionResource¶
-
class
_aws-cdk_resources.lambda.
PermissionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PermissionResource is a part of - name (string) –
- props (
PermissionResourceProps
or None) – the properties of this PermissionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
PermissionResourceProps (interface)¶
-
class
_aws-cdk_resources.lambda.
PermissionResourceProps
¶ -
action
¶ AWS::Lambda::Permission.Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action
Type: string or Token
-
eventSourceToken
¶ AWS::Lambda::Permission.EventSourceToken http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken
Type: string or Token
or None
-
functionName
¶ AWS::Lambda::Permission.FunctionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname
Type: string or Token
-
principal
¶ AWS::Lambda::Permission.Principal http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal
Type: string or Token
-
sourceAccount
¶ AWS::Lambda::Permission.SourceAccount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount
Type: string or Token
or None
-
sourceArn
¶ AWS::Lambda::Permission.SourceArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn
Type: string or Token
or None
-
Version¶
VersionResource¶
-
class
_aws-cdk_resources.lambda.
VersionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VersionResource is a part of - name (string) –
- props (
VersionResourceProps
or None) – the properties of this VersionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
version
¶ Type: Version
(readonly)
- parent (
VersionResourceProps (interface)¶
-
class
_aws-cdk_resources.lambda.
VersionResourceProps
¶ -
codeSha256
¶ AWS::Lambda::Version.CodeSha256 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256
Type: string or Token
or None
-
description
¶ AWS::Lambda::Version.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description
Type: string or Token
or None
-
functionName
¶ AWS::Lambda::Version.FunctionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname
Type: string or Token
-
logs¶
DestinationArn¶
DestinationResource¶
-
class
_aws-cdk_resources.logs.
DestinationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DestinationResource is a part of - name (string) –
- props (
DestinationResourceProps
or None) – the properties of this DestinationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
destinationArn
¶ Type: DestinationArn
(readonly)
- parent (
DestinationResourceProps (interface)¶
-
class
_aws-cdk_resources.logs.
DestinationResourceProps
¶ -
destinationName
¶ AWS::Logs::Destination.DestinationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname
Type: string or Token
-
destinationPolicy
¶ AWS::Logs::Destination.DestinationPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy
Type: string or Token
-
roleArn
¶ AWS::Logs::Destination.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn
Type: string or Token
-
targetArn
¶ AWS::Logs::Destination.TargetArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn
Type: string or Token
-
LogGroupArn¶
LogGroupResource¶
-
class
_aws-cdk_resources.logs.
LogGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LogGroupResource is a part of - name (string) –
- props (
LogGroupResourceProps
or None) – the properties of this LogGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
logGroupArn
¶ Type: LogGroupArn
(readonly)
- parent (
LogGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.logs.
LogGroupResourceProps
¶ -
logGroupName
¶ AWS::Logs::LogGroup.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-loggroupname
Type: string or Token
or None
-
retentionInDays
¶ AWS::Logs::LogGroup.RetentionInDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-cwl-loggroup-retentionindays
Type: number or Token
or None
-
LogStreamResource¶
-
class
_aws-cdk_resources.logs.
LogStreamResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LogStreamResource is a part of - name (string) –
- props (
LogStreamResourceProps
or None) – the properties of this LogStreamResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
LogStreamResourceProps (interface)¶
-
class
_aws-cdk_resources.logs.
LogStreamResourceProps
¶ -
logGroupName
¶ AWS::Logs::LogStream.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname
Type: string or Token
-
logStreamName
¶ AWS::Logs::LogStream.LogStreamName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname
Type: string or Token
or None
-
MetricFilterResource¶
-
class
_aws-cdk_resources.logs.
MetricFilterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MetricFilterResource is a part of - name (string) –
- props (
MetricFilterResourceProps
or None) – the properties of this MetricFilterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
MetricTransformationProperty
¶ -
defaultValue
¶ MetricFilterResource.MetricTransformationProperty.DefaultValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-defaultvalue
Type: number or Token
or None
-
metricName
¶ MetricFilterResource.MetricTransformationProperty.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricname
Type: string or Token
-
metricNamespace
¶ MetricFilterResource.MetricTransformationProperty.MetricNamespace http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricnamespace
Type: string or Token
-
metricValue
¶ MetricFilterResource.MetricTransformationProperty.MetricValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html#cfn-cwl-metricfilter-metrictransformation-metricvalue
Type: string or Token
-
- parent (
MetricFilterResourceProps (interface)¶
-
class
_aws-cdk_resources.logs.
MetricFilterResourceProps
¶ -
filterPattern
¶ AWS::Logs::MetricFilter.FilterPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-filterpattern
Type: string or Token
-
logGroupName
¶ AWS::Logs::MetricFilter.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-loggroupname
Type: string or Token
-
metricTransformations
¶ AWS::Logs::MetricFilter.MetricTransformations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-cwl-metricfilter-metrictransformations
Type: Token
orToken
orMetricTransformationProperty
-
SubscriptionFilterResource¶
-
class
_aws-cdk_resources.logs.
SubscriptionFilterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubscriptionFilterResource is a part of - name (string) –
- props (
SubscriptionFilterResourceProps
or None) – the properties of this SubscriptionFilterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SubscriptionFilterResourceProps (interface)¶
-
class
_aws-cdk_resources.logs.
SubscriptionFilterResourceProps
¶ -
destinationArn
¶ AWS::Logs::SubscriptionFilter.DestinationArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-destinationarn
Type: string or Token
-
filterPattern
¶ AWS::Logs::SubscriptionFilter.FilterPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern
Type: string or Token
-
logGroupName
¶ AWS::Logs::SubscriptionFilter.LogGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname
Type: string or Token
-
roleArn
¶ AWS::Logs::SubscriptionFilter.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-rolearn
Type: string or Token
or None
-
neptune¶
DBClusterClusterResourceId¶
DBClusterEndpoint¶
DBClusterParameterGroupResource¶
-
class
_aws-cdk_resources.neptune.
DBClusterParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBClusterParameterGroupResource is a part of - name (string) –
- props (
DBClusterParameterGroupResourceProps
or None) – the properties of this DBClusterParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBClusterParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.neptune.
DBClusterParameterGroupResourceProps
¶ -
description
¶ AWS::Neptune::DBClusterParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description
Type: string or Token
-
parameters
¶ AWS::Neptune::DBClusterParameterGroup.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-parameters
Type: json or Token
-
family
¶ AWS::Neptune::DBClusterParameterGroup.Family http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-family
Type: string or Token
AWS::Neptune::DBClusterParameterGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags
Type: Token
orToken
orTag
or None
-
dbClusterParameterGroupName
¶ AWS::Neptune::DBClusterParameterGroup.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-name
Type: string or Token
or None
-
DBClusterPort¶
DBClusterReadEndpoint¶
DBClusterResource¶
-
class
_aws-cdk_resources.neptune.
DBClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBClusterResource is a part of - name (string) –
- props (
DBClusterResourceProps
or None) – the properties of this DBClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
dbClusterClusterResourceId
¶ Type: DBClusterClusterResourceId
(readonly)
-
dbClusterEndpoint
¶ Type: DBClusterEndpoint
(readonly)
-
dbClusterPort
¶ Type: DBClusterPort
(readonly)
-
dbClusterReadEndpoint
¶ Type: DBClusterReadEndpoint
(readonly)
- parent (
DBClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.neptune.
DBClusterResourceProps
¶ -
storageEncrypted
¶ AWS::Neptune::DBCluster.StorageEncrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-storageencrypted
Type: boolean or Token
or None
-
kmsKeyId
¶ AWS::Neptune::DBCluster.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-kmskeyid
Type: string or Token
or None
-
availabilityZones
¶ AWS::Neptune::DBCluster.AvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-availabilityzones
Type: Token
or string orToken
or None
-
snapshotIdentifier
¶ AWS::Neptune::DBCluster.SnapshotIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-snapshotidentifier
Type: string or Token
or None
-
port
¶ AWS::Neptune::DBCluster.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-port
Type: number or Token
or None
-
dbClusterIdentifier
¶ AWS::Neptune::DBCluster.DBClusterIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusteridentifier
Type: string or Token
or None
-
preferredMaintenanceWindow
¶ AWS::Neptune::DBCluster.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredmaintenancewindow
Type: string or Token
or None
-
iamAuthEnabled
¶ AWS::Neptune::DBCluster.IamAuthEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-iamauthenabled
Type: boolean or Token
or None
-
dbSubnetGroupName
¶ AWS::Neptune::DBCluster.DBSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbsubnetgroupname
Type: string or Token
or None
-
preferredBackupWindow
¶ AWS::Neptune::DBCluster.PreferredBackupWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-preferredbackupwindow
Type: string or Token
or None
-
vpcSecurityGroupIds
¶ AWS::Neptune::DBCluster.VpcSecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-vpcsecuritygroupids
Type: Token
or string orToken
or None
-
dbClusterParameterGroupName
¶ AWS::Neptune::DBCluster.DBClusterParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-dbclusterparametergroupname
Type: string or Token
or None
-
backupRetentionPeriod
¶ AWS::Neptune::DBCluster.BackupRetentionPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-backupretentionperiod
Type: number or Token
or None
AWS::Neptune::DBCluster.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html#cfn-neptune-dbcluster-tags
Type: Token
orToken
orTag
or None
-
DBInstanceEndpoint¶
DBInstancePort¶
DBInstanceResource¶
-
class
_aws-cdk_resources.neptune.
DBInstanceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBInstanceResource is a part of - name (string) –
- props (
DBInstanceResourceProps
or None) – the properties of this DBInstanceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
dbInstanceEndpoint
¶ Type: DBInstanceEndpoint
(readonly)
-
dbInstancePort
¶ Type: DBInstancePort
(readonly)
- parent (
DBInstanceResourceProps (interface)¶
-
class
_aws-cdk_resources.neptune.
DBInstanceResourceProps
¶ -
dbParameterGroupName
¶ AWS::Neptune::DBInstance.DBParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbparametergroupname
Type: string or Token
or None
-
dbInstanceClass
¶ AWS::Neptune::DBInstance.DBInstanceClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceclass
Type: string or Token
-
allowMajorVersionUpgrade
¶ AWS::Neptune::DBInstance.AllowMajorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-allowmajorversionupgrade
Type: boolean or Token
or None
-
dbClusterIdentifier
¶ AWS::Neptune::DBInstance.DBClusterIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbclusteridentifier
Type: string or Token
or None
-
availabilityZone
¶ AWS::Neptune::DBInstance.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-availabilityzone
Type: string or Token
or None
-
preferredMaintenanceWindow
¶ AWS::Neptune::DBInstance.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow
Type: string or Token
or None
-
autoMinorVersionUpgrade
¶ AWS::Neptune::DBInstance.AutoMinorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-autominorversionupgrade
Type: boolean or Token
or None
-
dbSubnetGroupName
¶ AWS::Neptune::DBInstance.DBSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsubnetgroupname
Type: string or Token
or None
-
dbInstanceIdentifier
¶ AWS::Neptune::DBInstance.DBInstanceIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceidentifier
Type: string or Token
or None
-
dbSnapshotIdentifier
¶ AWS::Neptune::DBInstance.DBSnapshotIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsnapshotidentifier
Type: string or Token
or None
AWS::Neptune::DBInstance.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags
Type: Token
orToken
orTag
or None
-
DBParameterGroupResource¶
-
class
_aws-cdk_resources.neptune.
DBParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBParameterGroupResource is a part of - name (string) –
- props (
DBParameterGroupResourceProps
or None) – the properties of this DBParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.neptune.
DBParameterGroupResourceProps
¶ -
description
¶ AWS::Neptune::DBParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description
Type: string or Token
-
parameters
¶ AWS::Neptune::DBParameterGroup.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-parameters
Type: json or Token
-
family
¶ AWS::Neptune::DBParameterGroup.Family http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-family
Type: string or Token
AWS::Neptune::DBParameterGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-tags
Type: Token
orToken
orTag
or None
-
dbParameterGroupName
¶ AWS::Neptune::DBParameterGroup.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-name
Type: string or Token
or None
-
DBSubnetGroupResource¶
-
class
_aws-cdk_resources.neptune.
DBSubnetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBSubnetGroupResource is a part of - name (string) –
- props (
DBSubnetGroupResourceProps
or None) – the properties of this DBSubnetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBSubnetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.neptune.
DBSubnetGroupResourceProps
¶ -
dbSubnetGroupName
¶ AWS::Neptune::DBSubnetGroup.DBSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-dbsubnetgroupname
Type: string or Token
or None
-
dbSubnetGroupDescription
¶ AWS::Neptune::DBSubnetGroup.DBSubnetGroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-dbsubnetgroupdescription
Type: string or Token
-
subnetIds
¶ AWS::Neptune::DBSubnetGroup.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-subnetids
Type: Token
or string orToken
AWS::Neptune::DBSubnetGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbsubnetgroup.html#cfn-neptune-dbsubnetgroup-tags
Type: Token
orToken
orTag
or None
-
opsworks¶
AppResource¶
-
class
_aws-cdk_resources.opsworks.
AppResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AppResource is a part of - name (string) –
- props (
AppResourceProps
or None) – the properties of this AppResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
DataSourceProperty
¶ -
arn
¶ AppResource.DataSourceProperty.Arn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn
Type: string or Token
or None
-
databaseName
¶ AppResource.DataSourceProperty.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename
Type: string or Token
or None
-
type
¶ AppResource.DataSourceProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-type
Type: string or Token
or None
-
-
class
EnvironmentVariableProperty
¶ -
key
¶ AppResource.EnvironmentVariableProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-key
Type: string or Token
-
secure
¶ AppResource.EnvironmentVariableProperty.Secure http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#cfn-opsworks-app-environment-secure
Type: boolean or Token
or None
-
value
¶ AppResource.EnvironmentVariableProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environment.html#value
Type: string or Token
-
-
class
SourceProperty
¶ -
password
¶ AppResource.SourceProperty.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-pw
Type: string or Token
or None
-
revision
¶ AppResource.SourceProperty.Revision http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision
Type: string or Token
or None
-
sshKey
¶ AppResource.SourceProperty.SshKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey
Type: string or Token
or None
-
type
¶ AppResource.SourceProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type
Type: string or Token
or None
-
url
¶ AppResource.SourceProperty.Url http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url
Type: string or Token
or None
-
username
¶ AppResource.SourceProperty.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username
Type: string or Token
or None
-
-
class
SslConfigurationProperty
¶ -
certificate
¶ AppResource.SslConfigurationProperty.Certificate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-certificate
Type: string or Token
or None
-
chain
¶ AppResource.SslConfigurationProperty.Chain http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-chain
Type: string or Token
or None
-
privateKey
¶ AppResource.SslConfigurationProperty.PrivateKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfig-privatekey
Type: string or Token
or None
-
- parent (
AppResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
AppResourceProps
¶ -
appSource
¶ AWS::OpsWorks::App.AppSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource
Type: Token
orSourceProperty
or None
-
attributes
¶ AWS::OpsWorks::App.Attributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes
Type: Token
or string orToken
or None
-
dataSources
¶ AWS::OpsWorks::App.DataSources http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources
Type: Token
orToken
orDataSourceProperty
or None
-
description
¶ AWS::OpsWorks::App.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description
Type: string or Token
or None
-
domains
¶ AWS::OpsWorks::App.Domains http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains
Type: Token
or string orToken
or None
-
enableSsl
¶ AWS::OpsWorks::App.EnableSsl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl
Type: boolean or Token
or None
-
environment
¶ AWS::OpsWorks::App.Environment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment
Type: Token
orToken
orEnvironmentVariableProperty
or None
-
appName
¶ AWS::OpsWorks::App.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name
Type: string or Token
-
shortname
¶ AWS::OpsWorks::App.Shortname http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname
Type: string or Token
or None
-
sslConfiguration
¶ AWS::OpsWorks::App.SslConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration
Type: Token
orSslConfigurationProperty
or None
-
stackId
¶ AWS::OpsWorks::App.StackId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid
Type: string or Token
-
type
¶ AWS::OpsWorks::App.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type
Type: string or Token
-
ElasticLoadBalancerAttachmentResource¶
-
class
_aws-cdk_resources.opsworks.
ElasticLoadBalancerAttachmentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ElasticLoadBalancerAttachmentResource is a part of - name (string) –
- props (
ElasticLoadBalancerAttachmentResourceProps
or None) – the properties of this ElasticLoadBalancerAttachmentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ElasticLoadBalancerAttachmentResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
ElasticLoadBalancerAttachmentResourceProps
¶ -
elasticLoadBalancerName
¶ AWS::OpsWorks::ElasticLoadBalancerAttachment.ElasticLoadBalancerName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-elbname
Type: string or Token
-
layerId
¶ AWS::OpsWorks::ElasticLoadBalancerAttachment.LayerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html#cfn-opsworks-elbattachment-layerid
Type: string or Token
-
InstanceAvailabilityZone¶
InstancePrivateDnsName¶
InstancePrivateIp¶
InstancePublicDnsName¶
InstancePublicIp¶
InstanceResource¶
-
class
_aws-cdk_resources.opsworks.
InstanceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InstanceResource is a part of - name (string) –
- props (
InstanceResourceProps
or None) – the properties of this InstanceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
instanceAvailabilityZone
¶ Type: InstanceAvailabilityZone
(readonly)
-
instancePrivateDnsName
¶ Type: InstancePrivateDnsName
(readonly)
-
instancePrivateIp
¶ Type: InstancePrivateIp
(readonly)
-
instancePublicDnsName
¶ Type: InstancePublicDnsName
(readonly)
-
instancePublicIp
¶ Type: InstancePublicIp
(readonly)
-
class
BlockDeviceMappingProperty
¶ -
deviceName
¶ InstanceResource.BlockDeviceMappingProperty.DeviceName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename
Type: string or Token
or None
-
ebs
¶ InstanceResource.BlockDeviceMappingProperty.Ebs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs
Type: Token
orEbsBlockDeviceProperty
or None
-
noDevice
¶ InstanceResource.BlockDeviceMappingProperty.NoDevice http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice
Type: string or Token
or None
-
virtualName
¶ InstanceResource.BlockDeviceMappingProperty.VirtualName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname
Type: string or Token
or None
-
-
class
EbsBlockDeviceProperty
¶ -
deleteOnTermination
¶ InstanceResource.EbsBlockDeviceProperty.DeleteOnTermination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination
Type: boolean or Token
or None
-
iops
¶ InstanceResource.EbsBlockDeviceProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops
Type: number or Token
or None
-
snapshotId
¶ InstanceResource.EbsBlockDeviceProperty.SnapshotId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid
Type: string or Token
or None
-
volumeSize
¶ InstanceResource.EbsBlockDeviceProperty.VolumeSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize
Type: number or Token
or None
-
volumeType
¶ InstanceResource.EbsBlockDeviceProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype
Type: string or Token
or None
-
-
class
TimeBasedAutoScalingProperty
¶ -
friday
¶ InstanceResource.TimeBasedAutoScalingProperty.Friday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-friday
Type: Token
or string orToken
or None
-
monday
¶ InstanceResource.TimeBasedAutoScalingProperty.Monday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-monday
Type: Token
or string orToken
or None
-
saturday
¶ InstanceResource.TimeBasedAutoScalingProperty.Saturday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-saturday
Type: Token
or string orToken
or None
-
sunday
¶ InstanceResource.TimeBasedAutoScalingProperty.Sunday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-sunday
Type: Token
or string orToken
or None
-
thursday
¶ InstanceResource.TimeBasedAutoScalingProperty.Thursday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-thursday
Type: Token
or string orToken
or None
-
tuesday
¶ InstanceResource.TimeBasedAutoScalingProperty.Tuesday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-tuesday
Type: Token
or string orToken
or None
-
wednesday
¶ InstanceResource.TimeBasedAutoScalingProperty.Wednesday http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-wednesday
Type: Token
or string orToken
or None
-
- parent (
InstanceResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
InstanceResourceProps
¶ -
agentVersion
¶ AWS::OpsWorks::Instance.AgentVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion
Type: string or Token
or None
-
amiId
¶ AWS::OpsWorks::Instance.AmiId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid
Type: string or Token
or None
-
architecture
¶ AWS::OpsWorks::Instance.Architecture http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture
Type: string or Token
or None
-
autoScalingType
¶ AWS::OpsWorks::Instance.AutoScalingType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype
Type: string or Token
or None
-
availabilityZone
¶ AWS::OpsWorks::Instance.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone
Type: string or Token
or None
-
blockDeviceMappings
¶ AWS::OpsWorks::Instance.BlockDeviceMappings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings
Type: Token
orToken
orBlockDeviceMappingProperty
or None
-
ebsOptimized
¶ AWS::OpsWorks::Instance.EbsOptimized http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized
Type: boolean or Token
or None
-
elasticIps
¶ AWS::OpsWorks::Instance.ElasticIps http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips
Type: Token
or string orToken
or None
-
hostname
¶ AWS::OpsWorks::Instance.Hostname http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname
Type: string or Token
or None
-
installUpdatesOnBoot
¶ AWS::OpsWorks::Instance.InstallUpdatesOnBoot http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot
Type: boolean or Token
or None
-
instanceType
¶ AWS::OpsWorks::Instance.InstanceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype
Type: string or Token
-
layerIds
¶ AWS::OpsWorks::Instance.LayerIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids
Type: Token
or string orToken
-
os
¶ AWS::OpsWorks::Instance.Os http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os
Type: string or Token
or None
-
rootDeviceType
¶ AWS::OpsWorks::Instance.RootDeviceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype
Type: string or Token
or None
-
sshKeyName
¶ AWS::OpsWorks::Instance.SshKeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname
Type: string or Token
or None
-
stackId
¶ AWS::OpsWorks::Instance.StackId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid
Type: string or Token
-
subnetId
¶ AWS::OpsWorks::Instance.SubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid
Type: string or Token
or None
-
tenancy
¶ AWS::OpsWorks::Instance.Tenancy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy
Type: string or Token
or None
-
timeBasedAutoScaling
¶ AWS::OpsWorks::Instance.TimeBasedAutoScaling http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling
Type: Token
orTimeBasedAutoScalingProperty
or None
-
virtualizationType
¶ AWS::OpsWorks::Instance.VirtualizationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype
Type: string or Token
or None
-
volumes
¶ AWS::OpsWorks::Instance.Volumes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes
Type: Token
or string orToken
or None
-
LayerResource¶
-
class
_aws-cdk_resources.opsworks.
LayerResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LayerResource is a part of - name (string) –
- props (
LayerResourceProps
or None) – the properties of this LayerResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AutoScalingThresholdsProperty
¶ -
cpuThreshold
¶ LayerResource.AutoScalingThresholdsProperty.CpuThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-cputhreshold
Type: number or Token
or None
-
ignoreMetricsTime
¶ LayerResource.AutoScalingThresholdsProperty.IgnoreMetricsTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-ignoremetricstime
Type: number or Token
or None
-
instanceCount
¶ LayerResource.AutoScalingThresholdsProperty.InstanceCount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-instancecount
Type: number or Token
or None
-
loadThreshold
¶ LayerResource.AutoScalingThresholdsProperty.LoadThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-loadthreshold
Type: number or Token
or None
-
memoryThreshold
¶ LayerResource.AutoScalingThresholdsProperty.MemoryThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-memorythreshold
Type: number or Token
or None
-
thresholdsWaitTime
¶ LayerResource.AutoScalingThresholdsProperty.ThresholdsWaitTime http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling-autoscalingthresholds.html#cfn-opsworks-layer-loadbasedautoscaling-autoscalingthresholds-thresholdwaittime
Type: number or Token
or None
-
-
class
LifecycleEventConfigurationProperty
¶ -
shutdownEventConfiguration
¶ LayerResource.LifecycleEventConfigurationProperty.ShutdownEventConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration
Type: Token
orShutdownEventConfigurationProperty
or None
-
-
class
LoadBasedAutoScalingProperty
¶ -
downScaling
¶ LayerResource.LoadBasedAutoScalingProperty.DownScaling http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-downscaling
Type: Token
orAutoScalingThresholdsProperty
or None
-
enable
¶ LayerResource.LoadBasedAutoScalingProperty.Enable http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-enable
Type: boolean or Token
or None
-
upScaling
¶ LayerResource.LoadBasedAutoScalingProperty.UpScaling http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-upscaling
Type: Token
orAutoScalingThresholdsProperty
or None
-
-
class
RecipesProperty
¶ -
configure
¶ LayerResource.RecipesProperty.Configure http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-configure
Type: Token
or string orToken
or None
-
deploy
¶ LayerResource.RecipesProperty.Deploy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-deploy
Type: Token
or string orToken
or None
-
setup
¶ LayerResource.RecipesProperty.Setup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-setup
Type: Token
or string orToken
or None
-
shutdown
¶ LayerResource.RecipesProperty.Shutdown http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-shutdown
Type: Token
or string orToken
or None
-
undeploy
¶ LayerResource.RecipesProperty.Undeploy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-customrecipes-undeploy
Type: Token
or string orToken
or None
-
-
class
ShutdownEventConfigurationProperty
¶ -
delayUntilElbConnectionsDrained
¶ LayerResource.ShutdownEventConfigurationProperty.DelayUntilElbConnectionsDrained http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-delayuntilelbconnectionsdrained
Type: boolean or Token
or None
-
executionTimeout
¶ LayerResource.ShutdownEventConfigurationProperty.ExecutionTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration.html#cfn-opsworks-layer-lifecycleconfiguration-shutdowneventconfiguration-executiontimeout
Type: number or Token
or None
-
-
class
VolumeConfigurationProperty
¶ -
iops
¶ LayerResource.VolumeConfigurationProperty.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-iops
Type: number or Token
or None
-
mountPoint
¶ LayerResource.VolumeConfigurationProperty.MountPoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-mountpoint
Type: string or Token
or None
-
numberOfDisks
¶ LayerResource.VolumeConfigurationProperty.NumberOfDisks http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-numberofdisks
Type: number or Token
or None
-
raidLevel
¶ LayerResource.VolumeConfigurationProperty.RaidLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-raidlevel
Type: number or Token
or None
-
size
¶ LayerResource.VolumeConfigurationProperty.Size http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-size
Type: number or Token
or None
-
volumeType
¶ LayerResource.VolumeConfigurationProperty.VolumeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volconfig-volumetype
Type: string or Token
or None
-
- parent (
LayerResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
LayerResourceProps
¶ -
attributes
¶ AWS::OpsWorks::Layer.Attributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-attributes
Type: Token
or string orToken
or None
-
autoAssignElasticIps
¶ AWS::OpsWorks::Layer.AutoAssignElasticIps http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignelasticips
Type: boolean or Token
-
autoAssignPublicIps
¶ AWS::OpsWorks::Layer.AutoAssignPublicIps http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignpublicips
Type: boolean or Token
-
customInstanceProfileArn
¶ AWS::OpsWorks::Layer.CustomInstanceProfileArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-custominstanceprofilearn
Type: string or Token
or None
-
customJson
¶ AWS::OpsWorks::Layer.CustomJson http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customjson
Type: json or Token
or None
-
customRecipes
¶ AWS::OpsWorks::Layer.CustomRecipes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customrecipes
Type: Token
orRecipesProperty
or None
-
customSecurityGroupIds
¶ AWS::OpsWorks::Layer.CustomSecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customsecuritygroupids
Type: Token
or string orToken
or None
-
enableAutoHealing
¶ AWS::OpsWorks::Layer.EnableAutoHealing http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-enableautohealing
Type: boolean or Token
-
installUpdatesOnBoot
¶ AWS::OpsWorks::Layer.InstallUpdatesOnBoot http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-installupdatesonboot
Type: boolean or Token
or None
-
lifecycleEventConfiguration
¶ AWS::OpsWorks::Layer.LifecycleEventConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-lifecycleeventconfiguration
Type: Token
orLifecycleEventConfigurationProperty
or None
-
loadBasedAutoScaling
¶ AWS::OpsWorks::Layer.LoadBasedAutoScaling http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-loadbasedautoscaling
Type: Token
orLoadBasedAutoScalingProperty
or None
-
layerName
¶ AWS::OpsWorks::Layer.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-name
Type: string or Token
-
packages
¶ AWS::OpsWorks::Layer.Packages http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-packages
Type: Token
or string orToken
or None
-
shortname
¶ AWS::OpsWorks::Layer.Shortname http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-shortname
Type: string or Token
-
stackId
¶ AWS::OpsWorks::Layer.StackId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-stackid
Type: string or Token
AWS::OpsWorks::Layer.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-tags
Type: Token
orToken
orTag
or None
-
type
¶ AWS::OpsWorks::Layer.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-type
Type: string or Token
-
useEbsOptimizedInstances
¶ AWS::OpsWorks::Layer.UseEbsOptimizedInstances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-useebsoptimizedinstances
Type: boolean or Token
or None
-
volumeConfigurations
¶ AWS::OpsWorks::Layer.VolumeConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-volumeconfigurations
Type: Token
orToken
orVolumeConfigurationProperty
or None
-
StackResource¶
-
class
_aws-cdk_resources.opsworks.
StackResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StackResource is a part of - name (string) –
- props (
StackResourceProps
or None) – the properties of this StackResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ChefConfigurationProperty
¶ -
berkshelfVersion
¶ StackResource.ChefConfigurationProperty.BerkshelfVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion
Type: string or Token
or None
-
manageBerkshelf
¶ StackResource.ChefConfigurationProperty.ManageBerkshelf http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-chefconfiguration-berkshelfversion
Type: boolean or Token
or None
-
-
class
ElasticIpProperty
¶ -
ip
¶ StackResource.ElasticIpProperty.Ip http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-ip
Type: string or Token
-
name
¶ StackResource.ElasticIpProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-name
Type: string or Token
or None
-
-
class
RdsDbInstanceProperty
¶ -
dbPassword
¶ StackResource.RdsDbInstanceProperty.DbPassword http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword
Type: string or Token
-
dbUser
¶ StackResource.RdsDbInstanceProperty.DbUser http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbuser
Type: string or Token
-
rdsDbInstanceArn
¶ StackResource.RdsDbInstanceProperty.RdsDbInstanceArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-rdsdbinstancearn
Type: string or Token
-
-
class
SourceProperty
¶ -
password
¶ StackResource.SourceProperty.Password http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-password
Type: string or Token
or None
-
revision
¶ StackResource.SourceProperty.Revision http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision
Type: string or Token
or None
-
sshKey
¶ StackResource.SourceProperty.SshKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey
Type: string or Token
or None
-
type
¶ StackResource.SourceProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type
Type: string or Token
or None
-
url
¶ StackResource.SourceProperty.Url http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url
Type: string or Token
or None
-
username
¶ StackResource.SourceProperty.Username http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username
Type: string or Token
or None
-
-
class
StackConfigurationManagerProperty
¶ -
name
¶ StackResource.StackConfigurationManagerProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-name
Type: string or Token
or None
-
version
¶ StackResource.StackConfigurationManagerProperty.Version http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigmanager.html#cfn-opsworks-configmanager-version
Type: string or Token
or None
-
- parent (
StackResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
StackResourceProps
¶ -
agentVersion
¶ AWS::OpsWorks::Stack.AgentVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-agentversion
Type: string or Token
or None
-
attributes
¶ AWS::OpsWorks::Stack.Attributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-attributes
Type: Token
or string orToken
or None
-
chefConfiguration
¶ AWS::OpsWorks::Stack.ChefConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-chefconfiguration
Type: Token
orChefConfigurationProperty
or None
-
cloneAppIds
¶ AWS::OpsWorks::Stack.CloneAppIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids
Type: Token
or string orToken
or None
-
clonePermissions
¶ AWS::OpsWorks::Stack.ClonePermissions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions
Type: boolean or Token
or None
-
configurationManager
¶ AWS::OpsWorks::Stack.ConfigurationManager http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-configmanager
Type: Token
orStackConfigurationManagerProperty
or None
-
customCookbooksSource
¶ AWS::OpsWorks::Stack.CustomCookbooksSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custcookbooksource
Type: Token
orSourceProperty
or None
-
customJson
¶ AWS::OpsWorks::Stack.CustomJson http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custjson
Type: json or Token
or None
-
defaultAvailabilityZone
¶ AWS::OpsWorks::Stack.DefaultAvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultaz
Type: string or Token
or None
-
defaultInstanceProfileArn
¶ AWS::OpsWorks::Stack.DefaultInstanceProfileArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultinstanceprof
Type: string or Token
-
defaultOs
¶ AWS::OpsWorks::Stack.DefaultOs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos
Type: string or Token
or None
-
defaultRootDeviceType
¶ AWS::OpsWorks::Stack.DefaultRootDeviceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultrootdevicetype
Type: string or Token
or None
-
defaultSshKeyName
¶ AWS::OpsWorks::Stack.DefaultSshKeyName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname
Type: string or Token
or None
-
defaultSubnetId
¶ AWS::OpsWorks::Stack.DefaultSubnetId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#defaultsubnet
Type: string or Token
or None
-
ecsClusterArn
¶ AWS::OpsWorks::Stack.EcsClusterArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn
Type: string or Token
or None
-
elasticIps
¶ AWS::OpsWorks::Stack.ElasticIps http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips
Type: Token
orToken
orElasticIpProperty
or None
-
hostnameTheme
¶ AWS::OpsWorks::Stack.HostnameTheme http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-hostnametheme
Type: string or Token
or None
-
stackName
¶ AWS::OpsWorks::Stack.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-name
Type: string or Token
-
rdsDbInstances
¶ AWS::OpsWorks::Stack.RdsDbInstances http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances
Type: Token
orToken
orRdsDbInstanceProperty
or None
-
serviceRoleArn
¶ AWS::OpsWorks::Stack.ServiceRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-servicerolearn
Type: string or Token
-
sourceStackId
¶ AWS::OpsWorks::Stack.SourceStackId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid
Type: string or Token
or None
AWS::OpsWorks::Stack.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-tags
Type: Token
orToken
orTag
or None
-
useCustomCookbooks
¶ AWS::OpsWorks::Stack.UseCustomCookbooks http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#usecustcookbooks
Type: boolean or Token
or None
-
useOpsworksSecurityGroups
¶ AWS::OpsWorks::Stack.UseOpsworksSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-useopsworkssecuritygroups
Type: boolean or Token
or None
-
vpcId
¶ AWS::OpsWorks::Stack.VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid
Type: string or Token
or None
-
UserProfileResource¶
-
class
_aws-cdk_resources.opsworks.
UserProfileResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this UserProfileResource is a part of - name (string) –
- props (
UserProfileResourceProps
or None) – the properties of this UserProfileResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
userProfileSshUsername
¶ Type: UserProfileSshUsername
(readonly)
- parent (
UserProfileResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
UserProfileResourceProps
¶ -
allowSelfManagement
¶ AWS::OpsWorks::UserProfile.AllowSelfManagement http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-allowselfmanagement
Type: boolean or Token
or None
-
iamUserArn
¶ AWS::OpsWorks::UserProfile.IamUserArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-iamuserarn
Type: string or Token
-
sshPublicKey
¶ AWS::OpsWorks::UserProfile.SshPublicKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshpublickey
Type: string or Token
or None
-
sshUsername
¶ AWS::OpsWorks::UserProfile.SshUsername http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshusername
Type: string or Token
or None
-
UserProfileSshUsername¶
VolumeResource¶
-
class
_aws-cdk_resources.opsworks.
VolumeResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this VolumeResource is a part of - name (string) –
- props (
VolumeResourceProps
or None) – the properties of this VolumeResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
VolumeResourceProps (interface)¶
-
class
_aws-cdk_resources.opsworks.
VolumeResourceProps
¶ -
ec2VolumeId
¶ AWS::OpsWorks::Volume.Ec2VolumeId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-ec2volumeid
Type: string or Token
-
mountPoint
¶ AWS::OpsWorks::Volume.MountPoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-mountpoint
Type: string or Token
or None
-
volumeName
¶ AWS::OpsWorks::Volume.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-name
Type: string or Token
or None
-
stackId
¶ AWS::OpsWorks::Volume.StackId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-stackid
Type: string or Token
-
rds¶
DBClusterEndpointAddress¶
DBClusterEndpointPort¶
DBClusterParameterGroupResource¶
-
class
_aws-cdk_resources.rds.
DBClusterParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBClusterParameterGroupResource is a part of - name (string) –
- props (
DBClusterParameterGroupResourceProps
or None) – the properties of this DBClusterParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBClusterParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBClusterParameterGroupResourceProps
¶ -
description
¶ AWS::RDS::DBClusterParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description
Type: string or Token
-
family
¶ AWS::RDS::DBClusterParameterGroup.Family http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family
Type: string or Token
-
parameters
¶ AWS::RDS::DBClusterParameterGroup.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters
Type: json or Token
AWS::RDS::DBClusterParameterGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags
Type: Token
orToken
orTag
or None
-
DBClusterReadEndpointAddress¶
DBClusterResource¶
-
class
_aws-cdk_resources.rds.
DBClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBClusterResource is a part of - name (string) –
- props (
DBClusterResourceProps
or None) – the properties of this DBClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
dbClusterEndpointAddress
¶ Type: DBClusterEndpointAddress
(readonly)
-
dbClusterEndpointPort
¶ Type: DBClusterEndpointPort
(readonly)
-
dbClusterReadEndpointAddress
¶ Type: DBClusterReadEndpointAddress
(readonly)
- parent (
DBClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBClusterResourceProps
¶ -
availabilityZones
¶ AWS::RDS::DBCluster.AvailabilityZones http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones
Type: Token
or string orToken
or None
-
backupRetentionPeriod
¶ AWS::RDS::DBCluster.BackupRetentionPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backuprententionperiod
Type: number or Token
or None
-
dbClusterIdentifier
¶ AWS::RDS::DBCluster.DBClusterIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier
Type: string or Token
or None
-
dbClusterParameterGroupName
¶ AWS::RDS::DBCluster.DBClusterParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname
Type: string or Token
or None
-
dbSubnetGroupName
¶ AWS::RDS::DBCluster.DBSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname
Type: string or Token
or None
-
databaseName
¶ AWS::RDS::DBCluster.DatabaseName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename
Type: string or Token
or None
-
engine
¶ AWS::RDS::DBCluster.Engine http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine
Type: string or Token
-
engineVersion
¶ AWS::RDS::DBCluster.EngineVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion
Type: string or Token
or None
-
kmsKeyId
¶ AWS::RDS::DBCluster.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid
Type: string or Token
or None
-
masterUserPassword
¶ AWS::RDS::DBCluster.MasterUserPassword http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword
Type: string or Token
or None
-
masterUsername
¶ AWS::RDS::DBCluster.MasterUsername http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername
Type: string or Token
or None
-
port
¶ AWS::RDS::DBCluster.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port
Type: number or Token
or None
-
preferredBackupWindow
¶ AWS::RDS::DBCluster.PreferredBackupWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow
Type: string or Token
or None
-
preferredMaintenanceWindow
¶ AWS::RDS::DBCluster.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow
Type: string or Token
or None
-
replicationSourceIdentifier
¶ AWS::RDS::DBCluster.ReplicationSourceIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier
Type: string or Token
or None
-
snapshotIdentifier
¶ AWS::RDS::DBCluster.SnapshotIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier
Type: string or Token
or None
-
storageEncrypted
¶ AWS::RDS::DBCluster.StorageEncrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted
Type: boolean or Token
or None
AWS::RDS::DBCluster.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags
Type: Token
orToken
orTag
or None
-
vpcSecurityGroupIds
¶ AWS::RDS::DBCluster.VpcSecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids
Type: Token
or string orToken
or None
-
DBInstanceEndpointAddress¶
DBInstanceEndpointPort¶
DBInstanceResource¶
-
class
_aws-cdk_resources.rds.
DBInstanceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBInstanceResource is a part of - name (string) –
- props (
DBInstanceResourceProps
or None) – the properties of this DBInstanceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
dbInstanceEndpointAddress
¶ Type: DBInstanceEndpointAddress
(readonly)
-
dbInstanceEndpointPort
¶ Type: DBInstanceEndpointPort
(readonly)
- parent (
DBInstanceResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBInstanceResourceProps
¶ -
allocatedStorage
¶ AWS::RDS::DBInstance.AllocatedStorage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allocatedstorage
Type: string or Token
or None
-
allowMajorVersionUpgrade
¶ AWS::RDS::DBInstance.AllowMajorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allowmajorversionupgrade
Type: boolean or Token
or None
-
autoMinorVersionUpgrade
¶ AWS::RDS::DBInstance.AutoMinorVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-autominorversionupgrade
Type: boolean or Token
or None
-
availabilityZone
¶ AWS::RDS::DBInstance.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-availabilityzone
Type: string or Token
or None
-
backupRetentionPeriod
¶ AWS::RDS::DBInstance.BackupRetentionPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-backupretentionperiod
Type: string or Token
or None
-
characterSetName
¶ AWS::RDS::DBInstance.CharacterSetName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-charactersetname
Type: string or Token
or None
-
copyTagsToSnapshot
¶ AWS::RDS::DBInstance.CopyTagsToSnapshot http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-copytagstosnapshot
Type: boolean or Token
or None
-
dbClusterIdentifier
¶ AWS::RDS::DBInstance.DBClusterIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbclusteridentifier
Type: string or Token
or None
-
dbInstanceClass
¶ AWS::RDS::DBInstance.DBInstanceClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceclass
Type: string or Token
-
dbInstanceIdentifier
¶ AWS::RDS::DBInstance.DBInstanceIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceidentifier
Type: string or Token
or None
-
dbName
¶ AWS::RDS::DBInstance.DBName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname
Type: string or Token
or None
-
dbParameterGroupName
¶ AWS::RDS::DBInstance.DBParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbparametergroupname
Type: string or Token
or None
-
dbSecurityGroups
¶ AWS::RDS::DBInstance.DBSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups
Type: Token
or string orToken
or None
-
dbSnapshotIdentifier
¶ AWS::RDS::DBInstance.DBSnapshotIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier
Type: string or Token
or None
-
dbSubnetGroupName
¶ AWS::RDS::DBInstance.DBSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsubnetgroupname
Type: string or Token
or None
-
domain
¶ AWS::RDS::DBInstance.Domain http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domain
Type: string or Token
or None
-
domainIamRoleName
¶ AWS::RDS::DBInstance.DomainIAMRoleName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domainiamrolename
Type: string or Token
or None
-
engine
¶ AWS::RDS::DBInstance.Engine http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engine
Type: string or Token
or None
-
engineVersion
¶ AWS::RDS::DBInstance.EngineVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion
Type: string or Token
or None
-
iops
¶ AWS::RDS::DBInstance.Iops http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-iops
Type: number or Token
or None
-
kmsKeyId
¶ AWS::RDS::DBInstance.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-kmskeyid
Type: string or Token
or None
-
licenseModel
¶ AWS::RDS::DBInstance.LicenseModel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-licensemodel
Type: string or Token
or None
-
masterUserPassword
¶ AWS::RDS::DBInstance.MasterUserPassword http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masteruserpassword
Type: string or Token
or None
-
masterUsername
¶ AWS::RDS::DBInstance.MasterUsername http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masterusername
Type: string or Token
or None
-
monitoringInterval
¶ AWS::RDS::DBInstance.MonitoringInterval http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringinterval
Type: number or Token
or None
-
monitoringRoleArn
¶ AWS::RDS::DBInstance.MonitoringRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringrolearn
Type: string or Token
or None
-
multiAz
¶ AWS::RDS::DBInstance.MultiAZ http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-multiaz
Type: boolean or Token
or None
-
optionGroupName
¶ AWS::RDS::DBInstance.OptionGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-optiongroupname
Type: string or Token
or None
-
port
¶ AWS::RDS::DBInstance.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port
Type: string or Token
or None
-
preferredBackupWindow
¶ AWS::RDS::DBInstance.PreferredBackupWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredbackupwindow
Type: string or Token
or None
-
preferredMaintenanceWindow
¶ AWS::RDS::DBInstance.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredmaintenancewindow
Type: string or Token
or None
-
publiclyAccessible
¶ AWS::RDS::DBInstance.PubliclyAccessible http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-publiclyaccessible
Type: boolean or Token
or None
-
sourceDbInstanceIdentifier
¶ AWS::RDS::DBInstance.SourceDBInstanceIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier
Type: string or Token
or None
-
sourceRegion
¶ AWS::RDS::DBInstance.SourceRegion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourceregion
Type: string or Token
or None
-
storageEncrypted
¶ AWS::RDS::DBInstance.StorageEncrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storageencrypted
Type: boolean or Token
or None
-
storageType
¶ AWS::RDS::DBInstance.StorageType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storagetype
Type: string or Token
or None
AWS::RDS::DBInstance.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-tags
Type: Token
orToken
orTag
or None
-
timezone
¶ AWS::RDS::DBInstance.Timezone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-timezone
Type: string or Token
or None
-
vpcSecurityGroups
¶ AWS::RDS::DBInstance.VPCSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups
Type: Token
or string orToken
or None
-
DBParameterGroupResource¶
-
class
_aws-cdk_resources.rds.
DBParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBParameterGroupResource is a part of - name (string) –
- props (
DBParameterGroupResourceProps
or None) – the properties of this DBParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBParameterGroupResourceProps
¶ -
description
¶ AWS::RDS::DBParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description
Type: string or Token
-
family
¶ AWS::RDS::DBParameterGroup.Family http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family
Type: string or Token
-
parameters
¶ AWS::RDS::DBParameterGroup.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters
Type: Token
or string orToken
or None
AWS::RDS::DBParameterGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags
Type: Token
orToken
orTag
or None
-
DBSecurityGroupIngressResource¶
-
class
_aws-cdk_resources.rds.
DBSecurityGroupIngressResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBSecurityGroupIngressResource is a part of - name (string) –
- props (
DBSecurityGroupIngressResourceProps
or None) – the properties of this DBSecurityGroupIngressResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBSecurityGroupIngressResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBSecurityGroupIngressResourceProps
¶ -
cidrip
¶ AWS::RDS::DBSecurityGroupIngress.CIDRIP http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-cidrip
Type: string or Token
or None
-
dbSecurityGroupName
¶ AWS::RDS::DBSecurityGroupIngress.DBSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname
Type: string or Token
-
ec2SecurityGroupId
¶ AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid
Type: string or Token
or None
-
ec2SecurityGroupName
¶ AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname
Type: string or Token
or None
-
ec2SecurityGroupOwnerId
¶ AWS::RDS::DBSecurityGroupIngress.EC2SecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid
Type: string or Token
or None
-
DBSecurityGroupResource¶
-
class
_aws-cdk_resources.rds.
DBSecurityGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBSecurityGroupResource is a part of - name (string) –
- props (
DBSecurityGroupResourceProps
or None) – the properties of this DBSecurityGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
IngressProperty
¶ -
cidrip
¶ DBSecurityGroupResource.IngressProperty.CIDRIP http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-cidrip
Type: string or Token
or None
-
ec2SecurityGroupId
¶ DBSecurityGroupResource.IngressProperty.EC2SecurityGroupId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupid
Type: string or Token
or None
-
ec2SecurityGroupName
¶ DBSecurityGroupResource.IngressProperty.EC2SecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupname
Type: string or Token
or None
-
ec2SecurityGroupOwnerId
¶ DBSecurityGroupResource.IngressProperty.EC2SecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupownerid
Type: string or Token
or None
-
- parent (
DBSecurityGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBSecurityGroupResourceProps
¶ -
dbSecurityGroupIngress
¶ AWS::RDS::DBSecurityGroup.DBSecurityGroupIngress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-dbsecuritygroupingress
Type: Token
orToken
orIngressProperty
-
ec2VpcId
¶ AWS::RDS::DBSecurityGroup.EC2VpcId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-ec2vpcid
Type: string or Token
or None
-
groupDescription
¶ AWS::RDS::DBSecurityGroup.GroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription
Type: string or Token
AWS::RDS::DBSecurityGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-tags
Type: Token
orToken
orTag
or None
-
DBSubnetGroupResource¶
-
class
_aws-cdk_resources.rds.
DBSubnetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DBSubnetGroupResource is a part of - name (string) –
- props (
DBSubnetGroupResourceProps
or None) – the properties of this DBSubnetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DBSubnetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
DBSubnetGroupResourceProps
¶ -
dbSubnetGroupDescription
¶ AWS::RDS::DBSubnetGroup.DBSubnetGroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription
Type: string or Token
-
dbSubnetGroupName
¶ AWS::RDS::DBSubnetGroup.DBSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname
Type: string or Token
or None
-
subnetIds
¶ AWS::RDS::DBSubnetGroup.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-subnetids
Type: Token
or string orToken
AWS::RDS::DBSubnetGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnet-group.html#cfn-rds-dbsubnetgroup-tags
Type: Token
orToken
orTag
or None
-
EventSubscriptionResource¶
-
class
_aws-cdk_resources.rds.
EventSubscriptionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this EventSubscriptionResource is a part of - name (string) –
- props (
EventSubscriptionResourceProps
or None) – the properties of this EventSubscriptionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
EventSubscriptionResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
EventSubscriptionResourceProps
¶ -
enabled
¶ AWS::RDS::EventSubscription.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled
Type: boolean or Token
or None
-
eventCategories
¶ AWS::RDS::EventSubscription.EventCategories http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories
Type: Token
or string orToken
or None
-
snsTopicArn
¶ AWS::RDS::EventSubscription.SnsTopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn
Type: string or Token
-
sourceIds
¶ AWS::RDS::EventSubscription.SourceIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids
Type: Token
or string orToken
or None
-
sourceType
¶ AWS::RDS::EventSubscription.SourceType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype
Type: string or Token
or None
-
OptionGroupResource¶
-
class
_aws-cdk_resources.rds.
OptionGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this OptionGroupResource is a part of - name (string) –
- props (
OptionGroupResourceProps
or None) – the properties of this OptionGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
OptionConfigurationProperty
¶ -
dbSecurityGroupMemberships
¶ OptionGroupResource.OptionConfigurationProperty.DBSecurityGroupMemberships http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-dbsecuritygroupmemberships
Type: Token
or string orToken
or None
-
optionName
¶ OptionGroupResource.OptionConfigurationProperty.OptionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-optionname
Type: string or Token
-
optionSettings
¶ OptionGroupResource.OptionConfigurationProperty.OptionSettings http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-optionsettings
Type: Token
orOptionSettingProperty
or None
-
optionVersion
¶ OptionGroupResource.OptionConfigurationProperty.OptionVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfiguration-optionversion
Type: string or Token
or None
-
port
¶ OptionGroupResource.OptionConfigurationProperty.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-port
Type: number or Token
or None
-
vpcSecurityGroupMemberships
¶ OptionGroupResource.OptionConfigurationProperty.VpcSecurityGroupMemberships http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html#cfn-rds-optiongroup-optionconfigurations-vpcsecuritygroupmemberships
Type: Token
or string orToken
or None
-
-
class
OptionSettingProperty
¶ -
name
¶ OptionGroupResource.OptionSettingProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html#cfn-rds-optiongroup-optionconfigurations-optionsettings-name
Type: string or Token
or None
-
value
¶ OptionGroupResource.OptionSettingProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html#cfn-rds-optiongroup-optionconfigurations-optionsettings-value
Type: string or Token
or None
-
- parent (
OptionGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.rds.
OptionGroupResourceProps
¶ -
engineName
¶ AWS::RDS::OptionGroup.EngineName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename
Type: string or Token
-
majorEngineVersion
¶ AWS::RDS::OptionGroup.MajorEngineVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion
Type: string or Token
-
optionConfigurations
¶ AWS::RDS::OptionGroup.OptionConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations
Type: Token
orToken
orOptionConfigurationProperty
-
optionGroupDescription
¶ AWS::RDS::OptionGroup.OptionGroupDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription
Type: string or Token
AWS::RDS::OptionGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags
Type: Token
orToken
orTag
or None
-
redshift¶
ClusterEndpointAddress¶
ClusterEndpointPort¶
ClusterParameterGroupResource¶
-
class
_aws-cdk_resources.redshift.
ClusterParameterGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterParameterGroupResource is a part of - name (string) –
- props (
ClusterParameterGroupResourceProps
or None) – the properties of this ClusterParameterGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ParameterProperty
¶ -
parameterName
¶ ClusterParameterGroupResource.ParameterProperty.ParameterName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametername
Type: string or Token
-
parameterValue
¶ ClusterParameterGroupResource.ParameterProperty.ParameterValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html#cfn-redshift-clusterparametergroup-parameter-parametervalue
Type: string or Token
-
- parent (
ClusterParameterGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.redshift.
ClusterParameterGroupResourceProps
¶ -
description
¶ AWS::Redshift::ClusterParameterGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-description
Type: string or Token
-
parameterGroupFamily
¶ AWS::Redshift::ClusterParameterGroup.ParameterGroupFamily http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupfamily
Type: string or Token
-
parameters
¶ AWS::Redshift::ClusterParameterGroup.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parameters
Type: Token
orToken
orParameterProperty
or None
AWS::Redshift::ClusterParameterGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-tags
Type: Token
orToken
orTag
or None
-
ClusterResource¶
-
class
_aws-cdk_resources.redshift.
ClusterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterResource is a part of - name (string) –
- props (
ClusterResourceProps
or None) – the properties of this ClusterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
clusterEndpointAddress
¶ Type: ClusterEndpointAddress
(readonly)
-
clusterEndpointPort
¶ Type: ClusterEndpointPort
(readonly)
-
class
LoggingPropertiesProperty
¶ -
bucketName
¶ ClusterResource.LoggingPropertiesProperty.BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname
Type: string or Token
-
s3KeyPrefix
¶ ClusterResource.LoggingPropertiesProperty.S3KeyPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix
Type: string or Token
or None
-
- parent (
ClusterResourceProps (interface)¶
-
class
_aws-cdk_resources.redshift.
ClusterResourceProps
¶ -
allowVersionUpgrade
¶ AWS::Redshift::Cluster.AllowVersionUpgrade http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-allowversionupgrade
Type: boolean or Token
or None
-
automatedSnapshotRetentionPeriod
¶ AWS::Redshift::Cluster.AutomatedSnapshotRetentionPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-automatedsnapshotretentionperiod
Type: number or Token
or None
-
availabilityZone
¶ AWS::Redshift::Cluster.AvailabilityZone http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-availabilityzone
Type: string or Token
or None
-
clusterIdentifier
¶ AWS::Redshift::Cluster.ClusterIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusteridentifier
Type: string or Token
or None
-
clusterParameterGroupName
¶ AWS::Redshift::Cluster.ClusterParameterGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterparametergroupname
Type: string or Token
or None
-
clusterSecurityGroups
¶ AWS::Redshift::Cluster.ClusterSecurityGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersecuritygroups
Type: Token
or string orToken
or None
-
clusterSubnetGroupName
¶ AWS::Redshift::Cluster.ClusterSubnetGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustersubnetgroupname
Type: string or Token
or None
-
clusterType
¶ AWS::Redshift::Cluster.ClusterType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clustertype
Type: string or Token
-
clusterVersion
¶ AWS::Redshift::Cluster.ClusterVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-clusterversion
Type: string or Token
or None
-
dbName
¶ AWS::Redshift::Cluster.DBName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-dbname
Type: string or Token
-
elasticIp
¶ AWS::Redshift::Cluster.ElasticIp http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-elasticip
Type: string or Token
or None
-
encrypted
¶ AWS::Redshift::Cluster.Encrypted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted
Type: boolean or Token
or None
-
hsmClientCertificateIdentifier
¶ AWS::Redshift::Cluster.HsmClientCertificateIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-hsmclientcertidentifier
Type: string or Token
or None
-
hsmConfigurationIdentifier
¶ AWS::Redshift::Cluster.HsmConfigurationIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-HsmConfigurationIdentifier
Type: string or Token
or None
-
iamRoles
¶ AWS::Redshift::Cluster.IamRoles http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-iamroles
Type: Token
or string orToken
or None
-
kmsKeyId
¶ AWS::Redshift::Cluster.KmsKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-kmskeyid
Type: string or Token
or None
-
loggingProperties
¶ AWS::Redshift::Cluster.LoggingProperties http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-loggingproperties
Type: Token
orLoggingPropertiesProperty
or None
-
masterUserPassword
¶ AWS::Redshift::Cluster.MasterUserPassword http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masteruserpassword
Type: string or Token
-
masterUsername
¶ AWS::Redshift::Cluster.MasterUsername http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-masterusername
Type: string or Token
-
nodeType
¶ AWS::Redshift::Cluster.NodeType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype
Type: string or Token
-
numberOfNodes
¶ AWS::Redshift::Cluster.NumberOfNodes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-nodetype
Type: number or Token
or None
-
ownerAccount
¶ AWS::Redshift::Cluster.OwnerAccount http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-owneraccount
Type: string or Token
or None
-
port
¶ AWS::Redshift::Cluster.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-port
Type: number or Token
or None
-
preferredMaintenanceWindow
¶ AWS::Redshift::Cluster.PreferredMaintenanceWindow http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-preferredmaintenancewindow
Type: string or Token
or None
-
publiclyAccessible
¶ AWS::Redshift::Cluster.PubliclyAccessible http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible
Type: boolean or Token
or None
-
snapshotClusterIdentifier
¶ AWS::Redshift::Cluster.SnapshotClusterIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotclusteridentifier
Type: string or Token
or None
-
snapshotIdentifier
¶ AWS::Redshift::Cluster.SnapshotIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-snapshotidentifier
Type: string or Token
or None
AWS::Redshift::Cluster.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-tags
Type: Token
orToken
orTag
or None
-
vpcSecurityGroupIds
¶ AWS::Redshift::Cluster.VpcSecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-vpcsecuritygroupids
Type: Token
or string orToken
or None
-
ClusterSecurityGroupIngressResource¶
-
class
_aws-cdk_resources.redshift.
ClusterSecurityGroupIngressResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterSecurityGroupIngressResource is a part of - name (string) –
- props (
ClusterSecurityGroupIngressResourceProps
or None) – the properties of this ClusterSecurityGroupIngressResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ClusterSecurityGroupIngressResourceProps (interface)¶
-
class
_aws-cdk_resources.redshift.
ClusterSecurityGroupIngressResourceProps
¶ -
cidrip
¶ AWS::Redshift::ClusterSecurityGroupIngress.CIDRIP http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-cidrip
Type: string or Token
or None
-
clusterSecurityGroupName
¶ AWS::Redshift::ClusterSecurityGroupIngress.ClusterSecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-clustersecuritygroupname
Type: string or Token
-
ec2SecurityGroupName
¶ AWS::Redshift::ClusterSecurityGroupIngress.EC2SecurityGroupName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-ec2securitygroupname
Type: string or Token
or None
-
ec2SecurityGroupOwnerId
¶ AWS::Redshift::ClusterSecurityGroupIngress.EC2SecurityGroupOwnerId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroupingress.html#cfn-redshift-clustersecuritygroupingress-ec2securitygroupownerid
Type: string or Token
or None
-
ClusterSecurityGroupResource¶
-
class
_aws-cdk_resources.redshift.
ClusterSecurityGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterSecurityGroupResource is a part of - name (string) –
- props (
ClusterSecurityGroupResourceProps
or None) – the properties of this ClusterSecurityGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ClusterSecurityGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.redshift.
ClusterSecurityGroupResourceProps
¶ -
description
¶ AWS::Redshift::ClusterSecurityGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-description
Type: string or Token
AWS::Redshift::ClusterSecurityGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersecuritygroup.html#cfn-redshift-clustersecuritygroup-tags
Type: Token
orToken
orTag
or None
-
ClusterSubnetGroupResource¶
-
class
_aws-cdk_resources.redshift.
ClusterSubnetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ClusterSubnetGroupResource is a part of - name (string) –
- props (
ClusterSubnetGroupResourceProps
or None) – the properties of this ClusterSubnetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ClusterSubnetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.redshift.
ClusterSubnetGroupResourceProps
¶ -
description
¶ AWS::Redshift::ClusterSubnetGroup.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-description
Type: string or Token
-
subnetIds
¶ AWS::Redshift::ClusterSubnetGroup.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-subnetids
Type: Token
or string orToken
AWS::Redshift::ClusterSubnetGroup.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clustersubnetgroup.html#cfn-redshift-clustersubnetgroup-tags
Type: Token
orToken
orTag
or None
-
route53¶
HealthCheckResource¶
-
class
_aws-cdk_resources.route53.
HealthCheckResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this HealthCheckResource is a part of - name (string) –
- props (
HealthCheckResourceProps
or None) – the properties of this HealthCheckResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AlarmIdentifierProperty
¶ -
name
¶ HealthCheckResource.AlarmIdentifierProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-name
Type: string or Token
-
region
¶ HealthCheckResource.AlarmIdentifierProperty.Region http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html#cfn-route53-healthcheck-alarmidentifier-region
Type: string or Token
-
-
class
HealthCheckConfigProperty
¶ -
alarmIdentifier
¶ HealthCheckResource.HealthCheckConfigProperty.AlarmIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-alarmidentifier
Type: Token
orAlarmIdentifierProperty
or None
-
childHealthChecks
¶ HealthCheckResource.HealthCheckConfigProperty.ChildHealthChecks http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-childhealthchecks
Type: Token
or string orToken
or None
-
enableSni
¶ HealthCheckResource.HealthCheckConfigProperty.EnableSNI http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-enablesni
Type: boolean or Token
or None
-
failureThreshold
¶ HealthCheckResource.HealthCheckConfigProperty.FailureThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-failurethreshold
Type: number or Token
or None
-
fullyQualifiedDomainName
¶ HealthCheckResource.HealthCheckConfigProperty.FullyQualifiedDomainName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-fullyqualifieddomainname
Type: string or Token
or None
-
healthThreshold
¶ HealthCheckResource.HealthCheckConfigProperty.HealthThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-healththreshold
Type: number or Token
or None
-
ipAddress
¶ HealthCheckResource.HealthCheckConfigProperty.IPAddress http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-ipaddress
Type: string or Token
or None
-
insufficientDataHealthStatus
¶ HealthCheckResource.HealthCheckConfigProperty.InsufficientDataHealthStatus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-insufficientdatahealthstatus
Type: string or Token
or None
-
inverted
¶ HealthCheckResource.HealthCheckConfigProperty.Inverted http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-inverted
Type: boolean or Token
or None
-
measureLatency
¶ HealthCheckResource.HealthCheckConfigProperty.MeasureLatency http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-measurelatency
Type: boolean or Token
or None
-
port
¶ HealthCheckResource.HealthCheckConfigProperty.Port http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-port
Type: number or Token
or None
-
regions
¶ HealthCheckResource.HealthCheckConfigProperty.Regions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-regions
Type: Token
or string orToken
or None
-
requestInterval
¶ HealthCheckResource.HealthCheckConfigProperty.RequestInterval http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-requestinterval
Type: number or Token
or None
-
resourcePath
¶ HealthCheckResource.HealthCheckConfigProperty.ResourcePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-resourcepath
Type: string or Token
or None
-
searchString
¶ HealthCheckResource.HealthCheckConfigProperty.SearchString http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-searchstring
Type: string or Token
or None
-
type
¶ HealthCheckResource.HealthCheckConfigProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type
Type: string or Token
-
-
class
HealthCheckTagProperty
¶ -
key
¶ HealthCheckResource.HealthCheckTagProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthchecktags-key
Type: string or Token
-
value
¶ HealthCheckResource.HealthCheckTagProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html#cfn-route53-healthchecktags-value
Type: string or Token
-
- parent (
HealthCheckResourceProps (interface)¶
-
class
_aws-cdk_resources.route53.
HealthCheckResourceProps
¶ -
healthCheckConfig
¶ AWS::Route53::HealthCheck.HealthCheckConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthcheckconfig
Type: Token
orHealthCheckConfigProperty
-
healthCheckTags
¶ AWS::Route53::HealthCheck.HealthCheckTags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-healthcheck.html#cfn-route53-healthcheck-healthchecktags
Type: Token
orToken
orHealthCheckTagProperty
or None
-
HostedZoneNameServers¶
HostedZoneResource¶
-
class
_aws-cdk_resources.route53.
HostedZoneResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this HostedZoneResource is a part of - name (string) –
- props (
HostedZoneResourceProps
or None) – the properties of this HostedZoneResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
hostedZoneNameServers
¶ Type: HostedZoneNameServers
(readonly)
-
class
HostedZoneConfigProperty
¶ -
comment
¶ HostedZoneResource.HostedZoneConfigProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzoneconfig.html#cfn-route53-hostedzone-hostedzoneconfig-comment
Type: string or Token
or None
-
-
class
HostedZoneTagProperty
¶ -
key
¶ HostedZoneResource.HostedZoneTagProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-key
Type: string or Token
-
value
¶ HostedZoneResource.HostedZoneTagProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-hostedzonetags.html#cfn-route53-hostedzonetags-value
Type: string or Token
-
-
class
QueryLoggingConfigProperty
¶ -
cloudWatchLogsLogGroupArn
¶ HostedZoneResource.QueryLoggingConfigProperty.CloudWatchLogsLogGroupArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-hostedzone-queryloggingconfig.html#cfn-route53-hostedzone-queryloggingconfig-cloudwatchlogsloggrouparn
Type: string or Token
-
-
class
VPCProperty
¶ -
vpcId
¶ HostedZoneResource.VPCProperty.VPCId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcid
Type: string or Token
-
vpcRegion
¶ HostedZoneResource.VPCProperty.VPCRegion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone-hostedzonevpcs.html#cfn-route53-hostedzone-hostedzonevpcs-vpcregion
Type: string or Token
-
- parent (
HostedZoneResourceProps (interface)¶
-
class
_aws-cdk_resources.route53.
HostedZoneResourceProps
¶ -
hostedZoneConfig
¶ AWS::Route53::HostedZone.HostedZoneConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzoneconfig
Type: Token
orHostedZoneConfigProperty
or None
-
hostedZoneTags
¶ AWS::Route53::HostedZone.HostedZoneTags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-hostedzonetags
Type: Token
orToken
orHostedZoneTagProperty
or None
-
hostedZoneName
¶ AWS::Route53::HostedZone.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-name
Type: string or Token
-
queryLoggingConfig
¶ AWS::Route53::HostedZone.QueryLoggingConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-queryloggingconfig
Type: Token
orQueryLoggingConfigProperty
or None
-
vpcs
¶ AWS::Route53::HostedZone.VPCs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-hostedzone.html#cfn-route53-hostedzone-vpcs
Type: Token
orToken
orVPCProperty
or None
-
RecordSetGroupResource¶
-
class
_aws-cdk_resources.route53.
RecordSetGroupResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RecordSetGroupResource is a part of - name (string) –
- props (
RecordSetGroupResourceProps
or None) – the properties of this RecordSetGroupResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AliasTargetProperty
¶ -
dnsName
¶ RecordSetGroupResource.AliasTargetProperty.DNSName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname
Type: string or Token
-
evaluateTargetHealth
¶ RecordSetGroupResource.AliasTargetProperty.EvaluateTargetHealth http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth
Type: boolean or Token
or None
-
hostedZoneId
¶ RecordSetGroupResource.AliasTargetProperty.HostedZoneId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid
Type: string or Token
-
-
class
GeoLocationProperty
¶ -
continentCode
¶ RecordSetGroupResource.GeoLocationProperty.ContinentCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordsetgroup-geolocation-continentcode
Type: string or Token
or None
-
countryCode
¶ RecordSetGroupResource.GeoLocationProperty.CountryCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode
Type: string or Token
or None
-
subdivisionCode
¶ RecordSetGroupResource.GeoLocationProperty.SubdivisionCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode
Type: string or Token
or None
-
-
class
RecordSetProperty
¶ -
aliasTarget
¶ RecordSetGroupResource.RecordSetProperty.AliasTarget http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget
Type: Token
orAliasTargetProperty
or None
-
comment
¶ RecordSetGroupResource.RecordSetProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment
Type: string or Token
or None
-
failover
¶ RecordSetGroupResource.RecordSetProperty.Failover http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover
Type: string or Token
or None
-
geoLocation
¶ RecordSetGroupResource.RecordSetProperty.GeoLocation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation
Type: Token
orGeoLocationProperty
or None
-
healthCheckId
¶ RecordSetGroupResource.RecordSetProperty.HealthCheckId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid
Type: string or Token
or None
-
hostedZoneId
¶ RecordSetGroupResource.RecordSetProperty.HostedZoneId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid
Type: string or Token
or None
-
hostedZoneName
¶ RecordSetGroupResource.RecordSetProperty.HostedZoneName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename
Type: string or Token
or None
-
name
¶ RecordSetGroupResource.RecordSetProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name
Type: string or Token
-
region
¶ RecordSetGroupResource.RecordSetProperty.Region http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region
Type: string or Token
or None
-
resourceRecords
¶ RecordSetGroupResource.RecordSetProperty.ResourceRecords http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords
Type: Token
or string orToken
or None
-
setIdentifier
¶ RecordSetGroupResource.RecordSetProperty.SetIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier
Type: string or Token
or None
-
ttl
¶ RecordSetGroupResource.RecordSetProperty.TTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl
Type: string or Token
or None
-
type
¶ RecordSetGroupResource.RecordSetProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type
Type: string or Token
-
weight
¶ RecordSetGroupResource.RecordSetProperty.Weight http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight
Type: number or Token
or None
-
- parent (
RecordSetGroupResourceProps (interface)¶
-
class
_aws-cdk_resources.route53.
RecordSetGroupResourceProps
¶ -
comment
¶ AWS::Route53::RecordSetGroup.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-comment
Type: string or Token
or None
-
hostedZoneId
¶ AWS::Route53::RecordSetGroup.HostedZoneId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzoneid
Type: string or Token
or None
-
hostedZoneName
¶ AWS::Route53::RecordSetGroup.HostedZoneName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-hostedzonename
Type: string or Token
or None
-
recordSets
¶ AWS::Route53::RecordSetGroup.RecordSets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53-recordsetgroup.html#cfn-route53-recordsetgroup-recordsets
Type: Token
orToken
orRecordSetProperty
or None
-
RecordSetResource¶
-
class
_aws-cdk_resources.route53.
RecordSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RecordSetResource is a part of - name (string) –
- props (
RecordSetResourceProps
or None) – the properties of this RecordSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AliasTargetProperty
¶ -
dnsName
¶ RecordSetResource.AliasTargetProperty.DNSName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-dnshostname
Type: string or Token
-
evaluateTargetHealth
¶ RecordSetResource.AliasTargetProperty.EvaluateTargetHealth http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth
Type: boolean or Token
or None
-
hostedZoneId
¶ RecordSetResource.AliasTargetProperty.HostedZoneId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-hostedzoneid
Type: string or Token
-
-
class
GeoLocationProperty
¶ -
continentCode
¶ RecordSetResource.GeoLocationProperty.ContinentCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-continentcode
Type: string or Token
or None
-
countryCode
¶ RecordSetResource.GeoLocationProperty.CountryCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-countrycode
Type: string or Token
or None
-
subdivisionCode
¶ RecordSetResource.GeoLocationProperty.SubdivisionCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html#cfn-route53-recordset-geolocation-subdivisioncode
Type: string or Token
or None
-
- parent (
RecordSetResourceProps (interface)¶
-
class
_aws-cdk_resources.route53.
RecordSetResourceProps
¶ -
aliasTarget
¶ AWS::Route53::RecordSet.AliasTarget http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-aliastarget
Type: Token
orAliasTargetProperty
or None
-
comment
¶ AWS::Route53::RecordSet.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-comment
Type: string or Token
or None
-
failover
¶ AWS::Route53::RecordSet.Failover http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-failover
Type: string or Token
or None
-
geoLocation
¶ AWS::Route53::RecordSet.GeoLocation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-geolocation
Type: Token
orGeoLocationProperty
or None
-
healthCheckId
¶ AWS::Route53::RecordSet.HealthCheckId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-healthcheckid
Type: string or Token
or None
-
hostedZoneId
¶ AWS::Route53::RecordSet.HostedZoneId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzoneid
Type: string or Token
or None
-
hostedZoneName
¶ AWS::Route53::RecordSet.HostedZoneName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-hostedzonename
Type: string or Token
or None
-
recordSetName
¶ AWS::Route53::RecordSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-name
Type: string or Token
-
region
¶ AWS::Route53::RecordSet.Region http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-region
Type: string or Token
or None
-
resourceRecords
¶ AWS::Route53::RecordSet.ResourceRecords http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-resourcerecords
Type: Token
or string orToken
or None
-
setIdentifier
¶ AWS::Route53::RecordSet.SetIdentifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-setidentifier
Type: string or Token
or None
-
ttl
¶ AWS::Route53::RecordSet.TTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-ttl
Type: string or Token
or None
-
type
¶ AWS::Route53::RecordSet.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type
Type: string or Token
-
weight
¶ AWS::Route53::RecordSet.Weight http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-weight
Type: number or Token
or None
-
s3¶
BucketArn¶
BucketDomainName¶
BucketDualStackDomainName¶
BucketPolicyResource¶
-
class
_aws-cdk_resources.s3.
BucketPolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this BucketPolicyResource is a part of - name (string) –
- props (
BucketPolicyResourceProps
or None) – the properties of this BucketPolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
BucketPolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.s3.
BucketPolicyResourceProps
¶ -
bucket
¶ AWS::S3::BucketPolicy.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-bucket
Type: string or Token
-
policyDocument
¶ AWS::S3::BucketPolicy.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html#aws-properties-s3-policy-policydocument
Type: json or Token
-
BucketResource¶
-
class
_aws-cdk_resources.s3.
BucketResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this BucketResource is a part of - name (string) –
- props (
BucketResourceProps
or None) – the properties of this BucketResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
bucketArn
¶ Type: BucketArn
(readonly)
-
bucketDomainName
¶ Type: BucketDomainName
(readonly)
-
bucketDualStackDomainName
¶ Type: BucketDualStackDomainName
(readonly)
-
bucketWebsiteUrl
¶ Type: BucketWebsiteUrl
(readonly)
-
class
AbortIncompleteMultipartUploadProperty
¶ -
daysAfterInitiation
¶ BucketResource.AbortIncompleteMultipartUploadProperty.DaysAfterInitiation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-abortincompletemultipartupload.html#cfn-s3-bucket-abortincompletemultipartupload-daysafterinitiation
Type: number or Token
-
-
class
AccelerateConfigurationProperty
¶ -
accelerationStatus
¶ BucketResource.AccelerateConfigurationProperty.AccelerationStatus http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accelerateconfiguration.html#cfn-s3-bucket-accelerateconfiguration-accelerationstatus
Type: string or Token
-
-
class
AccessControlTranslationProperty
¶ -
owner
¶ BucketResource.AccessControlTranslationProperty.Owner http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html#cfn-s3-bucket-accesscontroltranslation-owner
Type: string or Token
-
-
class
AnalyticsConfigurationProperty
¶ -
id
¶ BucketResource.AnalyticsConfigurationProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-id
Type: string or Token
-
prefix
¶ BucketResource.AnalyticsConfigurationProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-prefix
Type: string or Token
or None
-
storageClassAnalysis
¶ BucketResource.AnalyticsConfigurationProperty.StorageClassAnalysis http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-storageclassanalysis
Type: Token
orStorageClassAnalysisProperty
-
tagFilters
¶ BucketResource.AnalyticsConfigurationProperty.TagFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters
Type: Token
orToken
orTagFilterProperty
or None
-
-
class
BucketEncryptionProperty
¶ -
serverSideEncryptionConfiguration
¶ BucketResource.BucketEncryptionProperty.ServerSideEncryptionConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-bucketencryption.html#cfn-s3-bucket-bucketencryption-serversideencryptionconfiguration
Type: Token
orToken
orServerSideEncryptionRuleProperty
-
-
class
CorsConfigurationProperty
¶ -
corsRules
¶ BucketResource.CorsConfigurationProperty.CorsRules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors.html#cfn-s3-bucket-cors-corsrule
Type: Token
orToken
orCorsRuleProperty
-
-
class
CorsRuleProperty
¶ -
allowedHeaders
¶ BucketResource.CorsRuleProperty.AllowedHeaders http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedheaders
Type: Token
or string orToken
or None
-
allowedMethods
¶ BucketResource.CorsRuleProperty.AllowedMethods http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedmethods
Type: Token
or string orToken
-
allowedOrigins
¶ BucketResource.CorsRuleProperty.AllowedOrigins http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-allowedorigins
Type: Token
or string orToken
-
exposedHeaders
¶ BucketResource.CorsRuleProperty.ExposedHeaders http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-exposedheaders
Type: Token
or string orToken
or None
-
id
¶ BucketResource.CorsRuleProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-id
Type: string or Token
or None
-
maxAge
¶ BucketResource.CorsRuleProperty.MaxAge http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-cors-corsrule.html#cfn-s3-bucket-cors-corsrule-maxage
Type: number or Token
or None
-
-
class
DataExportProperty
¶ -
destination
¶ BucketResource.DataExportProperty.Destination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-destination
Type: Token
orDestinationProperty
-
outputSchemaVersion
¶ BucketResource.DataExportProperty.OutputSchemaVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-dataexport.html#cfn-s3-bucket-dataexport-outputschemaversion
Type: string or Token
-
-
class
DestinationProperty
¶ -
bucketAccountId
¶ BucketResource.DestinationProperty.BucketAccountId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid
Type: string or Token
or None
-
bucketArn
¶ BucketResource.DestinationProperty.BucketArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn
Type: string or Token
-
format
¶ BucketResource.DestinationProperty.Format http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format
Type: string or Token
-
prefix
¶ BucketResource.DestinationProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix
Type: string or Token
or None
-
-
class
EncryptionConfigurationProperty
¶ -
replicaKmsKeyId
¶ BucketResource.EncryptionConfigurationProperty.ReplicaKmsKeyID http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html#cfn-s3-bucket-encryptionconfiguration-replicakmskeyid
Type: string or Token
-
-
class
FilterRuleProperty
¶ -
name
¶ BucketResource.FilterRuleProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules-name
Type: string or Token
-
value
¶ BucketResource.FilterRuleProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key-rules.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules-value
Type: string or Token
-
-
class
InventoryConfigurationProperty
¶ -
destination
¶ BucketResource.InventoryConfigurationProperty.Destination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-destination
Type: Token
orDestinationProperty
-
enabled
¶ BucketResource.InventoryConfigurationProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-enabled
Type: boolean or Token
-
id
¶ BucketResource.InventoryConfigurationProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id
Type: string or Token
-
includedObjectVersions
¶ BucketResource.InventoryConfigurationProperty.IncludedObjectVersions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-includedobjectversions
Type: string or Token
-
optionalFields
¶ BucketResource.InventoryConfigurationProperty.OptionalFields http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields
Type: Token
or string orToken
or None
-
prefix
¶ BucketResource.InventoryConfigurationProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-prefix
Type: string or Token
or None
-
scheduleFrequency
¶ BucketResource.InventoryConfigurationProperty.ScheduleFrequency http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-schedulefrequency
Type: string or Token
-
-
class
LambdaConfigurationProperty
¶ -
event
¶ BucketResource.LambdaConfigurationProperty.Event http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event
Type: string or Token
-
filter
¶ BucketResource.LambdaConfigurationProperty.Filter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-filter
Type: Token
orNotificationFilterProperty
or None
-
function
¶ BucketResource.LambdaConfigurationProperty.Function http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-function
Type: string or Token
-
-
class
LifecycleConfigurationProperty
¶ -
rules
¶ BucketResource.LifecycleConfigurationProperty.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig.html#cfn-s3-bucket-lifecycleconfig-rules
Type: Token
orToken
orRuleProperty
-
-
class
LoggingConfigurationProperty
¶ -
destinationBucketName
¶ BucketResource.LoggingConfigurationProperty.DestinationBucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-destinationbucketname
Type: string or Token
or None
-
logFilePrefix
¶ BucketResource.LoggingConfigurationProperty.LogFilePrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-loggingconfig.html#cfn-s3-bucket-loggingconfig-logfileprefix
Type: string or Token
or None
-
-
class
MetricsConfigurationProperty
¶ -
id
¶ BucketResource.MetricsConfigurationProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-id
Type: string or Token
-
prefix
¶ BucketResource.MetricsConfigurationProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-prefix
Type: string or Token
or None
-
tagFilters
¶ BucketResource.MetricsConfigurationProperty.TagFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-tagfilters
Type: Token
orToken
orTagFilterProperty
or None
-
-
class
NoncurrentVersionTransitionProperty
¶ -
storageClass
¶ BucketResource.NoncurrentVersionTransitionProperty.StorageClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-storageclass
Type: string or Token
-
transitionInDays
¶ BucketResource.NoncurrentVersionTransitionProperty.TransitionInDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition-transitionindays
Type: number or Token
-
-
class
NotificationConfigurationProperty
¶ -
lambdaConfigurations
¶ BucketResource.NotificationConfigurationProperty.LambdaConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig
Type: Token
orToken
orLambdaConfigurationProperty
or None
-
queueConfigurations
¶ BucketResource.NotificationConfigurationProperty.QueueConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-queueconfig
Type: Token
orToken
orQueueConfigurationProperty
or None
-
topicConfigurations
¶ BucketResource.NotificationConfigurationProperty.TopicConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig.html#cfn-s3-bucket-notificationconfig-topicconfig
Type: Token
orToken
orTopicConfigurationProperty
or None
-
-
class
NotificationFilterProperty
¶ -
s3Key
¶ BucketResource.NotificationFilterProperty.S3Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key
Type: Token
orS3KeyFilterProperty
-
-
class
QueueConfigurationProperty
¶ -
event
¶ BucketResource.QueueConfigurationProperty.Event http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-event
Type: string or Token
-
filter
¶ BucketResource.QueueConfigurationProperty.Filter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-filter
Type: Token
orNotificationFilterProperty
or None
-
queue
¶ BucketResource.QueueConfigurationProperty.Queue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-queueconfig.html#cfn-s3-bucket-notificationconfig-queueconfig-queue
Type: string or Token
-
-
class
RedirectAllRequestsToProperty
¶ -
hostName
¶ BucketResource.RedirectAllRequestsToProperty.HostName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-hostname
Type: string or Token
-
protocol
¶ BucketResource.RedirectAllRequestsToProperty.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-redirectallrequeststo.html#cfn-s3-websiteconfiguration-redirectallrequeststo-protocol
Type: string or Token
or None
-
-
class
RedirectRuleProperty
¶ -
hostName
¶ BucketResource.RedirectRuleProperty.HostName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-hostname
Type: string or Token
or None
-
httpRedirectCode
¶ BucketResource.RedirectRuleProperty.HttpRedirectCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-httpredirectcode
Type: string or Token
or None
-
protocol
¶ BucketResource.RedirectRuleProperty.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-protocol
Type: string or Token
or None
-
replaceKeyPrefixWith
¶ BucketResource.RedirectRuleProperty.ReplaceKeyPrefixWith http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeyprefixwith
Type: string or Token
or None
-
replaceKeyWith
¶ BucketResource.RedirectRuleProperty.ReplaceKeyWith http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-redirectrule.html#cfn-s3-websiteconfiguration-redirectrule-replacekeywith
Type: string or Token
or None
-
-
class
ReplicationConfigurationProperty
¶ -
role
¶ BucketResource.ReplicationConfigurationProperty.Role http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-role
Type: string or Token
-
rules
¶ BucketResource.ReplicationConfigurationProperty.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration.html#cfn-s3-bucket-replicationconfiguration-rules
Type: Token
orToken
orReplicationRuleProperty
-
-
class
ReplicationDestinationProperty
¶ -
accessControlTranslation
¶ BucketResource.ReplicationDestinationProperty.AccessControlTranslation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-accesscontroltranslation
Type: Token
orAccessControlTranslationProperty
or None
-
account
¶ BucketResource.ReplicationDestinationProperty.Account http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-account
Type: string or Token
or None
-
bucket
¶ BucketResource.ReplicationDestinationProperty.Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-bucket
Type: string or Token
-
encryptionConfiguration
¶ BucketResource.ReplicationDestinationProperty.EncryptionConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationdestination-encryptionconfiguration
Type: Token
orEncryptionConfigurationProperty
or None
-
storageClass
¶ BucketResource.ReplicationDestinationProperty.StorageClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html#cfn-s3-bucket-replicationconfiguration-rules-destination-storageclass
Type: string or Token
or None
-
-
class
ReplicationRuleProperty
¶ -
destination
¶ BucketResource.ReplicationRuleProperty.Destination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-destination
Type: Token
orReplicationDestinationProperty
-
id
¶ BucketResource.ReplicationRuleProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-id
Type: string or Token
or None
-
prefix
¶ BucketResource.ReplicationRuleProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-prefix
Type: string or Token
-
sourceSelectionCriteria
¶ BucketResource.ReplicationRuleProperty.SourceSelectionCriteria http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationrule-sourceselectioncriteria
Type: Token
orSourceSelectionCriteriaProperty
or None
-
status
¶ BucketResource.ReplicationRuleProperty.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules.html#cfn-s3-bucket-replicationconfiguration-rules-status
Type: string or Token
-
-
class
RoutingRuleConditionProperty
¶ -
httpErrorCodeReturnedEquals
¶ BucketResource.RoutingRuleConditionProperty.HttpErrorCodeReturnedEquals http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-httperrorcodereturnedequals
Type: string or Token
or None
-
keyPrefixEquals
¶ BucketResource.RoutingRuleConditionProperty.KeyPrefixEquals http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules-routingrulecondition.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition-keyprefixequals
Type: string or Token
or None
-
-
class
RoutingRuleProperty
¶ -
redirectRule
¶ BucketResource.RoutingRuleProperty.RedirectRule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-redirectrule
Type: Token
orRedirectRuleProperty
-
routingRuleCondition
¶ BucketResource.RoutingRuleProperty.RoutingRuleCondition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html#cfn-s3-websiteconfiguration-routingrules-routingrulecondition
Type: Token
orRoutingRuleConditionProperty
or None
-
-
class
RuleProperty
¶ -
abortIncompleteMultipartUpload
¶ BucketResource.RuleProperty.AbortIncompleteMultipartUpload http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-abortincompletemultipartupload
Type: Token
orAbortIncompleteMultipartUploadProperty
or None
-
expirationDate
¶ BucketResource.RuleProperty.ExpirationDate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationdate
Type: Token
or date or None
-
expirationInDays
¶ BucketResource.RuleProperty.ExpirationInDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-expirationindays
Type: number or Token
or None
-
id
¶ BucketResource.RuleProperty.Id http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-id
Type: string or Token
or None
-
noncurrentVersionExpirationInDays
¶ BucketResource.RuleProperty.NoncurrentVersionExpirationInDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversionexpirationindays
Type: number or Token
or None
-
noncurrentVersionTransition
¶ BucketResource.RuleProperty.NoncurrentVersionTransition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition
Type: Token
orNoncurrentVersionTransitionProperty
or None
-
noncurrentVersionTransitions
¶ BucketResource.RuleProperty.NoncurrentVersionTransitions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-noncurrentversiontransitions
Type: Token
orToken
orNoncurrentVersionTransitionProperty
or None
-
prefix
¶ BucketResource.RuleProperty.Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-prefix
Type: string or Token
or None
-
status
¶ BucketResource.RuleProperty.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-status
Type: string or Token
-
tagFilters
¶ BucketResource.RuleProperty.TagFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-rule-tagfilters
Type: Token
orToken
orTagFilterProperty
or None
-
transition
¶ BucketResource.RuleProperty.Transition http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transition
Type: Token
orTransitionProperty
or None
-
transitions
¶ BucketResource.RuleProperty.Transitions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html#cfn-s3-bucket-lifecycleconfig-rule-transitions
Type: Token
orToken
orTransitionProperty
or None
-
-
class
S3KeyFilterProperty
¶ -
rules
¶ BucketResource.S3KeyFilterProperty.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter-s3key.html#cfn-s3-bucket-notificationconfiguraiton-config-filter-s3key-rules
Type: Token
orToken
orFilterRuleProperty
-
-
class
ServerSideEncryptionByDefaultProperty
¶ -
kmsMasterKeyId
¶ BucketResource.ServerSideEncryptionByDefaultProperty.KMSMasterKeyID http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid
Type: string or Token
or None
-
sseAlgorithm
¶ BucketResource.ServerSideEncryptionByDefaultProperty.SSEAlgorithm http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-ssealgorithm
Type: string or Token
-
-
class
ServerSideEncryptionRuleProperty
¶ -
serverSideEncryptionByDefault
¶ BucketResource.ServerSideEncryptionRuleProperty.ServerSideEncryptionByDefault http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html#cfn-s3-bucket-serversideencryptionrule-serversideencryptionbydefault
Type: Token
orServerSideEncryptionByDefaultProperty
or None
-
-
class
SourceSelectionCriteriaProperty
¶ -
sseKmsEncryptedObjects
¶ BucketResource.SourceSelectionCriteriaProperty.SseKmsEncryptedObjects http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html#cfn-s3-bucket-sourceselectioncriteria-ssekmsencryptedobjects
Type: Token
orSseKmsEncryptedObjectsProperty
-
-
class
SseKmsEncryptedObjectsProperty
¶ -
status
¶ BucketResource.SseKmsEncryptedObjectsProperty.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ssekmsencryptedobjects.html#cfn-s3-bucket-ssekmsencryptedobjects-status
Type: string or Token
-
-
class
StorageClassAnalysisProperty
¶ -
dataExport
¶ BucketResource.StorageClassAnalysisProperty.DataExport http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-storageclassanalysis.html#cfn-s3-bucket-storageclassanalysis-dataexport
Type: Token
orDataExportProperty
or None
-
-
class
TagFilterProperty
¶ -
key
¶ BucketResource.TagFilterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-key
Type: string or Token
-
value
¶ BucketResource.TagFilterProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html#cfn-s3-bucket-tagfilter-value
Type: string or Token
-
-
class
TopicConfigurationProperty
¶ -
event
¶ BucketResource.TopicConfigurationProperty.Event http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-event
Type: string or Token
-
filter
¶ BucketResource.TopicConfigurationProperty.Filter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-filter
Type: Token
orNotificationFilterProperty
or None
-
topic
¶ BucketResource.TopicConfigurationProperty.Topic http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-topicconfig.html#cfn-s3-bucket-notificationconfig-topicconfig-topic
Type: string or Token
-
-
class
TransitionProperty
¶ -
storageClass
¶ BucketResource.TransitionProperty.StorageClass http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-storageclass
Type: string or Token
-
transitionDate
¶ BucketResource.TransitionProperty.TransitionDate http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitiondate
Type: Token
or date or None
-
transitionInDays
¶ BucketResource.TransitionProperty.TransitionInDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-transition.html#cfn-s3-bucket-lifecycleconfig-rule-transition-transitionindays
Type: number or Token
or None
-
-
class
VersioningConfigurationProperty
¶ -
status
¶ BucketResource.VersioningConfigurationProperty.Status http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfig.html#cfn-s3-bucket-versioningconfig-status
Type: string or Token
-
-
class
WebsiteConfigurationProperty
¶ -
errorDocument
¶ BucketResource.WebsiteConfigurationProperty.ErrorDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-errordocument
Type: string or Token
or None
-
indexDocument
¶ BucketResource.WebsiteConfigurationProperty.IndexDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-indexdocument
Type: string or Token
or None
-
redirectAllRequestsTo
¶ BucketResource.WebsiteConfigurationProperty.RedirectAllRequestsTo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-redirectallrequeststo
Type: Token
orRedirectAllRequestsToProperty
or None
-
routingRules
¶ BucketResource.WebsiteConfigurationProperty.RoutingRules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration.html#cfn-s3-websiteconfiguration-routingrules
Type: Token
orToken
orRoutingRuleProperty
or None
-
- parent (
BucketResourceProps (interface)¶
-
class
_aws-cdk_resources.s3.
BucketResourceProps
¶ -
accelerateConfiguration
¶ AWS::S3::Bucket.AccelerateConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accelerateconfiguration
Type: Token
orAccelerateConfigurationProperty
or None
-
accessControl
¶ AWS::S3::Bucket.AccessControl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-accesscontrol
Type: string or Token
or None
-
analyticsConfigurations
¶ AWS::S3::Bucket.AnalyticsConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-analyticsconfigurations
Type: Token
orToken
orAnalyticsConfigurationProperty
or None
-
bucketEncryption
¶ AWS::S3::Bucket.BucketEncryption http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-bucketencryption
Type: Token
orBucketEncryptionProperty
or None
-
bucketName
¶ AWS::S3::Bucket.BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name
Type: string or Token
or None
-
corsConfiguration
¶ AWS::S3::Bucket.CorsConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-crossoriginconfig
Type: Token
orCorsConfigurationProperty
or None
-
inventoryConfigurations
¶ AWS::S3::Bucket.InventoryConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-inventoryconfigurations
Type: Token
orToken
orInventoryConfigurationProperty
or None
-
lifecycleConfiguration
¶ AWS::S3::Bucket.LifecycleConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-lifecycleconfig
Type: Token
orLifecycleConfigurationProperty
or None
-
loggingConfiguration
¶ AWS::S3::Bucket.LoggingConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-loggingconfig
Type: Token
orLoggingConfigurationProperty
or None
-
metricsConfigurations
¶ AWS::S3::Bucket.MetricsConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-metricsconfigurations
Type: Token
orToken
orMetricsConfigurationProperty
or None
-
notificationConfiguration
¶ AWS::S3::Bucket.NotificationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-notification
Type: Token
orNotificationConfigurationProperty
or None
-
replicationConfiguration
¶ AWS::S3::Bucket.ReplicationConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-replicationconfiguration
Type: Token
orReplicationConfigurationProperty
or None
AWS::S3::Bucket.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-tags
Type: Token
orToken
orTag
or None
-
versioningConfiguration
¶ AWS::S3::Bucket.VersioningConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-versioning
Type: Token
orVersioningConfigurationProperty
or None
-
websiteConfiguration
¶ AWS::S3::Bucket.WebsiteConfiguration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-websiteconfiguration
Type: Token
orWebsiteConfigurationProperty
or None
-
sdb¶
DomainResource¶
-
class
_aws-cdk_resources.sdb.
DomainResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DomainResource is a part of - name (string) –
- props (
DomainResourceProps
or None) – the properties of this DomainResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
serverless¶
ApiResource¶
-
class
_aws-cdk_resources.serverless.
ApiResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ApiResource is a part of - name (string) –
- props (
ApiResourceProps
or None) – the properties of this ApiResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
S3LocationProperty
¶ -
bucket
¶ ApiResource.S3LocationProperty.Bucket https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
key
¶ ApiResource.S3LocationProperty.Key https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
version
¶ ApiResource.S3LocationProperty.Version https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: number or Token
-
- parent (
ApiResourceProps (interface)¶
-
class
_aws-cdk_resources.serverless.
ApiResourceProps
¶ -
apiName
¶ AWS::Serverless::Api.Name https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: string or Token
or None
-
stageName
¶ AWS::Serverless::Api.StageName https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: string or Token
-
definitionUri
¶ AWS::Serverless::Api.DefinitionUri https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: string or Token
orS3LocationProperty
or None
-
definitionBody
¶ AWS::Serverless::Api.DefinitionBody https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: json or Token
or None
-
cacheClusterEnabled
¶ AWS::Serverless::Api.CacheClusterEnabled https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: boolean or Token
or None
-
cacheClusterSize
¶ AWS::Serverless::Api.CacheClusterSize https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: string or Token
or None
-
variables
¶ AWS::Serverless::Api.Variables https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
Type: Token
or string orToken
or None
-
FunctionResource¶
-
class
_aws-cdk_resources.serverless.
FunctionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this FunctionResource is a part of - name (string) –
- props (
FunctionResourceProps
or None) – the properties of this FunctionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
AlexaSkillEventProperty
¶ -
variables
¶ FunctionResource.AlexaSkillEventProperty.Variables https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#alexaskill
Type: Token
or string orToken
or None
-
-
class
ApiEventProperty
¶ -
path
¶ FunctionResource.ApiEventProperty.Path https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
Type: string or Token
-
method
¶ FunctionResource.ApiEventProperty.Method https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
Type: string or Token
-
restApiId
¶ FunctionResource.ApiEventProperty.RestApiId https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
Type: string or Token
or None
-
-
class
CloudWatchEventEventProperty
¶ -
pattern
¶ FunctionResource.CloudWatchEventEventProperty.Pattern http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html
Type: json or Token
-
input
¶ FunctionResource.CloudWatchEventEventProperty.Input https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cloudwatchevent
Type: string or Token
or None
-
inputPath
¶ FunctionResource.CloudWatchEventEventProperty.InputPath https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#cloudwatchevent
Type: string or Token
or None
-
-
class
DeadLetterQueueProperty
¶ -
type
¶ FunctionResource.DeadLetterQueueProperty.Type https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
targetArn
¶ FunctionResource.DeadLetterQueueProperty.TargetArn https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
-
class
DynamoDBEventProperty
¶ -
stream
¶ FunctionResource.DynamoDBEventProperty.Stream https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
Type: string or Token
-
startingPosition
¶ FunctionResource.DynamoDBEventProperty.StartingPosition https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
Type: string or Token
-
batchSize
¶ FunctionResource.DynamoDBEventProperty.BatchSize https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
Type: number or Token
-
-
class
EventSourceProperty
¶ -
type
¶ FunctionResource.EventSourceProperty.Type https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#event-source-object
Type: string or Token
-
properties
¶ FunctionResource.EventSourceProperty.Properties https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#event-source-types
Type: Token
orAlexaSkillEventProperty
orApiEventProperty
orCloudWatchEventEventProperty
orDynamoDBEventProperty
orS3EventProperty
orSNSEventProperty
orKinesisEventProperty
orScheduleEventProperty
orIoTRuleEventProperty
-
-
class
FunctionEnvironmentProperty
¶ -
variables
¶ FunctionResource.FunctionEnvironmentProperty.Variables https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object
Type: Token
or string orToken
-
-
class
IAMPolicyDocumentProperty
¶ -
statement
¶ FunctionResource.IAMPolicyDocumentProperty.Statement http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
Type: json or Token
-
-
class
IoTRuleEventProperty
¶ -
sql
¶ FunctionResource.IoTRuleEventProperty.Sql https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#iotrule
Type: string or Token
-
awsIotSqlVersion
¶ FunctionResource.IoTRuleEventProperty.AwsIotSqlVersion https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#iotrule
Type: string or Token
or None
-
-
class
KinesisEventProperty
¶ -
stream
¶ FunctionResource.KinesisEventProperty.Stream https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis
Type: string or Token
-
startingPosition
¶ FunctionResource.KinesisEventProperty.StartingPosition https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis
Type: string or Token
-
batchSize
¶ FunctionResource.KinesisEventProperty.BatchSize https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis
Type: number or Token
or None
-
-
class
S3EventProperty
¶ -
bucket
¶ FunctionResource.S3EventProperty.Bucket https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3
Type: string or Token
-
events
¶ FunctionResource.S3EventProperty.Events https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3
Type: string or Token
or string orToken
-
filter
¶ FunctionResource.S3EventProperty.Filter https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3
Type: Token
orS3NotificationFilterProperty
or None
-
-
class
S3LocationProperty
¶ -
bucket
¶ FunctionResource.S3LocationProperty.Bucket https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
key
¶ FunctionResource.S3LocationProperty.Key https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
version
¶ FunctionResource.S3LocationProperty.Version https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: number or Token
or None
-
-
class
S3NotificationFilterProperty
¶ -
s3Key
¶ FunctionResource.S3NotificationFilterProperty.S3Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html
Type: string or Token
-
-
class
SNSEventProperty
¶ -
topic
¶ FunctionResource.SNSEventProperty.Topic https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sns
Type: string or Token
-
-
class
ScheduleEventProperty
¶ -
schedule
¶ FunctionResource.ScheduleEventProperty.Schedule https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#schedule
Type: string or Token
-
input
¶ FunctionResource.ScheduleEventProperty.Input https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#schedule
Type: string or Token
or None
-
-
class
VpcConfigProperty
¶ -
securityGroupIds
¶ FunctionResource.VpcConfigProperty.SecurityGroupIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html
Type: Token
or string orToken
-
subnetIds
¶ FunctionResource.VpcConfigProperty.SubnetIds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html
Type: Token
or string orToken
-
- parent (
FunctionResourceProps (interface)¶
-
class
_aws-cdk_resources.serverless.
FunctionResourceProps
¶ -
handler
¶ AWS::Serverless::Function.Handler https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
runtime
¶ AWS::Serverless::Function.Runtime https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
-
codeUri
¶ AWS::Serverless::Function.CodeUri https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
orS3LocationProperty
-
functionName
¶ AWS::Serverless::Function.FunctionName https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
or None
-
description
¶ AWS::Serverless::Function.Description https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
or None
-
memorySize
¶ AWS::Serverless::Function.MemorySize https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: number or Token
or None
-
timeout
¶ AWS::Serverless::Function.Timeout https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: number or Token
or None
-
role
¶ AWS::Serverless::Function.Role https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
or None
-
policies
¶ AWS::Serverless::Function.Policies https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
orIAMPolicyDocumentProperty
or string orToken
orIAMPolicyDocumentProperty
or None
-
environment
¶ AWS::Serverless::Function.Environment https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: Token
orFunctionEnvironmentProperty
or None
-
vpcConfig
¶ AWS::Serverless::Function.VpcConfig https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: Token
orVpcConfigProperty
or None
-
events
¶ AWS::Serverless::Function.Events https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: Token
orToken
orEventSourceProperty
or None
AWS::Serverless::Function.Tags https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: Token
or string orToken
or None
-
tracing
¶ AWS::Serverless::Function.Tracing https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
or None
-
kmsKeyArn
¶ AWS::Serverless::Function.KmsKeyArn https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: string or Token
or None
-
deadLetterQueue
¶ AWS::Serverless::Function.DeadLetterQueue https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
Type: Token
orDeadLetterQueueProperty
or None
-
SimpleTableResource¶
-
class
_aws-cdk_resources.serverless.
SimpleTableResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SimpleTableResource is a part of - name (string) –
- props (
SimpleTableResourceProps
or None) – the properties of this SimpleTableResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
PrimaryKeyProperty
¶ -
name
¶ SimpleTableResource.PrimaryKeyProperty.Name https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#primary-key-object
Type: string or Token
or None
-
type
¶ SimpleTableResource.PrimaryKeyProperty.Type https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#primary-key-object
Type: string or Token
-
-
class
ProvisionedThroughputProperty
¶ -
readCapacityUnits
¶ SimpleTableResource.ProvisionedThroughputProperty.ReadCapacityUnits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html
Type: number or Token
or None
-
writeCapacityUnits
¶ SimpleTableResource.ProvisionedThroughputProperty.WriteCapacityUnits http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html
Type: number or Token
-
- parent (
SimpleTableResourceProps (interface)¶
-
class
_aws-cdk_resources.serverless.
SimpleTableResourceProps
¶ -
primaryKey
¶ AWS::Serverless::SimpleTable.PrimaryKey https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#primary-key-object
Type: Token
orPrimaryKeyProperty
or None
-
provisionedThroughput
¶ AWS::Serverless::SimpleTable.ProvisionedThroughput http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html
Type: Token
orProvisionedThroughputProperty
or None
-
servicecatalog¶
CloudFormationProductProductName¶
CloudFormationProductProvisioningArtifactIds¶
CloudFormationProductProvisioningArtifactNames¶
CloudFormationProductResource¶
-
class
_aws-cdk_resources.servicecatalog.
CloudFormationProductResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CloudFormationProductResource is a part of - name (string) –
- props (
CloudFormationProductResourceProps
or None) – the properties of this CloudFormationProductResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
cloudFormationProductProductName
¶ Type: CloudFormationProductProductName
(readonly)
-
cloudFormationProductProvisioningArtifactIds
¶ Type: CloudFormationProductProvisioningArtifactIds
(readonly)
-
cloudFormationProductProvisioningArtifactNames
¶ Type: CloudFormationProductProvisioningArtifactNames
(readonly)
-
class
ProvisioningArtifactPropertiesProperty
¶ -
description
¶ CloudFormationProductResource.ProvisioningArtifactPropertiesProperty.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-description
Type: string or Token
or None
-
info
¶ CloudFormationProductResource.ProvisioningArtifactPropertiesProperty.Info http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-info
Type: json or Token
-
name
¶ CloudFormationProductResource.ProvisioningArtifactPropertiesProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-name
Type: string or Token
or None
-
- parent (
CloudFormationProductResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
CloudFormationProductResourceProps
¶ -
owner
¶ AWS::ServiceCatalog::CloudFormationProduct.Owner http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-owner
Type: string or Token
-
supportDescription
¶ AWS::ServiceCatalog::CloudFormationProduct.SupportDescription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportdescription
Type: string or Token
or None
-
description
¶ AWS::ServiceCatalog::CloudFormationProduct.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-description
Type: string or Token
or None
-
distributor
¶ AWS::ServiceCatalog::CloudFormationProduct.Distributor http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-distributor
Type: string or Token
or None
-
supportEmail
¶ AWS::ServiceCatalog::CloudFormationProduct.SupportEmail http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportemail
Type: string or Token
or None
-
acceptLanguage
¶ AWS::ServiceCatalog::CloudFormationProduct.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-acceptlanguage
Type: string or Token
or None
-
supportUrl
¶ AWS::ServiceCatalog::CloudFormationProduct.SupportUrl http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supporturl
Type: string or Token
or None
AWS::ServiceCatalog::CloudFormationProduct.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-tags
Type: Token
orToken
orTag
or None
-
cloudFormationProductName
¶ AWS::ServiceCatalog::CloudFormationProduct.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-name
Type: string or Token
-
provisioningArtifactParameters
¶ AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactparameters
Type: Token
orToken
orProvisioningArtifactPropertiesProperty
-
CloudFormationProvisionedProductCloudformationStackArn¶
CloudFormationProvisionedProductRecordId¶
CloudFormationProvisionedProductResource¶
-
class
_aws-cdk_resources.servicecatalog.
CloudFormationProvisionedProductResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this CloudFormationProvisionedProductResource is a part of - name (string) –
- props (
CloudFormationProvisionedProductResourceProps
or None) – the properties of this CloudFormationProvisionedProductResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
cloudFormationProvisionedProductCloudformationStackArn
¶ Type: CloudFormationProvisionedProductCloudformationStackArn
(readonly)
-
cloudFormationProvisionedProductRecordId
¶ Type: CloudFormationProvisionedProductRecordId
(readonly)
-
class
ProvisioningParameterProperty
¶ -
value
¶ CloudFormationProvisionedProductResource.ProvisioningParameterProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-value
Type: string or Token
or None
-
key
¶ CloudFormationProvisionedProductResource.ProvisioningParameterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-key
Type: string or Token
or None
-
- parent (
CloudFormationProvisionedProductResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
CloudFormationProvisionedProductResourceProps
¶ -
pathId
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.PathId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-pathid
Type: string or Token
or None
-
provisioningParameters
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameters
Type: Token
orToken
orProvisioningParameterProperty
or None
-
productName
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProductName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-productname
Type: string or Token
or None
-
provisioningArtifactName
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningArtifactName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningartifactname
Type: string or Token
or None
-
notificationArns
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.NotificationArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-notificationarns
Type: Token
or string orToken
or None
-
acceptLanguage
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-acceptlanguage
Type: string or Token
or None
-
productId
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProductId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-productid
Type: string or Token
or None
AWS::ServiceCatalog::CloudFormationProvisionedProduct.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-tags
Type: Token
orToken
orTag
or None
-
provisionedProductName
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisionedProductName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisionedproductname
Type: string or Token
or None
-
provisioningArtifactId
¶ AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningArtifactId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningartifactid
Type: string or Token
or None
-
LaunchNotificationConstraintResource¶
-
class
_aws-cdk_resources.servicecatalog.
LaunchNotificationConstraintResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LaunchNotificationConstraintResource is a part of - name (string) –
- props (
LaunchNotificationConstraintResourceProps
or None) – the properties of this LaunchNotificationConstraintResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
LaunchNotificationConstraintResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
LaunchNotificationConstraintResourceProps
¶ -
description
¶ AWS::ServiceCatalog::LaunchNotificationConstraint.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-description
Type: string or Token
or None
-
notificationArns
¶ AWS::ServiceCatalog::LaunchNotificationConstraint.NotificationArns http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-notificationarns
Type: Token
or string orToken
-
acceptLanguage
¶ AWS::ServiceCatalog::LaunchNotificationConstraint.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-acceptlanguage
Type: string or Token
or None
-
portfolioId
¶ AWS::ServiceCatalog::LaunchNotificationConstraint.PortfolioId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-portfolioid
Type: string or Token
-
productId
¶ AWS::ServiceCatalog::LaunchNotificationConstraint.ProductId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchnotificationconstraint.html#cfn-servicecatalog-launchnotificationconstraint-productid
Type: string or Token
-
LaunchRoleConstraintResource¶
-
class
_aws-cdk_resources.servicecatalog.
LaunchRoleConstraintResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LaunchRoleConstraintResource is a part of - name (string) –
- props (
LaunchRoleConstraintResourceProps
or None) – the properties of this LaunchRoleConstraintResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
LaunchRoleConstraintResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
LaunchRoleConstraintResourceProps
¶ -
description
¶ AWS::ServiceCatalog::LaunchRoleConstraint.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-description
Type: string or Token
or None
-
acceptLanguage
¶ AWS::ServiceCatalog::LaunchRoleConstraint.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-acceptlanguage
Type: string or Token
or None
-
portfolioId
¶ AWS::ServiceCatalog::LaunchRoleConstraint.PortfolioId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-portfolioid
Type: string or Token
-
productId
¶ AWS::ServiceCatalog::LaunchRoleConstraint.ProductId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-productid
Type: string or Token
-
roleArn
¶ AWS::ServiceCatalog::LaunchRoleConstraint.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchroleconstraint.html#cfn-servicecatalog-launchroleconstraint-rolearn
Type: string or Token
-
LaunchTemplateConstraintResource¶
-
class
_aws-cdk_resources.servicecatalog.
LaunchTemplateConstraintResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this LaunchTemplateConstraintResource is a part of - name (string) –
- props (
LaunchTemplateConstraintResourceProps
or None) – the properties of this LaunchTemplateConstraintResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
LaunchTemplateConstraintResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
LaunchTemplateConstraintResourceProps
¶ -
description
¶ AWS::ServiceCatalog::LaunchTemplateConstraint.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-description
Type: string or Token
or None
-
acceptLanguage
¶ AWS::ServiceCatalog::LaunchTemplateConstraint.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-acceptlanguage
Type: string or Token
or None
-
portfolioId
¶ AWS::ServiceCatalog::LaunchTemplateConstraint.PortfolioId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-portfolioid
Type: string or Token
-
productId
¶ AWS::ServiceCatalog::LaunchTemplateConstraint.ProductId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-productid
Type: string or Token
-
rules
¶ AWS::ServiceCatalog::LaunchTemplateConstraint.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-launchtemplateconstraint.html#cfn-servicecatalog-launchtemplateconstraint-rules
Type: string or Token
-
PortfolioName¶
PortfolioPrincipalAssociationResource¶
-
class
_aws-cdk_resources.servicecatalog.
PortfolioPrincipalAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PortfolioPrincipalAssociationResource is a part of - name (string) –
- props (
PortfolioPrincipalAssociationResourceProps
or None) – the properties of this PortfolioPrincipalAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
PortfolioPrincipalAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
PortfolioPrincipalAssociationResourceProps
¶ -
principalArn
¶ AWS::ServiceCatalog::PortfolioPrincipalAssociation.PrincipalARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-principalarn
Type: string or Token
-
acceptLanguage
¶ AWS::ServiceCatalog::PortfolioPrincipalAssociation.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-acceptlanguage
Type: string or Token
or None
-
portfolioId
¶ AWS::ServiceCatalog::PortfolioPrincipalAssociation.PortfolioId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-portfolioid
Type: string or Token
-
principalType
¶ AWS::ServiceCatalog::PortfolioPrincipalAssociation.PrincipalType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioprincipalassociation.html#cfn-servicecatalog-portfolioprincipalassociation-principaltype
Type: string or Token
-
PortfolioProductAssociationResource¶
-
class
_aws-cdk_resources.servicecatalog.
PortfolioProductAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PortfolioProductAssociationResource is a part of - name (string) –
- props (
PortfolioProductAssociationResourceProps
or None) – the properties of this PortfolioProductAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
PortfolioProductAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
PortfolioProductAssociationResourceProps
¶ -
sourcePortfolioId
¶ AWS::ServiceCatalog::PortfolioProductAssociation.SourcePortfolioId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-sourceportfolioid
Type: string or Token
or None
-
acceptLanguage
¶ AWS::ServiceCatalog::PortfolioProductAssociation.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-acceptlanguage
Type: string or Token
or None
-
portfolioId
¶ AWS::ServiceCatalog::PortfolioProductAssociation.PortfolioId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-portfolioid
Type: string or Token
-
productId
¶ AWS::ServiceCatalog::PortfolioProductAssociation.ProductId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolioproductassociation.html#cfn-servicecatalog-portfolioproductassociation-productid
Type: string or Token
-
PortfolioResource¶
-
class
_aws-cdk_resources.servicecatalog.
PortfolioResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PortfolioResource is a part of - name (string) –
- props (
PortfolioResourceProps
or None) – the properties of this PortfolioResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
portfolioName
¶ Type: PortfolioName
(readonly)
- parent (
PortfolioResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
PortfolioResourceProps
¶ -
providerName
¶ AWS::ServiceCatalog::Portfolio.ProviderName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-providername
Type: string or Token
-
description
¶ AWS::ServiceCatalog::Portfolio.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-description
Type: string or Token
or None
-
displayName
¶ AWS::ServiceCatalog::Portfolio.DisplayName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-displayname
Type: string or Token
-
acceptLanguage
¶ AWS::ServiceCatalog::Portfolio.AcceptLanguage http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-acceptlanguage
Type: string or Token
or None
AWS::ServiceCatalog::Portfolio.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-portfolio.html#cfn-servicecatalog-portfolio-tags
Type: Token
orToken
orTag
or None
-
TagOptionAssociationResource¶
-
class
_aws-cdk_resources.servicecatalog.
TagOptionAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TagOptionAssociationResource is a part of - name (string) –
- props (
TagOptionAssociationResourceProps
or None) – the properties of this TagOptionAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
TagOptionAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
TagOptionAssociationResourceProps
¶ -
tagOptionId
¶ AWS::ServiceCatalog::TagOptionAssociation.TagOptionId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoptionassociation.html#cfn-servicecatalog-tagoptionassociation-tagoptionid
Type: string or Token
-
resourceId
¶ AWS::ServiceCatalog::TagOptionAssociation.ResourceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoptionassociation.html#cfn-servicecatalog-tagoptionassociation-resourceid
Type: string or Token
-
TagOptionResource¶
-
class
_aws-cdk_resources.servicecatalog.
TagOptionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TagOptionResource is a part of - name (string) –
- props (
TagOptionResourceProps
or None) – the properties of this TagOptionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
TagOptionResourceProps (interface)¶
-
class
_aws-cdk_resources.servicecatalog.
TagOptionResourceProps
¶ -
active
¶ AWS::ServiceCatalog::TagOption.Active http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html#cfn-servicecatalog-tagoption-active
Type: boolean or Token
or None
-
value
¶ AWS::ServiceCatalog::TagOption.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html#cfn-servicecatalog-tagoption-value
Type: string or Token
-
key
¶ AWS::ServiceCatalog::TagOption.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-tagoption.html#cfn-servicecatalog-tagoption-key
Type: string or Token
-
servicediscovery¶
InstanceResource¶
-
class
_aws-cdk_resources.servicediscovery.
InstanceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this InstanceResource is a part of - name (string) –
- props (
InstanceResourceProps
or None) – the properties of this InstanceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
InstanceResourceProps (interface)¶
-
class
_aws-cdk_resources.servicediscovery.
InstanceResourceProps
¶ -
instanceAttributes
¶ AWS::ServiceDiscovery::Instance.InstanceAttributes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceattributes
Type: json or Token
-
instanceId
¶ AWS::ServiceDiscovery::Instance.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-instanceid
Type: string or Token
or None
-
serviceId
¶ AWS::ServiceDiscovery::Instance.ServiceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html#cfn-servicediscovery-instance-serviceid
Type: string or Token
-
PrivateDnsNamespaceArn¶
PrivateDnsNamespaceId¶
PrivateDnsNamespaceResource¶
-
class
_aws-cdk_resources.servicediscovery.
PrivateDnsNamespaceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PrivateDnsNamespaceResource is a part of - name (string) –
- props (
PrivateDnsNamespaceResourceProps
or None) – the properties of this PrivateDnsNamespaceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
privateDnsNamespaceId
¶ Type: PrivateDnsNamespaceId
(readonly)
-
privateDnsNamespaceArn
¶ Type: PrivateDnsNamespaceArn
(readonly)
- parent (
PrivateDnsNamespaceResourceProps (interface)¶
-
class
_aws-cdk_resources.servicediscovery.
PrivateDnsNamespaceResourceProps
¶ -
description
¶ AWS::ServiceDiscovery::PrivateDnsNamespace.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-description
Type: string or Token
or None
-
vpc
¶ AWS::ServiceDiscovery::PrivateDnsNamespace.Vpc http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-vpc
Type: string or Token
-
privateDnsNamespaceName
¶ AWS::ServiceDiscovery::PrivateDnsNamespace.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-name
Type: string or Token
-
PublicDnsNamespaceArn¶
PublicDnsNamespaceId¶
PublicDnsNamespaceResource¶
-
class
_aws-cdk_resources.servicediscovery.
PublicDnsNamespaceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PublicDnsNamespaceResource is a part of - name (string) –
- props (
PublicDnsNamespaceResourceProps
or None) – the properties of this PublicDnsNamespaceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
publicDnsNamespaceId
¶ Type: PublicDnsNamespaceId
(readonly)
-
publicDnsNamespaceArn
¶ Type: PublicDnsNamespaceArn
(readonly)
- parent (
PublicDnsNamespaceResourceProps (interface)¶
-
class
_aws-cdk_resources.servicediscovery.
PublicDnsNamespaceResourceProps
¶ -
description
¶ AWS::ServiceDiscovery::PublicDnsNamespace.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-description
Type: string or Token
or None
-
publicDnsNamespaceName
¶ AWS::ServiceDiscovery::PublicDnsNamespace.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-publicdnsnamespace.html#cfn-servicediscovery-publicdnsnamespace-name
Type: string or Token
-
ServiceArn¶
ServiceId¶
ServiceName¶
ServiceResource¶
-
class
_aws-cdk_resources.servicediscovery.
ServiceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ServiceResource is a part of - name (string) –
- props (
ServiceResourceProps
or None) – the properties of this ServiceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
serviceId
¶ Type: ServiceId
(readonly)
-
serviceArn
¶ Type: ServiceArn
(readonly)
-
serviceName
¶ Type: ServiceName
(readonly)
-
class
DnsConfigProperty
¶ -
dnsRecords
¶ ServiceResource.DnsConfigProperty.DnsRecords http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-dnsrecords
Type: Token
orToken
orDnsRecordProperty
-
namespaceId
¶ ServiceResource.DnsConfigProperty.NamespaceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-namespaceid
Type: string or Token
-
-
class
DnsRecordProperty
¶ -
type
¶ ServiceResource.DnsRecordProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-type
Type: string or Token
-
ttl
¶ ServiceResource.DnsRecordProperty.TTL http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-ttl
Type: string or Token
-
-
class
HealthCheckConfigProperty
¶ -
type
¶ ServiceResource.HealthCheckConfigProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-type
Type: string or Token
-
resourcePath
¶ ServiceResource.HealthCheckConfigProperty.ResourcePath http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-resourcepath
Type: string or Token
or None
-
failureThreshold
¶ ServiceResource.HealthCheckConfigProperty.FailureThreshold http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-failurethreshold
Type: number or Token
or None
-
- parent (
ServiceResourceProps (interface)¶
-
class
_aws-cdk_resources.servicediscovery.
ServiceResourceProps
¶ -
description
¶ AWS::ServiceDiscovery::Service.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-description
Type: string or Token
or None
-
dnsConfig
¶ AWS::ServiceDiscovery::Service.DnsConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-dnsconfig
Type: Token
orDnsConfigProperty
-
healthCheckConfig
¶ AWS::ServiceDiscovery::Service.HealthCheckConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-healthcheckconfig
Type: Token
orHealthCheckConfigProperty
or None
-
serviceName
¶ AWS::ServiceDiscovery::Service.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html#cfn-servicediscovery-service-name
Type: string or Token
or None
-
ses¶
ConfigurationSetEventDestinationResource¶
-
class
_aws-cdk_resources.ses.
ConfigurationSetEventDestinationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ConfigurationSetEventDestinationResource is a part of - name (string) –
- props (
ConfigurationSetEventDestinationResourceProps
or None) – the properties of this ConfigurationSetEventDestinationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
CloudWatchDestinationProperty
¶ -
dimensionConfigurations
¶ ConfigurationSetEventDestinationResource.CloudWatchDestinationProperty.DimensionConfigurations http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html#cfn-ses-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations
Type: Token
orToken
orDimensionConfigurationProperty
or None
-
-
class
DimensionConfigurationProperty
¶ -
dimensionValueSource
¶ ConfigurationSetEventDestinationResource.DimensionConfigurationProperty.DimensionValueSource http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource
Type: string or Token
-
defaultDimensionValue
¶ ConfigurationSetEventDestinationResource.DimensionConfigurationProperty.DefaultDimensionValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue
Type: string or Token
-
dimensionName
¶ ConfigurationSetEventDestinationResource.DimensionConfigurationProperty.DimensionName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionname
Type: string or Token
-
-
class
EventDestinationProperty
¶ -
cloudWatchDestination
¶ ConfigurationSetEventDestinationResource.EventDestinationProperty.CloudWatchDestination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination
Type: Token
orCloudWatchDestinationProperty
or None
-
enabled
¶ ConfigurationSetEventDestinationResource.EventDestinationProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-enabled
Type: boolean or Token
or None
-
matchingEventTypes
¶ ConfigurationSetEventDestinationResource.EventDestinationProperty.MatchingEventTypes http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes
Type: Token
or string orToken
-
name
¶ ConfigurationSetEventDestinationResource.EventDestinationProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-name
Type: string or Token
or None
-
kinesisFirehoseDestination
¶ ConfigurationSetEventDestinationResource.EventDestinationProperty.KinesisFirehoseDestination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-kinesisfirehosedestination
Type: Token
orKinesisFirehoseDestinationProperty
or None
-
-
class
KinesisFirehoseDestinationProperty
¶ -
iamRoleArn
¶ ConfigurationSetEventDestinationResource.KinesisFirehoseDestinationProperty.IAMRoleARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-iamrolearn
Type: string or Token
-
deliveryStreamArn
¶ ConfigurationSetEventDestinationResource.KinesisFirehoseDestinationProperty.DeliveryStreamARN http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-deliverystreamarn
Type: string or Token
-
- parent (
ConfigurationSetEventDestinationResourceProps (interface)¶
-
class
_aws-cdk_resources.ses.
ConfigurationSetEventDestinationResourceProps
¶ -
configurationSetName
¶ AWS::SES::ConfigurationSetEventDestination.ConfigurationSetName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-configurationsetname
Type: string or Token
-
eventDestination
¶ AWS::SES::ConfigurationSetEventDestination.EventDestination http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-eventdestination
Type: Token
orEventDestinationProperty
-
ConfigurationSetResource¶
-
class
_aws-cdk_resources.ses.
ConfigurationSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ConfigurationSetResource is a part of - name (string) –
- props (
ConfigurationSetResourceProps
or None) – the properties of this ConfigurationSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ConfigurationSetResourceProps (interface)¶
ReceiptFilterResource¶
-
class
_aws-cdk_resources.ses.
ReceiptFilterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReceiptFilterResource is a part of - name (string) –
- props (
ReceiptFilterResourceProps
or None) – the properties of this ReceiptFilterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FilterProperty
¶ -
ipFilter
¶ ReceiptFilterResource.FilterProperty.IpFilter http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-ipfilter
Type: Token
orIpFilterProperty
-
name
¶ ReceiptFilterResource.FilterProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html#cfn-ses-receiptfilter-filter-name
Type: string or Token
or None
-
-
class
IpFilterProperty
¶ -
policy
¶ ReceiptFilterResource.IpFilterProperty.Policy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-policy
Type: string or Token
-
cidr
¶ ReceiptFilterResource.IpFilterProperty.Cidr http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-ipfilter.html#cfn-ses-receiptfilter-ipfilter-cidr
Type: string or Token
-
- parent (
ReceiptFilterResourceProps (interface)¶
ReceiptRuleResource¶
-
class
_aws-cdk_resources.ses.
ReceiptRuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReceiptRuleResource is a part of - name (string) –
- props (
ReceiptRuleResourceProps
or None) – the properties of this ReceiptRuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActionProperty
¶ -
bounceAction
¶ ReceiptRuleResource.ActionProperty.BounceAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-bounceaction
Type: Token
orBounceActionProperty
or None
-
s3Action
¶ ReceiptRuleResource.ActionProperty.S3Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-s3action
Type: Token
orS3ActionProperty
or None
-
stopAction
¶ ReceiptRuleResource.ActionProperty.StopAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-stopaction
Type: Token
orStopActionProperty
or None
-
snsAction
¶ ReceiptRuleResource.ActionProperty.SNSAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-snsaction
Type: Token
orSNSActionProperty
or None
-
workmailAction
¶ ReceiptRuleResource.ActionProperty.WorkmailAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction
Type: Token
orWorkmailActionProperty
or None
-
addHeaderAction
¶ ReceiptRuleResource.ActionProperty.AddHeaderAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-addheaderaction
Type: Token
orAddHeaderActionProperty
or None
-
lambdaAction
¶ ReceiptRuleResource.ActionProperty.LambdaAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-lambdaaction
Type: Token
orLambdaActionProperty
or None
-
-
class
AddHeaderActionProperty
¶ -
headerValue
¶ ReceiptRuleResource.AddHeaderActionProperty.HeaderValue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headervalue
Type: string or Token
-
headerName
¶ ReceiptRuleResource.AddHeaderActionProperty.HeaderName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headername
Type: string or Token
-
-
class
BounceActionProperty
¶ -
sender
¶ ReceiptRuleResource.BounceActionProperty.Sender http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-sender
Type: string or Token
-
smtpReplyCode
¶ ReceiptRuleResource.BounceActionProperty.SmtpReplyCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-smtpreplycode
Type: string or Token
-
message
¶ ReceiptRuleResource.BounceActionProperty.Message http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-message
Type: string or Token
-
topicArn
¶ ReceiptRuleResource.BounceActionProperty.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-topicarn
Type: string or Token
or None
-
statusCode
¶ ReceiptRuleResource.BounceActionProperty.StatusCode http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-bounceaction.html#cfn-ses-receiptrule-bounceaction-statuscode
Type: string or Token
or None
-
-
class
LambdaActionProperty
¶ -
functionArn
¶ ReceiptRuleResource.LambdaActionProperty.FunctionArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-functionarn
Type: string or Token
-
topicArn
¶ ReceiptRuleResource.LambdaActionProperty.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-topicarn
Type: string or Token
or None
-
invocationType
¶ ReceiptRuleResource.LambdaActionProperty.InvocationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-lambdaaction.html#cfn-ses-receiptrule-lambdaaction-invocationtype
Type: string or Token
or None
-
-
class
RuleProperty
¶ -
scanEnabled
¶ ReceiptRuleResource.RuleProperty.ScanEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-scanenabled
Type: boolean or Token
or None
-
recipients
¶ ReceiptRuleResource.RuleProperty.Recipients http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-recipients
Type: Token
or string orToken
or None
-
actions
¶ ReceiptRuleResource.RuleProperty.Actions http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-actions
Type: Token
orToken
orActionProperty
or None
-
enabled
¶ ReceiptRuleResource.RuleProperty.Enabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-enabled
Type: boolean or Token
or None
-
name
¶ ReceiptRuleResource.RuleProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-name
Type: string or Token
or None
-
tlsPolicy
¶ ReceiptRuleResource.RuleProperty.TlsPolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html#cfn-ses-receiptrule-rule-tlspolicy
Type: string or Token
or None
-
-
class
S3ActionProperty
¶ -
bucketName
¶ ReceiptRuleResource.S3ActionProperty.BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-bucketname
Type: string or Token
-
kmsKeyArn
¶ ReceiptRuleResource.S3ActionProperty.KmsKeyArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-kmskeyarn
Type: string or Token
or None
-
topicArn
¶ ReceiptRuleResource.S3ActionProperty.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn
Type: string or Token
or None
-
objectKeyPrefix
¶ ReceiptRuleResource.S3ActionProperty.ObjectKeyPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-objectkeyprefix
Type: string or Token
or None
-
-
class
SNSActionProperty
¶ -
topicArn
¶ ReceiptRuleResource.SNSActionProperty.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn
Type: string or Token
or None
-
encoding
¶ ReceiptRuleResource.SNSActionProperty.Encoding http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding
Type: string or Token
or None
-
-
class
StopActionProperty
¶ -
scope
¶ ReceiptRuleResource.StopActionProperty.Scope http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-scope
Type: string or Token
-
topicArn
¶ ReceiptRuleResource.StopActionProperty.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-stopaction.html#cfn-ses-receiptrule-stopaction-topicarn
Type: string or Token
or None
-
-
class
WorkmailActionProperty
¶ -
topicArn
¶ ReceiptRuleResource.WorkmailActionProperty.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn
Type: string or Token
or None
-
organizationArn
¶ ReceiptRuleResource.WorkmailActionProperty.OrganizationArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-workmailaction.html#cfn-ses-receiptrule-workmailaction-organizationarn
Type: string or Token
-
- parent (
ReceiptRuleResourceProps (interface)¶
-
class
_aws-cdk_resources.ses.
ReceiptRuleResourceProps
¶ -
after
¶ AWS::SES::ReceiptRule.After http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after
Type: string or Token
or None
-
rule
¶ AWS::SES::ReceiptRule.Rule http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rule
Type: Token
orRuleProperty
-
ruleSetName
¶ AWS::SES::ReceiptRule.RuleSetName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-rulesetname
Type: string or Token
-
ReceiptRuleSetResource¶
-
class
_aws-cdk_resources.ses.
ReceiptRuleSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ReceiptRuleSetResource is a part of - name (string) –
- props (
ReceiptRuleSetResourceProps
or None) – the properties of this ReceiptRuleSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
ReceiptRuleSetResourceProps (interface)¶
TemplateResource¶
-
class
_aws-cdk_resources.ses.
TemplateResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TemplateResource is a part of - name (string) –
- props (
TemplateResourceProps
or None) – the properties of this TemplateResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
TemplateProperty
¶ -
htmlPart
¶ TemplateResource.TemplateProperty.HtmlPart http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-htmlpart
Type: string or Token
or None
-
textPart
¶ TemplateResource.TemplateProperty.TextPart http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-textpart
Type: string or Token
or None
-
templateName
¶ TemplateResource.TemplateProperty.TemplateName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-templatename
Type: string or Token
or None
-
subjectPart
¶ TemplateResource.TemplateProperty.SubjectPart http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-subjectpart
Type: string or Token
or None
-
- parent (
sns¶
SubscriptionResource¶
-
class
_aws-cdk_resources.sns.
SubscriptionResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SubscriptionResource is a part of - name (string) –
- props (
SubscriptionResourceProps
or None) – the properties of this SubscriptionResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
SubscriptionResourceProps (interface)¶
-
class
_aws-cdk_resources.sns.
SubscriptionResourceProps
¶ -
endpoint
¶ AWS::SNS::Subscription.Endpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-endpoint
Type: string or Token
or None
-
protocol
¶ AWS::SNS::Subscription.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-protocol
Type: string or Token
or None
-
topicArn
¶ AWS::SNS::Subscription.TopicArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn
Type: string or Token
or None
-
TopicName¶
TopicPolicyResource¶
-
class
_aws-cdk_resources.sns.
TopicPolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TopicPolicyResource is a part of - name (string) –
- props (
TopicPolicyResourceProps
or None) – the properties of this TopicPolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
TopicPolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.sns.
TopicPolicyResourceProps
¶ -
policyDocument
¶ AWS::SNS::TopicPolicy.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-policydocument
Type: json or Token
-
topics
¶ AWS::SNS::TopicPolicy.Topics http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html#cfn-sns-topicpolicy-topics
Type: Token
or string orToken
-
TopicResource¶
-
class
_aws-cdk_resources.sns.
TopicResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this TopicResource is a part of - name (string) –
- props (
TopicResourceProps
or None) – the properties of this TopicResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
topicName
¶ Type: TopicName
(readonly)
-
class
SubscriptionProperty
¶ -
endpoint
¶ TopicResource.SubscriptionProperty.Endpoint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html#cfn-sns-topic-subscription-endpoint
Type: string or Token
-
protocol
¶ TopicResource.SubscriptionProperty.Protocol http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html#cfn-sns-topic-subscription-protocol
Type: string or Token
-
- parent (
TopicResourceProps (interface)¶
-
class
_aws-cdk_resources.sns.
TopicResourceProps
¶ -
displayName
¶ AWS::SNS::Topic.DisplayName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-displayname
Type: string or Token
or None
-
subscription
¶ AWS::SNS::Topic.Subscription http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-subscription
Type: Token
orToken
orSubscriptionProperty
or None
-
topicName
¶ AWS::SNS::Topic.TopicName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic.html#cfn-sns-topic-topicname
Type: string or Token
or None
-
sqs¶
QueueArn¶
QueueName¶
QueuePolicyResource¶
-
class
_aws-cdk_resources.sqs.
QueuePolicyResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this QueuePolicyResource is a part of - name (string) –
- props (
QueuePolicyResourceProps
or None) – the properties of this QueuePolicyResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
QueuePolicyResourceProps (interface)¶
-
class
_aws-cdk_resources.sqs.
QueuePolicyResourceProps
¶ -
policyDocument
¶ AWS::SQS::QueuePolicy.PolicyDocument http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc
Type: json or Token
-
queues
¶ AWS::SQS::QueuePolicy.Queues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues
Type: Token
or string orToken
-
QueueResource¶
-
class
_aws-cdk_resources.sqs.
QueueResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this QueueResource is a part of - name (string) –
- props (
QueueResourceProps
or None) – the properties of this QueueResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
queueArn
¶ Type: QueueArn
(readonly)
-
queueName
¶ Type: QueueName
(readonly)
- parent (
QueueResourceProps (interface)¶
-
class
_aws-cdk_resources.sqs.
QueueResourceProps
¶ -
contentBasedDeduplication
¶ AWS::SQS::Queue.ContentBasedDeduplication http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-contentbaseddeduplication
Type: boolean or Token
or None
-
delaySeconds
¶ AWS::SQS::Queue.DelaySeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-delayseconds
Type: number or Token
or None
-
fifoQueue
¶ AWS::SQS::Queue.FifoQueue http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-fifoqueue
Type: boolean or Token
or None
-
kmsDataKeyReusePeriodSeconds
¶ AWS::SQS::Queue.KmsDataKeyReusePeriodSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsdatakeyreuseperiodseconds
Type: number or Token
or None
-
kmsMasterKeyId
¶ AWS::SQS::Queue.KmsMasterKeyId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-kmsmasterkeyid
Type: string or Token
or None
-
maximumMessageSize
¶ AWS::SQS::Queue.MaximumMessageSize http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-maxmesgsize
Type: number or Token
or None
-
messageRetentionPeriod
¶ AWS::SQS::Queue.MessageRetentionPeriod http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-msgretentionperiod
Type: number or Token
or None
-
queueName
¶ AWS::SQS::Queue.QueueName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-name
Type: string or Token
or None
-
receiveMessageWaitTimeSeconds
¶ AWS::SQS::Queue.ReceiveMessageWaitTimeSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-receivemsgwaittime
Type: number or Token
or None
-
redrivePolicy
¶ AWS::SQS::Queue.RedrivePolicy http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-redrive
Type: json or Token
or None
-
visibilityTimeout
¶ AWS::SQS::Queue.VisibilityTimeout http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html#aws-sqs-queue-visiblitytimeout
Type: number or Token
or None
-
ssm¶
AssociationResource¶
-
class
_aws-cdk_resources.ssm.
AssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this AssociationResource is a part of - name (string) –
- props (
AssociationResourceProps
or None) – the properties of this AssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
InstanceAssociationOutputLocationProperty
¶ -
s3Location
¶ AssociationResource.InstanceAssociationOutputLocationProperty.S3Location http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location
Type: Token
orS3OutputLocationProperty
or None
-
-
class
ParameterValuesProperty
¶ -
parameterValues
¶ AssociationResource.ParameterValuesProperty.ParameterValues http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-parametervalues.html#cfn-ssm-association-parametervalues-parametervalues
Type: Token
or string orToken
-
-
class
S3OutputLocationProperty
¶ -
outputS3BucketName
¶ AssociationResource.S3OutputLocationProperty.OutputS3BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname
Type: string or Token
or None
-
outputS3KeyPrefix
¶ AssociationResource.S3OutputLocationProperty.OutputS3KeyPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix
Type: string or Token
or None
-
-
class
TargetProperty
¶ -
key
¶ AssociationResource.TargetProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key
Type: string or Token
-
values
¶ AssociationResource.TargetProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values
Type: Token
or string orToken
-
- parent (
AssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.ssm.
AssociationResourceProps
¶ -
associationName
¶ AWS::SSM::Association.AssociationName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname
Type: string or Token
or None
-
documentVersion
¶ AWS::SSM::Association.DocumentVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion
Type: string or Token
or None
-
instanceId
¶ AWS::SSM::Association.InstanceId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid
Type: string or Token
or None
-
outputLocation
¶ AWS::SSM::Association.OutputLocation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation
Type: Token
orInstanceAssociationOutputLocationProperty
or None
-
parameters
¶ AWS::SSM::Association.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters
Type: Token
orToken
orParameterValuesProperty
or None
-
scheduleExpression
¶ AWS::SSM::Association.ScheduleExpression http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression
Type: string or Token
or None
-
targets
¶ AWS::SSM::Association.Targets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets
Type: Token
orToken
orTargetProperty
or None
-
documentName
¶ AWS::SSM::Association.DocumentName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name
Type: string or Token
-
DocumentResource¶
-
class
_aws-cdk_resources.ssm.
DocumentResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this DocumentResource is a part of - name (string) –
- props (
DocumentResourceProps
or None) – the properties of this DocumentResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
DocumentResourceProps (interface)¶
-
class
_aws-cdk_resources.ssm.
DocumentResourceProps
¶ -
content
¶ AWS::SSM::Document.Content http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content
Type: json or Token
-
documentType
¶ AWS::SSM::Document.DocumentType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype
Type: string or Token
or None
AWS::SSM::Document.Tags http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags
Type: Token
orToken
orTag
or None
-
MaintenanceWindowTaskResource¶
-
class
_aws-cdk_resources.ssm.
MaintenanceWindowTaskResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this MaintenanceWindowTaskResource is a part of - name (string) –
- props (
MaintenanceWindowTaskResourceProps
or None) – the properties of this MaintenanceWindowTaskResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
LoggingInfoProperty
¶ -
s3Bucket
¶ MaintenanceWindowTaskResource.LoggingInfoProperty.S3Bucket http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket
Type: string or Token
-
region
¶ MaintenanceWindowTaskResource.LoggingInfoProperty.Region http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region
Type: string or Token
-
s3Prefix
¶ MaintenanceWindowTaskResource.LoggingInfoProperty.S3Prefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix
Type: string or Token
or None
-
-
class
MaintenanceWindowAutomationParametersProperty
¶ -
parameters
¶ MaintenanceWindowTaskResource.MaintenanceWindowAutomationParametersProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters
Type: json or Token
or None
-
documentVersion
¶ MaintenanceWindowTaskResource.MaintenanceWindowAutomationParametersProperty.DocumentVersion http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion
Type: string or Token
or None
-
-
class
MaintenanceWindowLambdaParametersProperty
¶ -
clientContext
¶ MaintenanceWindowTaskResource.MaintenanceWindowLambdaParametersProperty.ClientContext http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext
Type: string or Token
or None
-
qualifier
¶ MaintenanceWindowTaskResource.MaintenanceWindowLambdaParametersProperty.Qualifier http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier
Type: string or Token
or None
-
payload
¶ MaintenanceWindowTaskResource.MaintenanceWindowLambdaParametersProperty.Payload http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload
Type: string or Token
or None
-
-
class
MaintenanceWindowRunCommandParametersProperty
¶ -
timeoutSeconds
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.TimeoutSeconds http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds
Type: number or Token
or None
-
comment
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.Comment http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment
Type: string or Token
or None
-
outputS3KeyPrefix
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.OutputS3KeyPrefix http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix
Type: string or Token
or None
-
parameters
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.Parameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters
Type: json or Token
or None
-
documentHashType
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.DocumentHashType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype
Type: string or Token
or None
-
serviceRoleArn
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.ServiceRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn
Type: string or Token
or None
-
notificationConfig
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.NotificationConfig http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig
Type: Token
orNotificationConfigProperty
or None
-
outputS3BucketName
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.OutputS3BucketName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname
Type: string or Token
or None
-
documentHash
¶ MaintenanceWindowTaskResource.MaintenanceWindowRunCommandParametersProperty.DocumentHash http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash
Type: string or Token
or None
-
-
class
MaintenanceWindowStepFunctionsParametersProperty
¶ -
input
¶ MaintenanceWindowTaskResource.MaintenanceWindowStepFunctionsParametersProperty.Input http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input
Type: string or Token
or None
-
name
¶ MaintenanceWindowTaskResource.MaintenanceWindowStepFunctionsParametersProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name
Type: string or Token
or None
-
-
class
NotificationConfigProperty
¶ -
notificationArn
¶ MaintenanceWindowTaskResource.NotificationConfigProperty.NotificationArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn
Type: string or Token
-
notificationType
¶ MaintenanceWindowTaskResource.NotificationConfigProperty.NotificationType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype
Type: string or Token
or None
-
notificationEvents
¶ MaintenanceWindowTaskResource.NotificationConfigProperty.NotificationEvents http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents
Type: Token
or string orToken
or None
-
-
class
TargetProperty
¶ -
values
¶ MaintenanceWindowTaskResource.TargetProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values
Type: Token
or string orToken
or None
-
key
¶ MaintenanceWindowTaskResource.TargetProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key
Type: string or Token
-
-
class
TaskInvocationParametersProperty
¶ -
maintenanceWindowRunCommandParameters
¶ MaintenanceWindowTaskResource.TaskInvocationParametersProperty.MaintenanceWindowRunCommandParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters
Type: Token
orMaintenanceWindowRunCommandParametersProperty
or None
-
maintenanceWindowAutomationParameters
¶ MaintenanceWindowTaskResource.TaskInvocationParametersProperty.MaintenanceWindowAutomationParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters
Type: Token
orMaintenanceWindowAutomationParametersProperty
or None
-
maintenanceWindowStepFunctionsParameters
¶ MaintenanceWindowTaskResource.TaskInvocationParametersProperty.MaintenanceWindowStepFunctionsParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters
Type: Token
orMaintenanceWindowStepFunctionsParametersProperty
or None
-
maintenanceWindowLambdaParameters
¶ MaintenanceWindowTaskResource.TaskInvocationParametersProperty.MaintenanceWindowLambdaParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters
Type: Token
orMaintenanceWindowLambdaParametersProperty
or None
-
- parent (
MaintenanceWindowTaskResourceProps (interface)¶
-
class
_aws-cdk_resources.ssm.
MaintenanceWindowTaskResourceProps
¶ -
maxErrors
¶ AWS::SSM::MaintenanceWindowTask.MaxErrors http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors
Type: string or Token
-
description
¶ AWS::SSM::MaintenanceWindowTask.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description
Type: string or Token
or None
-
serviceRoleArn
¶ AWS::SSM::MaintenanceWindowTask.ServiceRoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn
Type: string or Token
-
priority
¶ AWS::SSM::MaintenanceWindowTask.Priority http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority
Type: number or Token
-
maxConcurrency
¶ AWS::SSM::MaintenanceWindowTask.MaxConcurrency http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency
Type: string or Token
-
targets
¶ AWS::SSM::MaintenanceWindowTask.Targets http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets
Type: Token
orToken
orTargetProperty
-
maintenanceWindowTaskName
¶ AWS::SSM::MaintenanceWindowTask.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name
Type: string or Token
or None
-
taskArn
¶ AWS::SSM::MaintenanceWindowTask.TaskArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn
Type: string or Token
-
taskInvocationParameters
¶ AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters
Type: Token
orTaskInvocationParametersProperty
or None
-
windowId
¶ AWS::SSM::MaintenanceWindowTask.WindowId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid
Type: string or Token
or None
-
taskParameters
¶ AWS::SSM::MaintenanceWindowTask.TaskParameters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters
Type: json or Token
or None
-
taskType
¶ AWS::SSM::MaintenanceWindowTask.TaskType http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype
Type: string or Token
-
loggingInfo
¶ AWS::SSM::MaintenanceWindowTask.LoggingInfo http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo
Type: Token
orLoggingInfoProperty
or None
-
ParameterResource¶
-
class
_aws-cdk_resources.ssm.
ParameterResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ParameterResource is a part of - name (string) –
- props (
ParameterResourceProps
or None) – the properties of this ParameterResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
parameterType
¶ Type: ParameterType
(readonly)
-
parameterValue
¶ Type: ParameterValue
(readonly)
- parent (
ParameterResourceProps (interface)¶
-
class
_aws-cdk_resources.ssm.
ParameterResourceProps
¶ -
type
¶ AWS::SSM::Parameter.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type
Type: string or Token
-
description
¶ AWS::SSM::Parameter.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description
Type: string or Token
or None
-
allowedPattern
¶ AWS::SSM::Parameter.AllowedPattern http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern
Type: string or Token
or None
-
value
¶ AWS::SSM::Parameter.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value
Type: string or Token
-
parameterName
¶ AWS::SSM::Parameter.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name
Type: string or Token
or None
-
ParameterType¶
ParameterValue¶
PatchBaselineResource¶
-
class
_aws-cdk_resources.ssm.
PatchBaselineResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this PatchBaselineResource is a part of - name (string) –
- props (
PatchBaselineResourceProps
or None) – the properties of this PatchBaselineResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
PatchFilterGroupProperty
¶ -
patchFilters
¶ PatchBaselineResource.PatchFilterGroupProperty.PatchFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters
Type: Token
orToken
orPatchFilterProperty
or None
-
-
class
PatchFilterProperty
¶ -
values
¶ PatchBaselineResource.PatchFilterProperty.Values http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values
Type: Token
or string orToken
or None
-
key
¶ PatchBaselineResource.PatchFilterProperty.Key http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key
Type: string or Token
or None
-
-
class
PatchSourceProperty
¶ -
products
¶ PatchBaselineResource.PatchSourceProperty.Products http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products
Type: Token
or string orToken
or None
-
configuration
¶ PatchBaselineResource.PatchSourceProperty.Configuration http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration
Type: string or Token
or None
-
name
¶ PatchBaselineResource.PatchSourceProperty.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name
Type: string or Token
or None
-
-
class
RuleGroupProperty
¶ -
patchRules
¶ PatchBaselineResource.RuleGroupProperty.PatchRules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules
Type: Token
orToken
orRuleProperty
or None
-
-
class
RuleProperty
¶ -
enableNonSecurity
¶ PatchBaselineResource.RuleProperty.EnableNonSecurity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity
Type: boolean or Token
or None
-
patchFilterGroup
¶ PatchBaselineResource.RuleProperty.PatchFilterGroup http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup
Type: Token
orPatchFilterGroupProperty
or None
-
approveAfterDays
¶ PatchBaselineResource.RuleProperty.ApproveAfterDays http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays
Type: number or Token
or None
-
complianceLevel
¶ PatchBaselineResource.RuleProperty.ComplianceLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel
Type: string or Token
or None
-
- parent (
PatchBaselineResourceProps (interface)¶
-
class
_aws-cdk_resources.ssm.
PatchBaselineResourceProps
¶ -
operatingSystem
¶ AWS::SSM::PatchBaseline.OperatingSystem http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem
Type: string or Token
or None
-
approvedPatches
¶ AWS::SSM::PatchBaseline.ApprovedPatches http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches
Type: Token
or string orToken
or None
-
patchGroups
¶ AWS::SSM::PatchBaseline.PatchGroups http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups
Type: Token
or string orToken
or None
-
description
¶ AWS::SSM::PatchBaseline.Description http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description
Type: string or Token
or None
-
approvedPatchesComplianceLevel
¶ AWS::SSM::PatchBaseline.ApprovedPatchesComplianceLevel http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel
Type: string or Token
or None
-
approvedPatchesEnableNonSecurity
¶ AWS::SSM::PatchBaseline.ApprovedPatchesEnableNonSecurity http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity
Type: boolean or Token
or None
-
approvalRules
¶ AWS::SSM::PatchBaseline.ApprovalRules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules
Type: Token
orRuleGroupProperty
or None
-
globalFilters
¶ AWS::SSM::PatchBaseline.GlobalFilters http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters
Type: Token
orPatchFilterGroupProperty
or None
-
sources
¶ AWS::SSM::PatchBaseline.Sources http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources
Type: Token
orToken
orPatchSourceProperty
or None
-
patchBaselineName
¶ AWS::SSM::PatchBaseline.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name
Type: string or Token
-
rejectedPatches
¶ AWS::SSM::PatchBaseline.RejectedPatches http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches
Type: Token
or string orToken
or None
-
stepfunctions¶
ActivityName¶
ActivityResource¶
-
class
_aws-cdk_resources.stepfunctions.
ActivityResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ActivityResource is a part of - name (string) –
- props (
ActivityResourceProps
or None) – the properties of this ActivityResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
activityName
¶ Type: ActivityName
(readonly)
- parent (
ActivityResourceProps (interface)¶
StateMachineName¶
StateMachineResource¶
-
class
_aws-cdk_resources.stepfunctions.
StateMachineResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this StateMachineResource is a part of - name (string) –
- props (
StateMachineResourceProps
or None) – the properties of this StateMachineResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
stateMachineName
¶ Type: StateMachineName
(readonly)
- parent (
StateMachineResourceProps (interface)¶
-
class
_aws-cdk_resources.stepfunctions.
StateMachineResourceProps
¶ -
definitionString
¶ AWS::StepFunctions::StateMachine.DefinitionString http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring
Type: string or Token
-
stateMachineName
¶ AWS::StepFunctions::StateMachine.StateMachineName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename
Type: string or Token
or None
-
roleArn
¶ AWS::StepFunctions::StateMachine.RoleArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn
Type: string or Token
-
waf¶
ByteMatchSetResource¶
-
class
_aws-cdk_resources.waf.
ByteMatchSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ByteMatchSetResource is a part of - name (string) –
- props (
ByteMatchSetResourceProps
or None) – the properties of this ByteMatchSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ByteMatchTupleProperty
¶ -
fieldToMatch
¶ ByteMatchSetResource.ByteMatchTupleProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch
Type: Token
orFieldToMatchProperty
-
positionalConstraint
¶ ByteMatchSetResource.ByteMatchTupleProperty.PositionalConstraint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-positionalconstraint
Type: string or Token
-
targetString
¶ ByteMatchSetResource.ByteMatchTupleProperty.TargetString http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-targetstring
Type: string or Token
or None
-
targetStringBase64
¶ ByteMatchSetResource.ByteMatchTupleProperty.TargetStringBase64 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-targetstringbase64
Type: string or Token
or None
-
textTransformation
¶ ByteMatchSetResource.ByteMatchTupleProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html#cfn-waf-bytematchset-bytematchtuples-texttransformation
Type: string or Token
-
-
class
FieldToMatchProperty
¶ -
data
¶ ByteMatchSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch-data
Type: string or Token
or None
-
type
¶ ByteMatchSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-bytematchset-bytematchtuples-fieldtomatch-type
Type: string or Token
-
- parent (
ByteMatchSetResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
ByteMatchSetResourceProps
¶ -
byteMatchTuples
¶ AWS::WAF::ByteMatchSet.ByteMatchTuples http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html#cfn-waf-bytematchset-bytematchtuples
Type: Token
orToken
orByteMatchTupleProperty
or None
-
byteMatchSetName
¶ AWS::WAF::ByteMatchSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-bytematchset.html#cfn-waf-bytematchset-name
Type: string or Token
-
IPSetResource¶
-
class
_aws-cdk_resources.waf.
IPSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this IPSetResource is a part of - name (string) –
- props (
IPSetResourceProps
or None) – the properties of this IPSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
IPSetDescriptorProperty
¶ -
type
¶ IPSetResource.IPSetDescriptorProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html#cfn-waf-ipset-ipsetdescriptors-type
Type: string or Token
-
value
¶ IPSetResource.IPSetDescriptorProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-ipset-ipsetdescriptors.html#cfn-waf-ipset-ipsetdescriptors-value
Type: string or Token
-
- parent (
IPSetResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
IPSetResourceProps
¶ -
ipSetDescriptors
¶ AWS::WAF::IPSet.IPSetDescriptors http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html#cfn-waf-ipset-ipsetdescriptors
Type: Token
orToken
orIPSetDescriptorProperty
or None
-
ipSetName
¶ AWS::WAF::IPSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-ipset.html#cfn-waf-ipset-name
Type: string or Token
-
RuleResource¶
-
class
_aws-cdk_resources.waf.
RuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RuleResource is a part of - name (string) –
- props (
RuleResourceProps
or None) – the properties of this RuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
PredicateProperty
¶ -
dataId
¶ RuleResource.PredicateProperty.DataId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-dataid
Type: string or Token
-
negated
¶ RuleResource.PredicateProperty.Negated http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-negated
Type: boolean or Token
-
type
¶ RuleResource.PredicateProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-rule-predicates.html#cfn-waf-rule-predicates-type
Type: string or Token
-
- parent (
RuleResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
RuleResourceProps
¶ -
metricName
¶ AWS::WAF::Rule.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-metricname
Type: string or Token
-
ruleName
¶ AWS::WAF::Rule.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-name
Type: string or Token
-
predicates
¶ AWS::WAF::Rule.Predicates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html#cfn-waf-rule-predicates
Type: Token
orToken
orPredicateProperty
or None
-
SizeConstraintSetResource¶
-
class
_aws-cdk_resources.waf.
SizeConstraintSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SizeConstraintSetResource is a part of - name (string) –
- props (
SizeConstraintSetResourceProps
or None) – the properties of this SizeConstraintSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldToMatchProperty
¶ -
data
¶ SizeConstraintSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-data
Type: string or Token
or None
-
type
¶ SizeConstraintSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-type
Type: string or Token
-
-
class
SizeConstraintProperty
¶ -
comparisonOperator
¶ SizeConstraintSetResource.SizeConstraintProperty.ComparisonOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-comparisonoperator
Type: string or Token
-
fieldToMatch
¶ SizeConstraintSetResource.SizeConstraintProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch
Type: Token
orFieldToMatchProperty
-
size
¶ SizeConstraintSetResource.SizeConstraintProperty.Size http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-size
Type: number or Token
-
textTransformation
¶ SizeConstraintSetResource.SizeConstraintProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sizeconstraintset-sizeconstraint.html#cfn-waf-sizeconstraintset-sizeconstraint-texttransformation
Type: string or Token
-
- parent (
SizeConstraintSetResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
SizeConstraintSetResourceProps
¶ -
sizeConstraintSetName
¶ AWS::WAF::SizeConstraintSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html#cfn-waf-sizeconstraintset-name
Type: string or Token
-
sizeConstraints
¶ AWS::WAF::SizeConstraintSet.SizeConstraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sizeconstraintset.html#cfn-waf-sizeconstraintset-sizeconstraints
Type: Token
orToken
orSizeConstraintProperty
-
SqlInjectionMatchSetResource¶
-
class
_aws-cdk_resources.waf.
SqlInjectionMatchSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SqlInjectionMatchSetResource is a part of - name (string) –
- props (
SqlInjectionMatchSetResourceProps
or None) – the properties of this SqlInjectionMatchSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldToMatchProperty
¶ -
data
¶ SqlInjectionMatchSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-data
Type: string or Token
or None
-
type
¶ SqlInjectionMatchSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples-fieldtomatch.html#cfn-waf-sizeconstraintset-sizeconstraint-fieldtomatch-type
Type: string or Token
-
-
class
SqlInjectionMatchTupleProperty
¶ -
fieldToMatch
¶ SqlInjectionMatchSetResource.SqlInjectionMatchTupleProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples-fieldtomatch
Type: Token
orFieldToMatchProperty
-
textTransformation
¶ SqlInjectionMatchSetResource.SqlInjectionMatchTupleProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-sqlinjectionmatchset-sqlinjectionmatchtuples.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples-texttransformation
Type: string or Token
-
- parent (
SqlInjectionMatchSetResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
SqlInjectionMatchSetResourceProps
¶ -
sqlInjectionMatchSetName
¶ AWS::WAF::SqlInjectionMatchSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html#cfn-waf-sqlinjectionmatchset-name
Type: string or Token
-
sqlInjectionMatchTuples
¶ AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuples http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-sqlinjectionmatchset.html#cfn-waf-sqlinjectionmatchset-sqlinjectionmatchtuples
Type: Token
orToken
orSqlInjectionMatchTupleProperty
or None
-
WebACLResource¶
-
class
_aws-cdk_resources.waf.
WebACLResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this WebACLResource is a part of - name (string) –
- props (
WebACLResourceProps
or None) – the properties of this WebACLResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActivatedRuleProperty
¶ -
action
¶ WebACLResource.ActivatedRuleProperty.Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-action
Type: Token
orWafActionProperty
-
priority
¶ WebACLResource.ActivatedRuleProperty.Priority http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-priority
Type: number or Token
-
ruleId
¶ WebACLResource.ActivatedRuleProperty.RuleId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-rules.html#cfn-waf-webacl-rules-ruleid
Type: string or Token
-
-
class
WafActionProperty
¶ -
type
¶ WebACLResource.WafActionProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-action.html#cfn-waf-webacl-action-type
Type: string or Token
-
- parent (
WebACLResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
WebACLResourceProps
¶ -
defaultAction
¶ AWS::WAF::WebACL.DefaultAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-defaultaction
Type: Token
orWafActionProperty
-
metricName
¶ AWS::WAF::WebACL.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-metricname
Type: string or Token
-
webAclName
¶ AWS::WAF::WebACL.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-name
Type: string or Token
-
rules
¶ AWS::WAF::WebACL.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html#cfn-waf-webacl-rules
Type: Token
orToken
orActivatedRuleProperty
or None
-
XssMatchSetResource¶
-
class
_aws-cdk_resources.waf.
XssMatchSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this XssMatchSetResource is a part of - name (string) –
- props (
XssMatchSetResourceProps
or None) – the properties of this XssMatchSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldToMatchProperty
¶ -
data
¶ XssMatchSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch-data
Type: string or Token
or None
-
type
¶ XssMatchSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple-fieldtomatch.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch-type
Type: string or Token
-
-
class
XssMatchTupleProperty
¶ -
fieldToMatch
¶ XssMatchSetResource.XssMatchTupleProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html#cfn-waf-xssmatchset-xssmatchtuple-fieldtomatch
Type: Token
orFieldToMatchProperty
-
textTransformation
¶ XssMatchSetResource.XssMatchTupleProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-xssmatchset-xssmatchtuple.html#cfn-waf-xssmatchset-xssmatchtuple-texttransformation
Type: string or Token
-
- parent (
XssMatchSetResourceProps (interface)¶
-
class
_aws-cdk_resources.waf.
XssMatchSetResourceProps
¶ -
xssMatchSetName
¶ AWS::WAF::XssMatchSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html#cfn-waf-xssmatchset-name
Type: string or Token
-
xssMatchTuples
¶ AWS::WAF::XssMatchSet.XssMatchTuples http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-xssmatchset.html#cfn-waf-xssmatchset-xssmatchtuples
Type: Token
orToken
orXssMatchTupleProperty
-
wafregional¶
ByteMatchSetResource¶
-
class
_aws-cdk_resources.wafregional.
ByteMatchSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this ByteMatchSetResource is a part of - name (string) –
- props (
ByteMatchSetResourceProps
or None) – the properties of this ByteMatchSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ByteMatchTupleProperty
¶ -
targetString
¶ ByteMatchSetResource.ByteMatchTupleProperty.TargetString http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-targetstring
Type: string or Token
or None
-
targetStringBase64
¶ ByteMatchSetResource.ByteMatchTupleProperty.TargetStringBase64 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-targetstringbase64
Type: string or Token
or None
-
positionalConstraint
¶ ByteMatchSetResource.ByteMatchTupleProperty.PositionalConstraint http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-positionalconstraint
Type: string or Token
-
textTransformation
¶ ByteMatchSetResource.ByteMatchTupleProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-texttransformation
Type: string or Token
-
fieldToMatch
¶ ByteMatchSetResource.ByteMatchTupleProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-bytematchtuple.html#cfn-wafregional-bytematchset-bytematchtuple-fieldtomatch
Type: Token
orFieldToMatchProperty
-
-
class
FieldToMatchProperty
¶ -
type
¶ ByteMatchSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html#cfn-wafregional-bytematchset-fieldtomatch-type
Type: string or Token
-
data
¶ ByteMatchSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-bytematchset-fieldtomatch.html#cfn-wafregional-bytematchset-fieldtomatch-data
Type: string or Token
or None
-
- parent (
ByteMatchSetResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
ByteMatchSetResourceProps
¶ -
byteMatchTuples
¶ AWS::WAFRegional::ByteMatchSet.ByteMatchTuples http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-bytematchtuples
Type: Token
orToken
orByteMatchTupleProperty
or None
-
byteMatchSetName
¶ AWS::WAFRegional::ByteMatchSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html#cfn-wafregional-bytematchset-name
Type: string or Token
-
IPSetResource¶
-
class
_aws-cdk_resources.wafregional.
IPSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this IPSetResource is a part of - name (string) –
- props (
IPSetResourceProps
or None) – the properties of this IPSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
IPSetDescriptorProperty
¶ -
type
¶ IPSetResource.IPSetDescriptorProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html#cfn-wafregional-ipset-ipsetdescriptor-type
Type: string or Token
-
value
¶ IPSetResource.IPSetDescriptorProperty.Value http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-ipset-ipsetdescriptor.html#cfn-wafregional-ipset-ipsetdescriptor-value
Type: string or Token
-
- parent (
IPSetResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
IPSetResourceProps
¶ -
ipSetDescriptors
¶ AWS::WAFRegional::IPSet.IPSetDescriptors http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html#cfn-wafregional-ipset-ipsetdescriptors
Type: Token
orToken
orIPSetDescriptorProperty
or None
-
ipSetName
¶ AWS::WAFRegional::IPSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ipset.html#cfn-wafregional-ipset-name
Type: string or Token
-
RuleResource¶
-
class
_aws-cdk_resources.wafregional.
RuleResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this RuleResource is a part of - name (string) –
- props (
RuleResourceProps
or None) – the properties of this RuleResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
PredicateProperty
¶ -
type
¶ RuleResource.PredicateProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-type
Type: string or Token
-
dataId
¶ RuleResource.PredicateProperty.DataId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-dataid
Type: string or Token
-
negated
¶ RuleResource.PredicateProperty.Negated http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-rule-predicate.html#cfn-wafregional-rule-predicate-negated
Type: boolean or Token
-
- parent (
RuleResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
RuleResourceProps
¶ -
metricName
¶ AWS::WAFRegional::Rule.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-metricname
Type: string or Token
-
predicates
¶ AWS::WAFRegional::Rule.Predicates http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-predicates
Type: Token
orToken
orPredicateProperty
or None
-
ruleName
¶ AWS::WAFRegional::Rule.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-rule.html#cfn-wafregional-rule-name
Type: string or Token
-
SizeConstraintSetResource¶
-
class
_aws-cdk_resources.wafregional.
SizeConstraintSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SizeConstraintSetResource is a part of - name (string) –
- props (
SizeConstraintSetResourceProps
or None) – the properties of this SizeConstraintSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldToMatchProperty
¶ -
type
¶ SizeConstraintSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html#cfn-wafregional-sizeconstraintset-fieldtomatch-type
Type: string or Token
-
data
¶ SizeConstraintSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-fieldtomatch.html#cfn-wafregional-sizeconstraintset-fieldtomatch-data
Type: string or Token
or None
-
-
class
SizeConstraintProperty
¶ -
comparisonOperator
¶ SizeConstraintSetResource.SizeConstraintProperty.ComparisonOperator http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-comparisonoperator
Type: string or Token
-
size
¶ SizeConstraintSetResource.SizeConstraintProperty.Size http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-size
Type: number or Token
-
textTransformation
¶ SizeConstraintSetResource.SizeConstraintProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-texttransformation
Type: string or Token
-
fieldToMatch
¶ SizeConstraintSetResource.SizeConstraintProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sizeconstraintset-sizeconstraint.html#cfn-wafregional-sizeconstraintset-sizeconstraint-fieldtomatch
Type: Token
orFieldToMatchProperty
-
- parent (
SizeConstraintSetResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
SizeConstraintSetResourceProps
¶ -
sizeConstraints
¶ AWS::WAFRegional::SizeConstraintSet.SizeConstraints http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html#cfn-wafregional-sizeconstraintset-sizeconstraints
Type: Token
orToken
orSizeConstraintProperty
or None
-
sizeConstraintSetName
¶ AWS::WAFRegional::SizeConstraintSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sizeconstraintset.html#cfn-wafregional-sizeconstraintset-name
Type: string or Token
-
SqlInjectionMatchSetResource¶
-
class
_aws-cdk_resources.wafregional.
SqlInjectionMatchSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this SqlInjectionMatchSetResource is a part of - name (string) –
- props (
SqlInjectionMatchSetResourceProps
or None) – the properties of this SqlInjectionMatchSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldToMatchProperty
¶ -
type
¶ SqlInjectionMatchSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html#cfn-wafregional-sqlinjectionmatchset-fieldtomatch-type
Type: string or Token
-
data
¶ SqlInjectionMatchSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-fieldtomatch.html#cfn-wafregional-sqlinjectionmatchset-fieldtomatch-data
Type: string or Token
or None
-
-
class
SqlInjectionMatchTupleProperty
¶ -
textTransformation
¶ SqlInjectionMatchSetResource.SqlInjectionMatchTupleProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple-texttransformation
Type: string or Token
-
fieldToMatch
¶ SqlInjectionMatchSetResource.SqlInjectionMatchTupleProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuple-fieldtomatch
Type: Token
orFieldToMatchProperty
-
- parent (
SqlInjectionMatchSetResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
SqlInjectionMatchSetResourceProps
¶ -
sqlInjectionMatchTuples
¶ AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuples http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html#cfn-wafregional-sqlinjectionmatchset-sqlinjectionmatchtuples
Type: Token
orToken
orSqlInjectionMatchTupleProperty
or None
-
sqlInjectionMatchSetName
¶ AWS::WAFRegional::SqlInjectionMatchSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-sqlinjectionmatchset.html#cfn-wafregional-sqlinjectionmatchset-name
Type: string or Token
-
WebACLAssociationResource¶
-
class
_aws-cdk_resources.wafregional.
WebACLAssociationResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this WebACLAssociationResource is a part of - name (string) –
- props (
WebACLAssociationResourceProps
or None) – the properties of this WebACLAssociationResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
WebACLAssociationResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
WebACLAssociationResourceProps
¶ -
resourceArn
¶ AWS::WAFRegional::WebACLAssociation.ResourceArn http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html#cfn-wafregional-webaclassociation-resourcearn
Type: string or Token
-
webAclId
¶ AWS::WAFRegional::WebACLAssociation.WebACLId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webaclassociation.html#cfn-wafregional-webaclassociation-webaclid
Type: string or Token
-
WebACLResource¶
-
class
_aws-cdk_resources.wafregional.
WebACLResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this WebACLResource is a part of - name (string) –
- props (
WebACLResourceProps
or None) – the properties of this WebACLResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
ActionProperty
¶ -
type
¶ WebACLResource.ActionProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-action.html#cfn-wafregional-webacl-action-type
Type: string or Token
-
-
class
RuleProperty
¶ -
action
¶ WebACLResource.RuleProperty.Action http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-action
Type: Token
orActionProperty
-
priority
¶ WebACLResource.RuleProperty.Priority http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-priority
Type: number or Token
-
ruleId
¶ WebACLResource.RuleProperty.RuleId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-webacl-rule.html#cfn-wafregional-webacl-rule-ruleid
Type: string or Token
-
- parent (
WebACLResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
WebACLResourceProps
¶ -
metricName
¶ AWS::WAFRegional::WebACL.MetricName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-metricname
Type: string or Token
-
defaultAction
¶ AWS::WAFRegional::WebACL.DefaultAction http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-defaultaction
Type: Token
orActionProperty
-
rules
¶ AWS::WAFRegional::WebACL.Rules http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-rules
Type: Token
orToken
orRuleProperty
or None
-
webAclName
¶ AWS::WAFRegional::WebACL.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-name
Type: string or Token
-
XssMatchSetResource¶
-
class
_aws-cdk_resources.wafregional.
XssMatchSetResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this XssMatchSetResource is a part of - name (string) –
- props (
XssMatchSetResourceProps
or None) – the properties of this XssMatchSetResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
-
class
FieldToMatchProperty
¶ -
type
¶ XssMatchSetResource.FieldToMatchProperty.Type http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html#cfn-wafregional-xssmatchset-fieldtomatch-type
Type: string or Token
-
data
¶ XssMatchSetResource.FieldToMatchProperty.Data http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-fieldtomatch.html#cfn-wafregional-xssmatchset-fieldtomatch-data
Type: string or Token
or None
-
-
class
XssMatchTupleProperty
¶ -
textTransformation
¶ XssMatchSetResource.XssMatchTupleProperty.TextTransformation http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html#cfn-wafregional-xssmatchset-xssmatchtuple-texttransformation
Type: string or Token
-
fieldToMatch
¶ XssMatchSetResource.XssMatchTupleProperty.FieldToMatch http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafregional-xssmatchset-xssmatchtuple.html#cfn-wafregional-xssmatchset-xssmatchtuple-fieldtomatch
Type: Token
orFieldToMatchProperty
-
- parent (
XssMatchSetResourceProps (interface)¶
-
class
_aws-cdk_resources.wafregional.
XssMatchSetResourceProps
¶ -
xssMatchTuples
¶ AWS::WAFRegional::XssMatchSet.XssMatchTuples http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html#cfn-wafregional-xssmatchset-xssmatchtuples
Type: Token
orToken
orXssMatchTupleProperty
or None
-
xssMatchSetName
¶ AWS::WAFRegional::XssMatchSet.Name http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-xssmatchset.html#cfn-wafregional-xssmatchset-name
Type: string or Token
-
workspaces¶
WorkspaceResource¶
-
class
_aws-cdk_resources.workspaces.
WorkspaceResource
(parent, name[, props])¶ Extends: Resource
Parameters: - parent (
Construct
) – the core.Construct this WorkspaceResource is a part of - name (string) –
- props (
WorkspaceResourceProps
or None) – the properties of this WorkspaceResource
-
renderProperties
() → string => any¶ Return type: any
-
resourceTypeName
¶ The CloudFormation resource type name for this resource class.
Type: string (readonly) (static)
-
resourceProperties
¶ The list of properties on the CloudFormation model for this resource, with their attache metadata.
Type: PropertySpecification
(readonly) (static)
- parent (
WorkspaceResourceProps (interface)¶
-
class
_aws-cdk_resources.workspaces.
WorkspaceResourceProps
¶ -
bundleId
¶ AWS::WorkSpaces::Workspace.BundleId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-bundleid
Type: string or Token
-
directoryId
¶ AWS::WorkSpaces::Workspace.DirectoryId http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-directoryid
Type: string or Token
-
rootVolumeEncryptionEnabled
¶ AWS::WorkSpaces::Workspace.RootVolumeEncryptionEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-rootvolumeencryptionenabled
Type: boolean or Token
or None
-
userName
¶ AWS::WorkSpaces::Workspace.UserName http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-username
Type: string or Token
-
userVolumeEncryptionEnabled
¶ AWS::WorkSpaces::Workspace.UserVolumeEncryptionEnabled http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-uservolumeencryptionenabled
Type: boolean or Token
or None
-
volumeEncryptionKey
¶ AWS::WorkSpaces::Workspace.VolumeEncryptionKey http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-volumeencryptionkey
Type: string or Token
or None
-