User Guide
0.7.2-beta
  • Welcome
    • Additional Documentation and Resources
    • About Amazon Web Services
  • Getting Started
    • Initialize the project
    • Add @aws-cdk/core as a dependency
    • Define your CDK app
    • Compile your code
    • Configure CDK toolkit via cdk.json
    • List all stacks in your app
    • Define a stack
    • Define an S3 bucket
    • Synthesize a CloudFormation template
    • Deploying our stack
    • Modifying your code
    • Preparing for deployment using cdk diff
  • Concepts
    • Constructs
      • Construct Structure
      • Construct Names
      • Construct Properties
      • Construct Metadata
    • Stacks
    • Logical IDs
      • Renaming Logical IDs
    • Environments and Authentication
      • Environmental Context
    • Apps
    • Applets
  • Examples
    • Creating a DynamoDB Table
    • Creating an Amazon RDS Database
    • Creating an Amazon S3 Bucket
    • Compiling the Examples
    • Creating a CloudFormation Template
    • Deploying your Stack
  • Tools
    • cdk
  • Advanced Topics
    • Creating CloudFormation Resource Constructs
      • Construct Attributes
      • Resource Options
      • Parameters
      • Outputs
      • Conditions
      • Intrinsic Functions
      • Pseudo Parameters
  • Glossary
  • AWS Construct Library
    • @aws-cdk/acm
      • AWS Certificate Manager Construct Library
        • Validation
        • Provisioning
        • Importing
      • Reference
        • Certificate
        • CertificateArn
        • CertificateProps (interface)
        • CertificateRef
        • CertificateRefProps (interface)
    • @aws-cdk/cloudfront
      • AWS CloudFront Construct Library
      • Reference
        • AliasConfiguration (interface)
        • Behavior (interface)
        • CloudFrontAllowedCachedMethods (enum)
        • CloudFrontAllowedMethods (enum)
        • CloudFrontWebDistribution
        • CloudFrontWebDistributionProps (interface)
        • CustomOriginConfig (interface)
        • ErrorConfiguration (interface)
        • HttpVersion (enum)
        • LoggingConfiguration (interface)
        • OriginProtocolPolicy (enum)
        • OriginSslPolicy (enum)
        • PriceClass (enum)
        • S3OriginConfig (interface)
        • SSLMethod (enum)
        • SourceConfiguration (interface)
        • ViewerProtocolPolicy (enum)
    • @aws-cdk/cloudtrail
      • AWS CloudTrail Construct Library
      • Reference
        • CloudTrail
        • CloudTrailProps (interface)
        • LogRetention (enum)
        • ReadWriteType (enum)
    • @aws-cdk/cloudwatch
    • Add alarms and graphs to CDK applications
      • Metric objects
      • Aggregation
      • Alarms
      • Making Dashboards
        • Graph widget
        • Alarm widget
        • Single value widget
        • Text widget
      • Dashboard Layout
      • Reference
        • Alarm
        • AlarmArn
        • AlarmMetricJson (interface)
        • AlarmProps (interface)
        • AlarmWidget
        • AlarmWidgetProps (interface)
        • Column
        • ComparisonOperator (enum)
        • ConcreteWidget
        • Dashboard
        • DashboardProps (interface)
        • Dimension (interface)
        • GraphWidget
        • GraphWidgetProps (interface)
        • HorizontalAnnotation (interface)
        • IAlarmAction (interface)
        • IWidget (interface)
        • Metric
        • MetricCustomization (interface)
        • MetricProps (interface)
        • MetricWidgetProps (interface)
        • NewAlarmProps (interface)
        • Region
        • Row
        • Shading (enum)
        • SingleValueWidget
        • SingleValueWidgetProps (interface)
        • Spacer
        • SpacerProps (interface)
        • Statistic (enum)
        • TextWidget
        • TextWidgetProps (interface)
        • TreatMissingData (enum)
        • Unit (enum)
        • YAxisRange (interface)
    • @aws-cdk/codebuild
      • AWS CodeBuild Construct Library
        • Using BuildProject as an event target
        • Using BuildProject as an event source
      • Reference
        • BitBucketSource
        • BuildArtifacts
        • BuildEnvironment (interface)
        • BuildEnvironmentVariable (interface)
        • BuildEnvironmentVariableType (enum)
        • BuildProject
        • BuildProjectProps (interface)
        • BuildProjectRef
        • BuildProjectRefProps (interface)
        • BuildSource
        • CodeCommitSource
        • CodePipelineBuildArtifacts
        • CodePipelineSource
        • ComputeType (enum)
        • GitHubEnterpriseSource
        • GitHubSource
        • NoBuildArtifacts
        • ProjectName
        • S3BucketBuildArtifacts
        • S3BucketBuildArtifactsProps (interface)
        • S3BucketSource
        • SourceType (enum)
    • @aws-cdk/codecommit
      • AWS CodeCommit Construct Library
        • Events
      • Reference
        • Repository
        • RepositoryEventTrigger (enum)
        • RepositoryProps (interface)
        • RepositoryRef
        • RepositoryRefProps (interface)
        • RepositoryTriggerOptions (interface)
    • @aws-cdk/codepipeline
      • AWS CodePipeline construct library
        • Events
      • Reference
        • Action
        • ActionArtifactBounds (interface)
        • ActionCategory (enum)
        • ActionProps (interface)
        • AmazonS3Source
        • AmazonS3SourceProps (interface)
        • ApprovalAction
        • Artifact
        • ArtifactAttribute
        • ArtifactGetParam
        • ArtifactPath
        • BuildAction
        • BuildActionProps (interface)
        • CodeBuildAction
        • CodeBuildActionProps (interface)
        • CodeCommitSource
        • CodeCommitSourceProps (interface)
        • GitHubSource
        • GithubSourceProps (interface)
        • InvokeLambdaAction
        • InvokeLambdaProps (interface)
        • Pipeline
        • PipelineArn
        • PipelineProps (interface)
        • Source
        • SourceProps (interface)
        • Stage
    • @aws-cdk/core
      • Reference
        • AccountPrincipal
        • AccountRootPrincipal
        • Anyone
        • App
        • Arn
        • ArnComponents (interface)
        • ArnPrincipal
        • AutoScalingCreationPolicy (interface)
        • AutoScalingReplacingUpdate (interface)
        • AutoScalingRollingUpdate (interface)
        • AutoScalingScheduledAction (interface)
        • AvailabilityZoneProvider
        • AwsAccountId
        • AwsDomainSuffix
        • AwsNoValue
        • AwsNotificationARNs
        • AwsPartition
        • AwsRegion
        • AwsStackId
        • AwsStackName
        • CanonicalUserPrincipal
        • Condition
        • ConditionProps (interface)
        • Construct
        • ContextProvider
        • CreationPolicy (interface)
        • DeletionPolicy (enum)
        • Environment (interface)
        • FederatedPrincipal
        • Fn
        • FnAnd
        • FnBase64
        • FnCidr
        • FnConcat
        • FnCondition
        • FnContains
        • FnEachMemberEquals
        • FnEachMemberIn
        • FnEquals
        • FnFindInMap
        • FnGetAZs
        • FnGetAtt
        • FnIf
        • FnImportValue
        • FnJoin
        • FnNot
        • FnOr
        • FnRefAll
        • FnSelect
        • FnSplit
        • FnSub
        • FnValueOf
        • FnValueOfAll
        • HashedAddressingScheme
        • IAddressingScheme (interface)
        • IDependable (interface)
        • Include
        • IncludeProps (interface)
        • LogicalIDs
        • Mapping
        • MappingProps (interface)
        • MetadataEntry (interface)
        • Output
        • OutputProps (interface)
        • Parameter
        • ParameterProps (interface)
        • PolicyDocument
        • PolicyPrincipal
        • PolicyStatement
        • PrincipalPolicyFragment
        • Program
        • PseudoParameter
        • Referenceable
        • RemovalPolicy (enum)
        • Resource
        • ResourceOptions (interface)
        • ResourceProps (interface)
        • ResourceSignal (interface)
        • Root
        • Rule
        • RuleAssertion (interface)
        • RuleProps (interface)
        • SSMParameterProvider
        • Secret
        • SecretParameter
        • SecretProps (interface)
        • ServicePrincipal
        • Stack
        • StackElement
        • StackProps (interface)
        • StringListOutput
        • StringListOutputProps (interface)
        • Tag (interface)
        • TemplateOptions (interface)
        • Token
        • UpdatePolicy (interface)
        • ValidationError
    • @aws-cdk/custom-resources
      • CDK Custom Resources
        • Example
        • References
      • Reference
        • CustomResource
        • CustomResourceProps (interface)
        • SingletonLambda
        • SingletonLambdaProps (interface)
    • @aws-cdk/cx-api
      • Reference
        • Environment (interface)
        • ListStacksRequest (interface)
        • ListStacksResponse (interface)
        • MetadataEntry (interface)
        • MissingContext (interface)
        • StackId (interface)
        • StackInfo (interface)
        • SynthesizeRequest (interface)
        • SynthesizeResponse (interface)
        • SynthesizedStack (interface)
    • @aws-cdk/dynamodb
      • AWS DynamoDB Construct Library
      • Reference
        • KeyAttributeType (enum)
        • Table
        • TableName
        • TableProps (interface)
    • @aws-cdk/ec2
      • AWS Compute and Networking Construct Library
        • VPC
        • Fleet
        • AMIs
        • Load Balancer
        • Allowing Connections
        • Connection Peers
        • Port Ranges
        • Default Ports
      • Reference
        • AllConnections
        • AmazonLinuxEdition (enum)
        • AmazonLinuxImage
        • AmazonLinuxImageProps (interface)
        • AmazonLinuxStorage (enum)
        • AmazonLinuxVirt (enum)
        • AnyIPv4
        • AnyIPv6
        • CidrIp
        • CidrIpv6
        • ClassicListenerPort
        • ClassicLoadBalancer
        • ClassicLoadBalancerListener (interface)
        • ClassicLoadBalancerProps (interface)
        • ConnectionRule (interface)
        • Connections
        • DefaultConnections
        • DefaultInstanceTenancy (enum)
        • Fleet
        • FleetProps (interface)
        • GenericLinuxImage
        • HealthCheck (interface)
        • IClassicLoadBalancerTarget (interface)
        • IConnectable (interface)
        • IConnectionPeer (interface)
        • IConnections (interface)
        • IDefaultConnectable (interface)
        • IMachineImageSource (interface)
        • IPortRange (interface)
        • ISecurityGroup (interface)
        • InstanceClass (enum)
        • InstanceSize (enum)
        • InstanceType
        • InstanceTypePair
        • LinuxOS
        • LoadBalancingProtocol (enum)
        • MachineImage
        • OperatingSystem
        • OperatingSystemType (enum)
        • OutboundTrafficMode (enum)
        • PrefixList
        • Protocol (enum)
        • SecurityGroup
        • SecurityGroupName
        • SecurityGroupProps (interface)
        • SecurityGroupRef
        • SecurityGroupRefProps (interface)
        • SecurityGrouplessConnections
        • TcpAllPorts
        • TcpPort
        • TcpPortFromAttribute
        • TcpPortRange
        • VpcNetwork
        • VpcNetworkId
        • VpcNetworkProps (interface)
        • VpcNetworkRef
        • VpcNetworkRefProps (interface)
        • VpcPlacementStrategy (interface)
        • VpcPrivateSubnet
        • VpcPublicSubnet
        • VpcSubnet
        • VpcSubnetId
        • VpcSubnetProps (interface)
        • VpcSubnetRef
        • VpcSubnetRefProps (interface)
        • WindowsImage
        • WindowsOS
        • WindowsVersion (enum)
    • @aws-cdk/events
      • AWS CloudWatch Events Construct Library
      • Reference
        • EventPattern (interface)
        • EventRule
        • EventRuleProps (interface)
        • EventRuleRef
        • EventRuleRefProps (interface)
        • EventRuleTarget (interface)
        • IEventRuleTarget (interface)
        • TargetInputTemplate (interface)
    • @aws-cdk/iam
      • AWS IAM Construct Library
        • Features
      • Reference
        • Group
        • GroupName
        • GroupProps (interface)
        • IIdentityResource (interface)
        • Policy
        • PolicyProps (interface)
        • Role
        • RoleName
        • RoleProps (interface)
        • User
        • UserName
        • UserProps (interface)
    • @aws-cdk/kinesis
      • AWS Kinesis Construct Library
        • Encryption
      • Reference
        • Stream
        • StreamEncryption (enum)
        • StreamName
        • StreamProps (interface)
        • StreamRef
        • StreamRefProps (interface)
    • @aws-cdk/kms
      • AWS KMS Construct Library
        • Importing and exporting keys
      • Reference
        • AliasName
        • EncryptionKey
        • EncryptionKeyAlias
        • EncryptionKeyAliasProps (interface)
        • EncryptionKeyProps (interface)
        • EncryptionKeyRef
        • EncryptionKeyRefProps (interface)
    • @aws-cdk/lambda
      • AWS Lambda Construct Library
        • Inline node.js Lambda Functions
      • Reference
        • Alias
        • AliasProps (interface)
        • FunctionName
        • FunctionVersion
        • IJavaScriptLambdaHandler (interface)
        • InlinableJavascriptLambdaRuntime (interface)
        • InlinableLambdaRuntime (interface)
        • InlineJavaScriptLambda
        • InlineJavaScriptLambdaProps (interface)
        • Lambda
        • LambdaCode
        • LambdaInlineCode
        • LambdaPermission (interface)
        • LambdaProps (interface)
        • LambdaRef
        • LambdaRefProps (interface)
        • LambdaRuntime
        • LambdaRuntimeProps (interface)
        • LambdaS3Code
        • Version
        • VersionProps (interface)
        • VersionWeight (interface)
    • @aws-cdk/neptune
      • Reference
        • NeptuneDatabase
        • NeptuneDatabaseProps (interface)
    • @aws-cdk/quickstarts
      • Reference
        • RemoteDesktopGateway
        • RemoteDesktopGatewayProps (interface)
        • SqlServer
        • SqlServerProps (interface)
    • @aws-cdk/rds
      • AWS RDS Construct Library
        • Starting a Clustered Database
        • Connecting
      • Reference
        • BackupProps (interface)
        • ClusterIdentifier
        • DatabaseCluster
        • DatabaseClusterEngine (enum)
        • DatabaseClusterProps (interface)
        • DatabaseClusterRef
        • DatabaseClusterRefProps (interface)
        • DatabaseInstance
        • Endpoint
        • InstanceIdentifier
        • InstanceProps (interface)
        • Login (interface)
        • Password
        • Port
        • SocketAddress
        • Username
    • @aws-cdk/resources
      • Low-level AWS CloudFormation Resources Library
        • Usage
      • Reference
        • PropertySpecification (interface)
        • ResourceClass (interface)
        • apigateway
        • applicationautoscaling
        • appsync
        • athena
        • autoscaling
        • autoscalingplans
        • batch
        • budgets
        • certificatemanager
        • cloud9
        • cloudformation
        • cloudfront
        • cloudtrail
        • cloudwatch
        • codebuild
        • codecommit
        • codedeploy
        • codepipeline
        • cognito
        • config
        • datapipeline
        • dax
        • directoryservice
        • dms
        • dynamodb
        • ec2
        • ecr
        • ecs
        • efs
        • eks
        • elasticache
        • elasticbeanstalk
        • elasticloadbalancing
        • elasticloadbalancingv2
        • elasticsearch
        • emr
        • events
        • gamelift
        • glue
        • guardduty
        • iam
        • inspector
        • iot
        • kinesis
        • kinesisanalytics
        • kinesisfirehose
        • kms
        • lambda
        • logs
        • neptune
        • opsworks
        • rds
        • redshift
        • route53
        • s3
        • sdb
        • serverless
        • servicecatalog
        • servicediscovery
        • ses
        • sns
        • sqs
        • ssm
        • stepfunctions
        • waf
        • wafregional
        • workspaces
    • @aws-cdk/route53
      • AWS Route53 Constuct Library
        • Adding Records
      • Reference
        • HostedZoneId
        • HostedZoneNameServers
        • HostedZoneRef
        • HostedZoneRefProps (interface)
        • ImportedHostedZone
        • PrivateHostedZone
        • PrivateHostedZoneProps (interface)
        • PublicHostedZone
        • PublicHostedZoneProps (interface)
        • TXTRecord
        • TXTRecordProps (interface)
        • ZoneDelegationRecord
        • ZoneDelegationRecordProps (interface)
    • @aws-cdk/rtv
    • Runtime Values
      • Construction Code
      • Runtime Code
        • Reference
      • ParameterName
      • RuntimeValue
      • RuntimeValueProps (interface)
    • @aws-cdk/s3
      • AWS S3 Construct Library
        • Encryption
        • Bucket Policy
        • Importing and Exporting Buckets
      • Reference
        • Bucket
        • BucketEncryption (enum)
        • BucketName
        • BucketPolicy
        • BucketPolicyProps (interface)
        • BucketProps (interface)
        • BucketRef
        • BucketRefProps (interface)
        • LifecycleRule (interface)
        • NoncurrentVersionTransition (interface)
        • StorageClass (enum)
        • Transition (interface)
    • @aws-cdk/sns
      • AWS SNS Construct Library
        • Subscriptions
        • CloudWatch Event Rule Target
      • Reference
        • EmailSubscriptionOptions (interface)
        • Subscription
        • SubscriptionProps (interface)
        • SubscriptionProtocol (enum)
        • Topic
        • TopicArn
        • TopicName
        • TopicPolicy
        • TopicPolicyProps (interface)
        • TopicProps (interface)
        • TopicRef
        • TopicRefProps (interface)
    • @aws-cdk/sqs
      • AWS SQS Construct Library
        • Encryption
        • First-In-First-Out (FIFO) queues
      • Reference
        • DeadLetterQueue (interface)
        • Queue
        • QueueEncryption (enum)
        • QueuePolicy
        • QueuePolicyProps (interface)
        • QueueProps (interface)
        • QueueRef
        • QueueRefProps (interface)
        • QueueUrl
