Metadata-Version: 2.1
Name: aws-cdk.core
Version: 1.32.0
Summary: AWS Cloud Development Kit Core Library
Home-page: https://github.com/aws/aws-cdk
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/aws/aws-cdk.git
Description: ## AWS Cloud Development Kit Core Library
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![Stability: Stable](https://img.shields.io/badge/stability-Stable-success.svg?style=for-the-badge)
        
        ---
        <!--END STABILITY BANNER-->
        
        This library includes the basic building blocks of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) (AWS CDK). It defines the core classes that are used in the rest of the
        AWS Construct Library.
        
        See the [AWS CDK Developer
        Guide](https://docs.aws.amazon.com/cdk/latest/guide/home.html) for
        information of most of the capabilities of this library. The rest of this
        README will only cover topics not already covered in the Developer Guide.
        
        ## Durations
        
        To make specifications of time intervals unambiguous, a single class called
        `Duration` is used throughout the AWS Construct Library by all constructs
        that that take a time interval as a parameter (be it for a timeout, a
        rate, or something else).
        
        An instance of Duration is constructed by using one of the static factory
        methods on it:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        Duration.seconds(300)# 5 minutes
        Duration.minutes(5)# 5 minutes
        Duration.hours(1)# 1 hour
        Duration.days(7)# 7 days
        Duration.parse("PT5M")
        ```
        
        ## Size (Digital Information Quantity)
        
        To make specification of digital storage quantities unambiguous, a class called
        `Size` is available.
        
        An instance of `Size` is initialized through one of its static factory methods:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        Size.kibibytes(200)# 200 KiB
        Size.mebibytes(5)# 5 MiB
        Size.gibibytes(40)# 40 GiB
        Size.tebibytes(200)# 200 TiB
        Size.pebibytes(3)
        ```
        
        Instances of `Size` created with one of the units can be converted into others.
        By default, conversion to a higher unit will fail if the conversion does not produce
        a whole number. This can be overridden by unsetting `integral` property.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        Size.mebibytes(2).to_kibibytes()# yields 2048
        Size.kibibytes(2050).to_mebibyte(integral=False)
        ```
        
        ## Secrets
        
        To help avoid accidental storage of secrets as plain text, we use the `SecretValue` type to
        represent secrets. Any construct that takes a value that should be a secret (such as
        a password or an access key) will take a parameter of type `SecretValue`.
        
        The best practice is to store secrets in AWS Secrets Manager and reference them using `SecretValue.secretsManager`:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        secret = SecretValue.secrets_manager("secretId",
            json_field="password", # optional: key of a JSON field to retrieve (defaults to all content),
            version_id="id", # optional: id of the version (default AWSCURRENT)
            version_stage="stage"
        )
        ```
        
        Using AWS Secrets Manager is the recommended way to reference secrets in a CDK app.
        `SecretValue` also supports the following secret sources:
        
        * `SecretValue.plainText(secret)`: stores the secret as plain text in your app and the resulting template (not recommended).
        * `SecretValue.ssmSecure(param, version)`: refers to a secret stored as a SecureString in the SSM Parameter Store.
        * `SecretValue.cfnParameter(param)`: refers to a secret passed through a CloudFormation parameter (must have `NoEcho: true`).
        * `SecretValue.cfnDynamicReference(dynref)`: refers to a secret described by a CloudFormation dynamic reference (used by `ssmSecure` and `secretsManager`).
        
        ## ARN manipulation
        
        Sometimes you will need to put together or pick apart Amazon Resource Names
        (ARNs). The functions `stack.formatArn()` and `stack.parseArn()` exist for
        this purpose.
        
        `formatArn()` can be used to build an ARN from components. It will automatically
        use the region and account of the stack you're calling it on:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        # Builds "arn:<PARTITION>:lambda:<REGION>:<ACCOUNT>:function:MyFunction"
        stack.format_arn(
            service="lambda",
            resource="function",
            sep=":",
            resource_name="MyFunction"
        )
        ```
        
        `parseArn()` can be used to get a single component from an ARN. `parseArn()`
        will correctly deal with both literal ARNs and deploy-time values (tokens),
        but in case of a deploy-time value be aware that the result will be another
        deploy-time value which cannot be inspected in the CDK application.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        # Extracts the function name out of an AWS Lambda Function ARN
        arn_components = stack.parse_arn(arn, ":")
        function_name = arn_components.resource_name
        ```
        
        Note that depending on the service, the resource separator can be either
        `:` or `/`, and the resource name can be either the 6th or 7th
        component in the ARN. When using these functions, you will need to know
        the format of the ARN you are dealing with.
        
        For an exhaustive list of ARN formats used in AWS, see [AWS ARNs and
        Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
        in the AWS General Reference.
        
        ## Dependencies
        
        ### Construct Dependencies
        
        Sometimes AWS resources depend on other resources, and the creation of one
        resource must be completed before the next one can be started.
        
        In general, CloudFormation will correctly infer the dependency relationship
        between resources based on the property values that are used. In the cases where
        it doesn't, the AWS Construct Library will add the dependency relationship for
        you.
        
        If you need to add an ordering dependency that is not automatically inferred,
        you do so by adding a dependency relationship using
        `constructA.node.addDependency(constructB)`. This will add a dependency
        relationship between all resources in the scope of `constructA` and all
        resources in the scope of `constructB`.
        
        If you want a single object to represent a set of constructs that are not
        necessarily in the same scope, you can use a `ConcreteDependable`. The
        following creates a single object that represents a dependency on two
        construts, `constructB` and `constructC`:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        # Declare the dependable object
        b_and_c = ConcreteDependable()
        b_and_c.add(construct_b)
        b_and_c.add(construct_c)
        
        # Take the dependency
        construct_a.node.add_dependency(b_and_c)
        ```
        
        ### Stack Dependencies
        
        Two different stack instances can have a dependency on one another. This
        happens when an resource from one stack is referenced in another stack. In
        that case, CDK records the cross-stack referencing of resources,
        automatically produces the right CloudFormation primitives, and adds a
        dependency between the two stacks. You can also manually add a dependency
        between two stacks by using the `stackA.addDependency(stackB)` method.
        
        A stack dependency has the following implications:
        
        * Cyclic dependencies are not allowed, so if `stackA` is using resources from
          `stackB`, the reverse is not possible anymore.
        * Stacks with dependencies between them are treated specially by the CDK
          toolkit:
        
          * If `stackA` depends on `stackB`, running `cdk deploy stackA` will also
            automatically deploy `stackB`.
          * `stackB`'s deployment will be performed *before* `stackA`'s deployment.
        
        ## AWS CloudFormation features
        
        A CDK stack synthesizes to an AWS CloudFormation Template. This section
        explains how this module allows users to access low-level CloudFormation
        features when needed.
        
        ### Stack Outputs
        
        CloudFormation [stack outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) and exports are created using
        the `CfnOutput` class:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        CfnOutput(self, "OutputName",
            value=bucket.bucket_name,
            description="The name of an S3 bucket", # Optional
            export_name="TheAwesomeBucket"
        )
        ```
        
        ### Parameters
        
        CloudFormation templates support the use of [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html) to
        customize a template. They enable CloudFormation users to input custom values to
        a template each time a stack is created or updated. While the CDK design
        philosophy favors using build-time parameterization, users may need to use
        CloudFormation in a number of cases (for example, when migrating an existing
        stack to the AWS CDK).
        
        Template parameters can be added to a stack by using the `CfnParameter` class:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        CfnParameter(self, "MyParameter",
            type="Number",
            default=1337
        )
        ```
        
        The value of parameters can then be obtained using one of the `value` methods.
        As parameters are only resolved at deployment time, the values obtained are
        placeholder tokens for the real value (`Token.isUnresolved()` would return `true`
        for those):
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        param = CfnParameter(self, "ParameterName")
        
        # If the parameter is a String
        param.value_as_string
        
        # If the parameter is a Number
        param.value_as_number
        
        # If the parameter is a List
        param.value_as_list
        ```
        
        ### Pseudo Parameters
        
        CloudFormation supports a number of [pseudo parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html),
        which resolve to useful values at deployment time. CloudFormation pseudo
        parameters can be obtained from static members of the `Aws` class.
        
        It is generally recommended to access pseudo parameters from the scope's `stack`
        instead, which guarantees the values produced are qualifying the designated
        stack, which is essential in cases where resources are shared cross-stack:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        # "this" is the current construct
        stack = Stack.of(self)
        
        stack.account# Returns the AWS::AccountId for this stack (or the literal value if known)
        stack.region# Returns the AWS::Region for this stack (or the literal value if known)
        stack.partition
        ```
        
        ### Resource Options
        
        CloudFormation resources can also specify [resource
        attributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-product-attribute-reference.html). The `CfnResource` class allows
        accessing those through the `cfnOptions` property:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        raw_bucket = s3.CfnBucket(self, "Bucket")
        # -or-
        raw_bucket = bucket.node.default_child
        
        # then
        raw_bucket.cfn_options.condition = CfnCondition(self, "EnableBucket")
        raw_bucket.cfn_options.metadata = {
            "metadata_key": "MetadataValue"
        }
        ```
        
        Resource dependencies (the `DependsOn` attribute) is modified using the
        `cfnResource.addDependsOn` method:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        resource_a = CfnResource(self, "ResourceA")
        resource_b = CfnResource(self, "ResourceB")
        
        resource_b.add_depends_on(resource_a)
        ```
        
        ### Intrinsic Functions and Condition Expressions
        
        CloudFormation supports [intrinsic functions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html). These functions
        can be accessed from the `Fn` class, which provides type-safe methods for each
        intrinsic function as well as condition expressions:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        # To use Fn::Base64
        Fn.base64("SGVsbG8gQ0RLIQo=")
        
        # To compose condition expressions:
        environment_parameter = CfnParameter(self, "Environment")
        Fn.condition_and(
            # The "Environment" CloudFormation template parameter evaluates to "Production"
            Fn.condition_equals("Production", environment_parameter),
            # The AWS::Region pseudo-parameter value is NOT equal to "us-east-1"
            Fn.condition_not(Fn.condition_equals("us-east-1", Aws.REGION)))
        ```
        
        When working with deploy-time values (those for which `Token.isUnresolved`
        returns `true`), idiomatic conditionals from the programming language cannot be
        used (the value will not be known until deployment time). When conditional logic
        needs to be expressed with un-resolved values, it is necessary to use
        CloudFormation conditions by means of the `CfnCondition` class:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        environment_parameter = CfnParameter(self, "Environment")
        is_prod = CfnCondition(self, "IsProduction",
            expression=Fn.condition_equals("Production", environment_parameter)
        )
        
        # Configuration value that is a different string based on IsProduction
        stage = Fn.condition_if(is_prod.logical_id, "Beta", "Prod").to_string()
        
        # Make Bucket creation condition to IsProduction by accessing
        # and overriding the CloudFormation resource
        bucket = s3.Bucket(self, "Bucket")
        cfn_bucket = bucket.node.default_child
        cfn_bucket.cfn_options.condition = is_prod
        ```
        
        ### Mappings
        
        CloudFormation [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html) are created and queried using the
        `CfnMappings` class:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        mapping = CfnMapping(self, "MappingTable",
            mapping={
                "region_name": {
                    "us-east-1": "US East (N. Virginia)",
                    "us-east-2": "US East (Ohio)"
                }
            }
        )
        
        mapping.find_in_map("regionName", Aws.REGION)
        ```
        
        ### Dynamic References
        
        CloudFormation supports [dynamically resolving](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) values
        for SSM parameters (including secure strings) and Secrets Manager. Encoding such
        references is done using the `CfnDynamicReference` class:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        CfnDynamicReference(self, "SecureStringValue",
            service=CfnDynamicReferenceService.SECRETS_MANAGER,
            reference_key="secret-id:secret-string:json-key:version-stage:version-id"
        )
        ```
        
        ### Template Options & Transform
        
        CloudFormation templates support a number of options, including which Macros or
        [Transforms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) to use when deploying the stack. Those can be
        configured using the `stack.templateOptions` property:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        stack = Stack(app, "StackName")
        
        stack.template_options.description = "This will appear in the AWS console"
        stack.template_options.transforms = ["AWS::Serverless-2016-10-31"]
        stack.template_options.metadata = {
            "metadata_key": "MetadataValue"
        }
        ```
        
        ### Emitting Raw Resources
        
        The `CfnResource` class allows emitting arbitrary entries in the
        [Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html) section of the CloudFormation template.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        CfnResource(self, "ResourceId",
            type="AWS::S3::Bucket",
            properties={
                "BucketName": "bucket-name"
            }
        )
        ```
        
        As for any other resource, the logical ID in the CloudFormation template will be
        generated by the AWS CDK, but the type and properties will be copied verbatim in
        the synthesized template.
        
        ### Including raw CloudFormation template fragments
        
        When migrating a CloudFormation stack to the AWS CDK, it can be useful to
        include fragments of an existing template verbatim in the synthesized template.
        This can be achieved using the `CfnInclude` class.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        CfnInclude(self, "ID",
            template={
                "Resources": {
                    "Bucket": {
                        "Type": "AWS::S3::Bucket",
                        "Properties": {
                            "BucketName": "my-shiny-bucket"
                        }
                    }
                }
            }
        )
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
