aws4embeddedlinux-cdk-lib
    Preparing search index...

    Interface PipelineResourcesProps

    Select options for the PipelineResourcesStack.

    interface PipelineResourcesProps {
        description?: string;
        env?: Environment;
        stackName?: string;
        tags?: { [key: string]: string };
        notificationArns?: string[];
        synthesizer?: IStackSynthesizer;
        terminationProtection?: boolean;
        analyticsReporting?: boolean;
        crossRegionReferences?: boolean;
        permissionsBoundary?: PermissionsBoundary;
        suppressTemplateIndentation?: boolean;
        resource_prefix: string;
        ecrRepositoryName?: string;
        pipelineArtifactBucketName?: string;
        pipelineSourceBucketName?: string;
        pipelineOutputBucketName?: string;
        loggingBucketName?: string;
    }

    Hierarchy

    • StackProps
      • PipelineResourcesProps
    Index

    Properties

    description? env? stackName? tags? notificationArns? synthesizer? terminationProtection? analyticsReporting? crossRegionReferences? permissionsBoundary? suppressTemplateIndentation? resource_prefix ecrRepositoryName? pipelineArtifactBucketName? pipelineSourceBucketName? pipelineOutputBucketName? loggingBucketName?

    Properties

    description?: string

    A description of the stack.

    - No description.
    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

    If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

    If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    stackName?: string

    Name to deploy the stack with

    - Derived from construct path.
    tags?: { [key: string]: string }

    Stack tags that will be applied to all the taggable resources and the stack itself.

    {}
    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    - no notfication arns.
    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    false
    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    false
    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    - no permissions boundary is applied
    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    resource_prefix: string

    The resource prefix

    ecrRepositoryName?: string

    The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'

    pipelineArtifactBucketName?: string

    The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'

    pipelineSourceBucketName?: string

    The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'

    pipelineOutputBucketName?: string

    The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'

    loggingBucketName?: string

    Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'

    Settings

    Member Visibility

    On This Page

    Properties