User Guide
  • Docs »
  • User Guide
  • View page source

User GuideΒΆ

  • Welcome
    • Additional Documentation and Resources
    • About Amazon Web Services
  • Getting Started
    • Initialize the project
    • Add @aws-cdk/core as a dependency
    • Define your CDK app
    • Compile your code
    • Configure CDK toolkit via cdk.json
    • List all stacks in your app
    • Define a stack
    • Define an S3 bucket
    • Synthesize a CloudFormation template
    • Deploying our stack
    • Modifying your code
    • Preparing for deployment using cdk diff
  • Concepts
    • Constructs
    • Stacks
    • Logical IDs
    • Environments and Authentication
    • Apps
    • Applets
  • Examples
    • Creating a DynamoDB Table
    • Creating an Amazon RDS Database
    • Creating an Amazon S3 Bucket
    • Compiling the Examples
    • Creating a CloudFormation Template
    • Deploying your Stack
  • Tools
    • cdk
  • Advanced Topics
    • Creating CloudFormation Resource Constructs
  • Glossary
  • AWS Construct Library
    • @aws-cdk/acm
    • @aws-cdk/cloudfront
    • @aws-cdk/cloudtrail
    • @aws-cdk/cloudwatch
    • Add alarms and graphs to CDK applications
    • @aws-cdk/codebuild
    • @aws-cdk/codecommit
    • @aws-cdk/codepipeline
    • @aws-cdk/core
    • @aws-cdk/custom-resources
    • @aws-cdk/cx-api
    • @aws-cdk/dynamodb
    • @aws-cdk/ec2
    • @aws-cdk/events
    • @aws-cdk/iam
    • @aws-cdk/kinesis
    • @aws-cdk/kms
    • @aws-cdk/lambda
    • @aws-cdk/neptune
    • @aws-cdk/quickstarts
    • @aws-cdk/rds
    • @aws-cdk/resources
    • @aws-cdk/route53
    • @aws-cdk/rtv
    • Runtime Values
    • @aws-cdk/s3
    • @aws-cdk/sns
    • @aws-cdk/sqs
Next

© Copyright 2018, Amazon Web Services.

Built with Sphinx using a theme provided by Read the Docs.