aws-cdk-lib.aws_codepipeline.CfnPipeline

CfnPipeline L1 construct

The AWS::CodePipeline::Pipeline resource creates a CodePipeline pipeline that describes how software changes go through a release process.

For more information, see What Is CodePipeline? in the CodePipeline User Guide .

For an example in YAML and JSON that contains the parameters in this reference, see Examples .

Construct›CfnElement›CfnRefElement›CfnResource›CfnPipeline

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• IPipelineRef,
• IConstruct,
• 1 more

  • IDependable

CloudFormation

AWS::CodePipeline::Pipeline

Source

Generated code

Type last changed

v2.262.0 · 22 Jul 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';

declare const configuration: any;
const cfnPipeline = new codepipeline.CfnPipeline(this, 'MyCfnPipeline', {
  roleArn: 'roleArn',
  stages: [{
    actions: [{
      actionTypeId: {
        category: 'category',
        owner: 'owner',
        provider: 'provider',
        version: 'version',
      },
      name: 'name',

      // the properties below are optional
      commands: ['commands'],
      configuration: configuration,
      environmentVariables: [{
        name: 'name',
        value: 'value',

        // the properties below are optional
        type: 'type',
      }],
      inputArtifacts: [{
        name: 'name',
      }],
      namespace: 'namespace',
      outputArtifacts: [{
        name: 'name',

        // the properties below are optional
        files: ['files'],
      }],
      outputVariables: ['outputVariables'],
      region: 'region',
      roleArn: 'roleArn',
      runOrder: 123,
      timeoutInMinutes: 123,
    }],
    name: 'name',

    // the properties below are optional
    beforeEntry: {
      conditions: [{
        result: 'result',
        rules: [{
          commands: ['commands'],
          configuration: configuration,
          inputArtifacts: [{
            name: 'name',
          }],
          name: 'name',
          region: 'region',
          roleArn: 'roleArn',
          ruleTypeId: {
            category: 'category',
            owner: 'owner',
            provider: 'provider',
            version: 'version',
          },
        }],
      }],
    },
    blockers: [{
      name: 'name',
      type: 'type',
    }],
    onFailure: {
      conditions: [{
        result: 'result',
        rules: [{
          commands: ['commands'],
          configuration: configuration,
          inputArtifacts: [{
            name: 'name',
          }],
          name: 'name',
          region: 'region',
          roleArn: 'roleArn',
          ruleTypeId: {
            category: 'category',
            owner: 'owner',
            provider: 'provider',
            version: 'version',
          },
        }],
      }],
      result: 'result',
      retryConfiguration: {
        retryMode: 'retryMode',
      },
    },
    onSuccess: {
      conditions: [{
        result: 'result',
        rules: [{
          commands: ['commands'],
          configuration: configuration,
          inputArtifacts: [{
            name: 'name',
          }],
          name: 'name',
          region: 'region',
          roleArn: 'roleArn',
          ruleTypeId: {
            category: 'category',
            owner: 'owner',
            provider: 'provider',
            version: 'version',
          },
        }],
      }],
    },
  }],

  // the properties below are optional
  artifactStore: {
    location: 'location',
    type: 'type',

    // the properties below are optional
    encryptionKey: {
      id: 'id',
      type: 'type',
    },
  },
  artifactStores: [{
    artifactStore: {
      location: 'location',
      type: 'type',

      // the properties below are optional
      encryptionKey: {
        id: 'id',
        type: 'type',
      },
    },
    region: 'region',
  }],
  disableInboundStageTransitions: [{
    reason: 'reason',
    stageName: 'stageName',
  }],
  executionMode: 'executionMode',
  name: 'name',
  pipelineType: 'pipelineType',
  restartExecutionOnUpdate: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  triggers: [{
    providerType: 'providerType',

    // the properties below are optional
    gitConfiguration: {
      sourceActionName: 'sourceActionName',

      // the properties below are optional
      pullRequest: [{
        branches: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        events: ['events'],
        filePaths: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
      }],
      push: [{
        branches: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        filePaths: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
        tags: {
          excludes: ['excludes'],
          includes: ['includes'],
        },
      }],
    },
  }],
  variables: [{
    name: 'name',

    // the properties below are optional
    defaultValue: 'defaultValue',
    description: 'description',
  }],
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codepipeline as codepipeline

# configuration: Any

cfn_pipeline = codepipeline.CfnPipeline(self, "MyCfnPipeline",
    role_arn="roleArn",
    stages=[codepipeline.CfnPipeline.StageDeclarationProperty(
        actions=[codepipeline.CfnPipeline.ActionDeclarationProperty(
            action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty(
                category="category",
                owner="owner",
                provider="provider",
                version="version"
            ),
            name="name",

            # the properties below are optional
            commands=["commands"],
            configuration=configuration,
            environment_variables=[codepipeline.CfnPipeline.EnvironmentVariableProperty(
                name="name",
                value="value",

                # the properties below are optional
                type="type"
            )],
            input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                name="name"
            )],
            namespace="namespace",
            output_artifacts=[codepipeline.CfnPipeline.OutputArtifactProperty(
                name="name",

                # the properties below are optional
                files=["files"]
            )],
            output_variables=["outputVariables"],
            region="region",
            role_arn="roleArn",
            run_order=123,
            timeout_in_minutes=123
        )],
        name="name",

        # the properties below are optional
        before_entry=codepipeline.CfnPipeline.BeforeEntryConditionsProperty(
            conditions=[codepipeline.CfnPipeline.ConditionProperty(
                result="result",
                rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                    commands=["commands"],
                    configuration=configuration,
                    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                        name="name"
                    )],
                    name="name",
                    region="region",
                    role_arn="roleArn",
                    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                        category="category",
                        owner="owner",
                        provider="provider",
                        version="version"
                    )
                )]
            )]
        ),
        blockers=[codepipeline.CfnPipeline.BlockerDeclarationProperty(
            name="name",
            type="type"
        )],
        on_failure=codepipeline.CfnPipeline.FailureConditionsProperty(
            conditions=[codepipeline.CfnPipeline.ConditionProperty(
                result="result",
                rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                    commands=["commands"],
                    configuration=configuration,
                    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                        name="name"
                    )],
                    name="name",
                    region="region",
                    role_arn="roleArn",
                    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                        category="category",
                        owner="owner",
                        provider="provider",
                        version="version"
                    )
                )]
            )],
            result="result",
            retry_configuration=codepipeline.CfnPipeline.RetryConfigurationProperty(
                retry_mode="retryMode"
            )
        ),
        on_success=codepipeline.CfnPipeline.SuccessConditionsProperty(
            conditions=[codepipeline.CfnPipeline.ConditionProperty(
                result="result",
                rules=[codepipeline.CfnPipeline.RuleDeclarationProperty(
                    commands=["commands"],
                    configuration=configuration,
                    input_artifacts=[codepipeline.CfnPipeline.InputArtifactProperty(
                        name="name"
                    )],
                    name="name",
                    region="region",
                    role_arn="roleArn",
                    rule_type_id=codepipeline.CfnPipeline.RuleTypeIdProperty(
                        category="category",
                        owner="owner",
                        provider="provider",
                        version="version"
                    )
                )]
            )]
        )
    )],

    # the properties below are optional
    artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty(
        location="location",
        type="type",

        # the properties below are optional
        encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty(
            id="id",
            type="type"
        )
    ),
    artifact_stores=[codepipeline.CfnPipeline.ArtifactStoreMapProperty(
        artifact_store=codepipeline.CfnPipeline.ArtifactStoreProperty(
            location="location",
            type="type",

            # the properties below are optional
            encryption_key=codepipeline.CfnPipeline.EncryptionKeyProperty(
                id="id",
                type="type"
            )
        ),
        region="region"
    )],
    disable_inbound_stage_transitions=[codepipeline.CfnPipeline.StageTransitionProperty(
        reason="reason",
        stage_name="stageName"
    )],
    execution_mode="executionMode",
    name="name",
    pipeline_type="pipelineType",
    restart_execution_on_update=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    triggers=[codepipeline.CfnPipeline.PipelineTriggerDeclarationProperty(
        provider_type="providerType",

        # the properties below are optional
        git_configuration=codepipeline.CfnPipeline.GitConfigurationProperty(
            source_action_name="sourceActionName",

            # the properties below are optional
            pull_request=[codepipeline.CfnPipeline.GitPullRequestFilterProperty(
                branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                ),
                events=["events"],
                file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                )
            )],
            push=[codepipeline.CfnPipeline.GitPushFilterProperty(
                branches=codepipeline.CfnPipeline.GitBranchFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                ),
                file_paths=codepipeline.CfnPipeline.GitFilePathFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                ),
                tags=codepipeline.CfnPipeline.GitTagFilterCriteriaProperty(
                    excludes=["excludes"],
                    includes=["includes"]
                )
            )]
        )
    )],
    variables=[codepipeline.CfnPipeline.VariableDeclarationProperty(
        name="name",

        # the properties below are optional
        default_value="defaultValue",
        description="description"
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codepipeline.*;

Object configuration;

CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
        .roleArn("roleArn")
        .stages(List.of(StageDeclarationProperty.builder()
                .actions(List.of(ActionDeclarationProperty.builder()
                        .actionTypeId(ActionTypeIdProperty.builder()
                                .category("category")
                                .owner("owner")
                                .provider("provider")
                                .version("version")
                                .build())
                        .name("name")

                        // the properties below are optional
                        .commands(List.of("commands"))
                        .configuration(configuration)
                        .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                                .name("name")
                                .value("value")

                                // the properties below are optional
                                .type("type")
                                .build()))
                        .inputArtifacts(List.of(InputArtifactProperty.builder()
                                .name("name")
                                .build()))
                        .namespace("namespace")
                        .outputArtifacts(List.of(OutputArtifactProperty.builder()
                                .name("name")

                                // the properties below are optional
                                .files(List.of("files"))
                                .build()))
                        .outputVariables(List.of("outputVariables"))
                        .region("region")
                        .roleArn("roleArn")
                        .runOrder(123)
                        .timeoutInMinutes(123)
                        .build()))
                .name("name")

                // the properties below are optional
                .beforeEntry(BeforeEntryConditionsProperty.builder()
                        .conditions(List.of(ConditionProperty.builder()
                                .result("result")
                                .rules(List.of(RuleDeclarationProperty.builder()
                                        .commands(List.of("commands"))
                                        .configuration(configuration)
                                        .inputArtifacts(List.of(InputArtifactProperty.builder()
                                                .name("name")
                                                .build()))
                                        .name("name")
                                        .region("region")
                                        .roleArn("roleArn")
                                        .ruleTypeId(RuleTypeIdProperty.builder()
                                                .category("category")
                                                .owner("owner")
                                                .provider("provider")
                                                .version("version")
                                                .build())
                                        .build()))
                                .build()))
                        .build())
                .blockers(List.of(BlockerDeclarationProperty.builder()
                        .name("name")
                        .type("type")
                        .build()))
                .onFailure(FailureConditionsProperty.builder()
                        .conditions(List.of(ConditionProperty.builder()
                                .result("result")
                                .rules(List.of(RuleDeclarationProperty.builder()
                                        .commands(List.of("commands"))
                                        .configuration(configuration)
                                        .inputArtifacts(List.of(InputArtifactProperty.builder()
                                                .name("name")
                                                .build()))
                                        .name("name")
                                        .region("region")
                                        .roleArn("roleArn")
                                        .ruleTypeId(RuleTypeIdProperty.builder()
                                                .category("category")
                                                .owner("owner")
                                                .provider("provider")
                                                .version("version")
                                                .build())
                                        .build()))
                                .build()))
                        .result("result")
                        .retryConfiguration(RetryConfigurationProperty.builder()
                                .retryMode("retryMode")
                                .build())
                        .build())
                .onSuccess(SuccessConditionsProperty.builder()
                        .conditions(List.of(ConditionProperty.builder()
                                .result("result")
                                .rules(List.of(RuleDeclarationProperty.builder()
                                        .commands(List.of("commands"))
                                        .configuration(configuration)
                                        .inputArtifacts(List.of(InputArtifactProperty.builder()
                                                .name("name")
                                                .build()))
                                        .name("name")
                                        .region("region")
                                        .roleArn("roleArn")
                                        .ruleTypeId(RuleTypeIdProperty.builder()
                                                .category("category")
                                                .owner("owner")
                                                .provider("provider")
                                                .version("version")
                                                .build())
                                        .build()))
                                .build()))
                        .build())
                .build()))

        // the properties below are optional
        .artifactStore(ArtifactStoreProperty.builder()
                .location("location")
                .type("type")

                // the properties below are optional
                .encryptionKey(EncryptionKeyProperty.builder()
                        .id("id")
                        .type("type")
                        .build())
                .build())
        .artifactStores(List.of(ArtifactStoreMapProperty.builder()
                .artifactStore(ArtifactStoreProperty.builder()
                        .location("location")
                        .type("type")

                        // the properties below are optional
                        .encryptionKey(EncryptionKeyProperty.builder()
                                .id("id")
                                .type("type")
                                .build())
                        .build())
                .region("region")
                .build()))
        .disableInboundStageTransitions(List.of(StageTransitionProperty.builder()
                .reason("reason")
                .stageName("stageName")
                .build()))
        .executionMode("executionMode")
        .name("name")
        .pipelineType("pipelineType")
        .restartExecutionOnUpdate(false)
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .triggers(List.of(PipelineTriggerDeclarationProperty.builder()
                .providerType("providerType")

                // the properties below are optional
                .gitConfiguration(GitConfigurationProperty.builder()
                        .sourceActionName("sourceActionName")

                        // the properties below are optional
                        .pullRequest(List.of(GitPullRequestFilterProperty.builder()
                                .branches(GitBranchFilterCriteriaProperty.builder()
                                        .excludes(List.of("excludes"))
                                        .includes(List.of("includes"))
                                        .build())
                                .events(List.of("events"))
                                .filePaths(GitFilePathFilterCriteriaProperty.builder()
                                        .excludes(List.of("excludes"))
                                        .includes(List.of("includes"))
                                        .build())
                                .build()))
                        .push(List.of(GitPushFilterProperty.builder()
                                .branches(GitBranchFilterCriteriaProperty.builder()
                                        .excludes(List.of("excludes"))
                                        .includes(List.of("includes"))
                                        .build())
                                .filePaths(GitFilePathFilterCriteriaProperty.builder()
                                        .excludes(List.of("excludes"))
                                        .includes(List.of("includes"))
                                        .build())
                                .tags(GitTagFilterCriteriaProperty.builder()
                                        .excludes(List.of("excludes"))
                                        .includes(List.of("includes"))
                                        .build())
                                .build()))
                        .build())
                .build()))
        .variables(List.of(VariableDeclarationProperty.builder()
                .name("name")

                // the properties below are optional
                .defaultValue("defaultValue")
                .description("description")
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;

var configuration;

var cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
    RoleArn = "roleArn",
    Stages = new [] { new StageDeclarationProperty {
        Actions = new [] { new ActionDeclarationProperty {
            ActionTypeId = new ActionTypeIdProperty {
                Category = "category",
                Owner = "owner",
                Provider = "provider",
                Version = "version"
            },
            Name = "name",

            // the properties below are optional
            Commands = new [] { "commands" },
            Configuration = configuration,
            EnvironmentVariables = new [] { new EnvironmentVariableProperty {
                Name = "name",
                Value = "value",

                // the properties below are optional
                Type = "type"
            } },
            InputArtifacts = new [] { new InputArtifactProperty {
                Name = "name"
            } },
            Namespace = "namespace",
            OutputArtifacts = new [] { new OutputArtifactProperty {
                Name = "name",

                // the properties below are optional
                Files = new [] { "files" }
            } },
            OutputVariables = new [] { "outputVariables" },
            Region = "region",
            RoleArn = "roleArn",
            RunOrder = 123,
            TimeoutInMinutes = 123
        } },
        Name = "name",

        // the properties below are optional
        BeforeEntry = new BeforeEntryConditionsProperty {
            Conditions = new [] { new ConditionProperty {
                Result = "result",
                Rules = new [] { new RuleDeclarationProperty {
                    Commands = new [] { "commands" },
                    Configuration = configuration,
                    InputArtifacts = new [] { new InputArtifactProperty {
                        Name = "name"
                    } },
                    Name = "name",
                    Region = "region",
                    RoleArn = "roleArn",
                    RuleTypeId = new RuleTypeIdProperty {
                        Category = "category",
                        Owner = "owner",
                        Provider = "provider",
                        Version = "version"
                    }
                } }
            } }
        },
        Blockers = new [] { new BlockerDeclarationProperty {
            Name = "name",
            Type = "type"
        } },
        OnFailure = new FailureConditionsProperty {
            Conditions = new [] { new ConditionProperty {
                Result = "result",
                Rules = new [] { new RuleDeclarationProperty {
                    Commands = new [] { "commands" },
                    Configuration = configuration,
                    InputArtifacts = new [] { new InputArtifactProperty {
                        Name = "name"
                    } },
                    Name = "name",
                    Region = "region",
                    RoleArn = "roleArn",
                    RuleTypeId = new RuleTypeIdProperty {
                        Category = "category",
                        Owner = "owner",
                        Provider = "provider",
                        Version = "version"
                    }
                } }
            } },
            Result = "result",
            RetryConfiguration = new RetryConfigurationProperty {
                RetryMode = "retryMode"
            }
        },
        OnSuccess = new SuccessConditionsProperty {
            Conditions = new [] { new ConditionProperty {
                Result = "result",
                Rules = new [] { new RuleDeclarationProperty {
                    Commands = new [] { "commands" },
                    Configuration = configuration,
                    InputArtifacts = new [] { new InputArtifactProperty {
                        Name = "name"
                    } },
                    Name = "name",
                    Region = "region",
                    RoleArn = "roleArn",
                    RuleTypeId = new RuleTypeIdProperty {
                        Category = "category",
                        Owner = "owner",
                        Provider = "provider",
                        Version = "version"
                    }
                } }
            } }
        }
    } },

    // the properties below are optional
    ArtifactStore = new ArtifactStoreProperty {
        Location = "location",
        Type = "type",

        // the properties below are optional
        EncryptionKey = new EncryptionKeyProperty {
            Id = "id",
            Type = "type"
        }
    },
    ArtifactStores = new [] { new ArtifactStoreMapProperty {
        ArtifactStore = new ArtifactStoreProperty {
            Location = "location",
            Type = "type",

            // the properties below are optional
            EncryptionKey = new EncryptionKeyProperty {
                Id = "id",
                Type = "type"
            }
        },
        Region = "region"
    } },
    DisableInboundStageTransitions = new [] { new StageTransitionProperty {
        Reason = "reason",
        StageName = "stageName"
    } },
    ExecutionMode = "executionMode",
    Name = "name",
    PipelineType = "pipelineType",
    RestartExecutionOnUpdate = false,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Triggers = new [] { new PipelineTriggerDeclarationProperty {
        ProviderType = "providerType",

        // the properties below are optional
        GitConfiguration = new GitConfigurationProperty {
            SourceActionName = "sourceActionName",

            // the properties below are optional
            PullRequest = new [] { new GitPullRequestFilterProperty {
                Branches = new GitBranchFilterCriteriaProperty {
                    Excludes = new [] { "excludes" },
                    Includes = new [] { "includes" }
                },
                Events = new [] { "events" },
                FilePaths = new GitFilePathFilterCriteriaProperty {
                    Excludes = new [] { "excludes" },
                    Includes = new [] { "includes" }
                }
            } },
            Push = new [] { new GitPushFilterProperty {
                Branches = new GitBranchFilterCriteriaProperty {
                    Excludes = new [] { "excludes" },
                    Includes = new [] { "includes" }
                },
                FilePaths = new GitFilePathFilterCriteriaProperty {
                    Excludes = new [] { "excludes" },
                    Includes = new [] { "includes" }
                },
                Tags = new GitTagFilterCriteriaProperty {
                    Excludes = new [] { "excludes" },
                    Includes = new [] { "includes" }
                }
            } }
        }
    } },
    Variables = new [] { new VariableDeclarationProperty {
        Name = "name",

        // the properties below are optional
        DefaultValue = "defaultValue",
        Description = "description"
    } }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var configuration interface{}

cfnPipeline := awscdk.Aws_codepipeline.NewCfnPipeline(this, jsii.String("MyCfnPipeline"), &CfnPipelineProps{
	RoleArn: jsii.String("roleArn"),
	Stages: []interface{}{
		&StageDeclarationProperty{
			Actions: []interface{}{
				&ActionDeclarationProperty{
					ActionTypeId: &ActionTypeIdProperty{
						Category: jsii.String("category"),
						Owner: jsii.String("owner"),
						Provider: jsii.String("provider"),
						Version: jsii.String("version"),
					},
					Name: jsii.String("name"),

					// the properties below are optional
					Commands: []*string{
						jsii.String("commands"),
					},
					Configuration: configuration,
					EnvironmentVariables: []interface{}{
						&EnvironmentVariableProperty{
							Name: jsii.String("name"),
							Value: jsii.String("value"),

							// the properties below are optional
							Type: jsii.String("type"),
						},
					},
					InputArtifacts: []interface{}{
						&InputArtifactProperty{
							Name: jsii.String("name"),
						},
					},
					Namespace: jsii.String("namespace"),
					OutputArtifacts: []interface{}{
						&OutputArtifactProperty{
							Name: jsii.String("name"),

							// the properties below are optional
							Files: []*string{
								jsii.String("files"),
							},
						},
					},
					OutputVariables: []*string{
						jsii.String("outputVariables"),
					},
					Region: jsii.String("region"),
					RoleArn: jsii.String("roleArn"),
					RunOrder: jsii.Number(123),
					TimeoutInMinutes: jsii.Number(123),
				},
			},
			Name: jsii.String("name"),

			// the properties below are optional
			BeforeEntry: &BeforeEntryConditionsProperty{
				Conditions: []interface{}{
					&ConditionProperty{
						Result: jsii.String("result"),
						Rules: []interface{}{
							&RuleDeclarationProperty{
								Commands: []*string{
									jsii.String("commands"),
								},
								Configuration: configuration,
								InputArtifacts: []interface{}{
									&InputArtifactProperty{
										Name: jsii.String("name"),
									},
								},
								Name: jsii.String("name"),
								Region: jsii.String("region"),
								RoleArn: jsii.String("roleArn"),
								RuleTypeId: &RuleTypeIdProperty{
									Category: jsii.String("category"),
									Owner: jsii.String("owner"),
									Provider: jsii.String("provider"),
									Version: jsii.String("version"),
								},
							},
						},
					},
				},
			},
			Blockers: []interface{}{
				&BlockerDeclarationProperty{
					Name: jsii.String("name"),
					Type: jsii.String("type"),
				},
			},
			OnFailure: &FailureConditionsProperty{
				Conditions: []interface{}{
					&ConditionProperty{
						Result: jsii.String("result"),
						Rules: []interface{}{
							&RuleDeclarationProperty{
								Commands: []*string{
									jsii.String("commands"),
								},
								Configuration: configuration,
								InputArtifacts: []interface{}{
									&InputArtifactProperty{
										Name: jsii.String("name"),
									},
								},
								Name: jsii.String("name"),
								Region: jsii.String("region"),
								RoleArn: jsii.String("roleArn"),
								RuleTypeId: &RuleTypeIdProperty{
									Category: jsii.String("category"),
									Owner: jsii.String("owner"),
									Provider: jsii.String("provider"),
									Version: jsii.String("version"),
								},
							},
						},
					},
				},
				Result: jsii.String("result"),
				RetryConfiguration: &RetryConfigurationProperty{
					RetryMode: jsii.String("retryMode"),
				},
			},
			OnSuccess: &SuccessConditionsProperty{
				Conditions: []interface{}{
					&ConditionProperty{
						Result: jsii.String("result"),
						Rules: []interface{}{
							&RuleDeclarationProperty{
								Commands: []*string{
									jsii.String("commands"),
								},
								Configuration: configuration,
								InputArtifacts: []interface{}{
									&InputArtifactProperty{
										Name: jsii.String("name"),
									},
								},
								Name: jsii.String("name"),
								Region: jsii.String("region"),
								RoleArn: jsii.String("roleArn"),
								RuleTypeId: &RuleTypeIdProperty{
									Category: jsii.String("category"),
									Owner: jsii.String("owner"),
									Provider: jsii.String("provider"),
									Version: jsii.String("version"),
								},
							},
						},
					},
				},
			},
		},
	},

	// the properties below are optional
	ArtifactStore: &ArtifactStoreProperty{
		Location: jsii.String("location"),
		Type: jsii.String("type"),

		// the properties below are optional
		EncryptionKey: &EncryptionKeyProperty{
			Id: jsii.String("id"),
			Type: jsii.String("type"),
		},
	},
	ArtifactStores: []interface{}{
		&ArtifactStoreMapProperty{
			ArtifactStore: &ArtifactStoreProperty{
				Location: jsii.String("location"),
				Type: jsii.String("type"),

				// the properties below are optional
				EncryptionKey: &EncryptionKeyProperty{
					Id: jsii.String("id"),
					Type: jsii.String("type"),
				},
			},
			Region: jsii.String("region"),
		},
	},
	DisableInboundStageTransitions: []interface{}{
		&StageTransitionProperty{
			Reason: jsii.String("reason"),
			StageName: jsii.String("stageName"),
		},
	},
	ExecutionMode: jsii.String("executionMode"),
	Name: jsii.String("name"),
	PipelineType: jsii.String("pipelineType"),
	RestartExecutionOnUpdate: jsii.Boolean(false),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	Triggers: []interface{}{
		&PipelineTriggerDeclarationProperty{
			ProviderType: jsii.String("providerType"),

			// the properties below are optional
			GitConfiguration: &GitConfigurationProperty{
				SourceActionName: jsii.String("sourceActionName"),

				// the properties below are optional
				PullRequest: []interface{}{
					&GitPullRequestFilterProperty{
						Branches: &GitBranchFilterCriteriaProperty{
							Excludes: []*string{
								jsii.String("excludes"),
							},
							Includes: []*string{
								jsii.String("includes"),
							},
						},
						Events: []*string{
							jsii.String("events"),
						},
						FilePaths: &GitFilePathFilterCriteriaProperty{
							Excludes: []*string{
								jsii.String("excludes"),
							},
							Includes: []*string{
								jsii.String("includes"),
							},
						},
					},
				},
				Push: []interface{}{
					&GitPushFilterProperty{
						Branches: &GitBranchFilterCriteriaProperty{
							Excludes: []*string{
								jsii.String("excludes"),
							},
							Includes: []*string{
								jsii.String("includes"),
							},
						},
						FilePaths: &GitFilePathFilterCriteriaProperty{
							Excludes: []*string{
								jsii.String("excludes"),
							},
							Includes: []*string{
								jsii.String("includes"),
							},
						},
						Tags: &GitTagFilterCriteriaProperty{
							Excludes: []*string{
								jsii.String("excludes"),
							},
							Includes: []*string{
								jsii.String("includes"),
							},
						},
					},
				},
			},
		},
	},
	Variables: []interface{}{
		&VariableDeclarationProperty{
			Name: jsii.String("name"),

			// the properties below are optional
			DefaultValue: jsii.String("defaultValue"),
			Description: jsii.String("description"),
		},
	},
})

Initializer

new CfnPipeline(scope: Construct, id: string, props: CfnPipelineProps)

CfnPipeline(scope: Construct, id: str, props: CfnPipelineProps)

new CfnPipeline(Construct scope, String id, CfnPipelineProps props)

new CfnPipeline(Construct scope, string id, CfnPipelineProps props)

NewCfnPipeline(Scope Construct, Id *string, Props CfnPipelineProps)

Construct Props

artifactStore?optionalIResolvable | CfnPipeline.ArtifactStorePropertyartifact_store?optionaltyping.Union[IResolvable, ArtifactStoreProperty]artifactStore?optionalIResolvableArtifactStore?optionalIResolvableArtifactStore?optionalinterface{}#

The S3 bucket where artifacts for the pipeline are stored.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

artifactStores?optionalIResolvable | IResolvable | CfnPipeline.ArtifactStoreMapProperty[]artifact_stores?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ArtifactStoreMapProperty]]]artifactStores?optionalIResolvableArtifactStores?optionalIResolvableArtifactStores?optionalinterface{}#

A mapping of `artifactStore` objects and their corresponding AWS Regions.

notes

There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

disableInboundStageTransitions?optionalIResolvable | IResolvable | CfnPipeline.StageTransitionProperty[]disable_inbound_stage_transitions?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StageTransitionProperty]]]disableInboundStageTransitions?optionalIResolvableDisableInboundStageTransitions?optionalIResolvableDisableInboundStageTransitions?optionalinterface{}#

Represents the input of a `DisableStageTransition` action.

executionMode?optionalstringexecution_mode?optionalstrexecutionMode?optionalStringExecutionMode?optionalstringExecutionMode?optional*string= "SUPERSEDED"#

The method that the pipeline will use to handle multiple executions.

The default mode is SUPERSEDED.

name?optionalstringname?optionalstrname?optionalStringName?optionalstringName?optional*string#

The name of the pipeline.

pipelineType?optionalstringpipeline_type?optionalstrpipelineType?optionalStringPipelineType?optionalstringPipelineType?optional*string#

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

notes

• V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
• V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see Pricing .

For information about which type of pipeline to choose, see What type of pipeline is right for me? .

restartExecutionOnUpdate?optionalboolean | IResolvablerestart_execution_on_update?optionaltyping.Union[bool, IResolvable]restartExecutionOnUpdate?optionalBooleanRestartExecutionOnUpdate?optionalboolRestartExecutionOnUpdate?optionalinterface{}#

Indicates whether to rerun the CodePipeline pipeline after you update it.

roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}required#

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no `actionRoleArn` , or to use to assume roles for actions with an `actionRoleArn` .

stagesIResolvable | IResolvable | CfnPipeline.StageDeclarationProperty[]stagestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StageDeclarationProperty]]]stagesIResolvableStagesIResolvableStagesinterface{}required#

Represents information about a stage and its definition.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

Specifies the tags applied to the pipeline.

triggers?optionalIResolvable | IResolvable | CfnPipeline.PipelineTriggerDeclarationProperty[]triggers?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PipelineTriggerDeclarationProperty]]]triggers?optionalIResolvableTriggers?optionalIResolvableTriggers?optionalinterface{}#

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

variables?optionalIResolvable | IResolvable | CfnPipeline.VariableDeclarationProperty[]variables?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VariableDeclarationProperty]]]variables?optionalIResolvableVariables?optionalIResolvableVariables?optionalinterface{}#

A list that defines the pipeline variables for a pipeline resource.

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+ .

Properties

artifactStore?may be undefinedIResolvable | CfnPipeline.ArtifactStorePropertyartifact_store?may be undefinedtyping.Union[IResolvable, ArtifactStoreProperty]artifactStore?may be undefinedIResolvableArtifactStore?may be undefinedIResolvableArtifactStore?may be undefinedinterface{}#

The S3 bucket where artifacts for the pipeline are stored.

artifactStores?may be undefinedIResolvable | IResolvable | CfnPipeline.ArtifactStoreMapProperty[]artifact_stores?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ArtifactStoreMapProperty]]]artifactStores?may be undefinedIResolvableArtifactStores?may be undefinedIResolvableArtifactStores?may be undefinedinterface{}#

A mapping of `artifactStore` objects and their corresponding AWS Regions.

attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*stringrequired#

The Amazon Resource Name (ARN) of the pipeline.

attrVersionstringattr_versionstrattrVersionStringAttrVersionstringAttrVersion*stringrequired#

The version of the pipeline.

A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#

AWS resource type.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#

disableInboundStageTransitions?may be undefinedIResolvable | IResolvable | CfnPipeline.StageTransitionProperty[]disable_inbound_stage_transitions?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StageTransitionProperty]]]disableInboundStageTransitions?may be undefinedIResolvableDisableInboundStageTransitions?may be undefinedIResolvableDisableInboundStageTransitions?may be undefinedinterface{}#

Represents the input of a `DisableStageTransition` action.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

executionMode?may be undefinedstringexecution_mode?may be undefinedstrexecutionMode?may be undefinedStringExecutionMode?may be undefinedstringExecutionMode?may be undefined*string#

The method that the pipeline will use to handle multiple executions.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name?may be undefinedstringname?may be undefinedstrname?may be undefinedStringName?may be undefinedstringName?may be undefined*string#

The name of the pipeline.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

pipelineRefPipelineReferencepipeline_refPipelineReferencepipelineRefPipelineReferencePipelineRefPipelineReferencePipelineRefPipelineReferencerequired#

A reference to a Pipeline resource.

pipelineType?may be undefinedstringpipeline_type?may be undefinedstrpipelineType?may be undefinedStringPipelineType?may be undefinedstringPipelineType?may be undefined*string#

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

refstringrefstrrefStringRefstringRef*stringrequired#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

restartExecutionOnUpdate?may be undefinedboolean | IResolvablerestart_execution_on_update?may be undefinedtyping.Union[bool, IResolvable]restartExecutionOnUpdate?may be undefinedBooleanRestartExecutionOnUpdate?may be undefinedboolRestartExecutionOnUpdate?may be undefinedinterface{}#

Indicates whether to rerun the CodePipeline pipeline after you update it.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no `actionRoleArn` , or to use to assume roles for actions with an `actionRoleArn` .

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stagesIResolvable | IResolvable | CfnPipeline.StageDeclarationProperty[]stagestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StageDeclarationProperty]]]stagesIResolvableStagesIResolvableStagesinterface{}required#

Represents information about a stage and its definition.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefinedCfnTag[]tags_raw?may be undefinedtyping.List[CfnTag]tagsRaw?may be undefinedList<CfnTag>TagsRaw?may be undefinedCfnTag[]TagsRaw?may be undefined*[]CfnTag#

Specifies the tags applied to the pipeline.

triggers?may be undefinedIResolvable | IResolvable | CfnPipeline.PipelineTriggerDeclarationProperty[]triggers?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PipelineTriggerDeclarationProperty]]]triggers?may be undefinedIResolvableTriggers?may be undefinedIResolvableTriggers?may be undefinedinterface{}#

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

variables?may be undefinedIResolvable | IResolvable | CfnPipeline.VariableDeclarationProperty[]variables?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VariableDeclarationProperty]]]variables?may be undefinedIResolvableVariables?may be undefinedIResolvableVariables?may be undefinedinterface{}#

A list that defines the pipeline variables for a pipeline resource.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForPipeline(resource: IPipelineRef): string@staticmethod def arn_for_pipeline(resource: IPipelineRef) -> strpublic static String arnForPipeline(IPipelineRef resource)public static string ArnForPipeline(IPipelineRef resource)func ArnForPipeline(Resource IPipelineRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

fromPipelineArn(scope: Construct, id: string, arn: string): IPipelineRef@staticmethod def from_pipeline_arn(scope: Construct, id: str, arn: str) -> IPipelineRefpublic static IPipelineRef fromPipelineArn(Construct scope, String id, String arn)public static IPipelineRef FromPipelineArn(Construct scope, string id, string arn)func FromPipelineArn(Scope Construct, Id *string, Arn *string) IPipelineRefstatic#

Creates a new IPipelineRef from an ARN.

fromPipelineName(scope: Construct, id: string, pipelineName: string): IPipelineRef@staticmethod def from_pipeline_name(scope: Construct, id: str, pipeline_name: str) -> IPipelineRefpublic static IPipelineRef fromPipelineName(Construct scope, String id, String pipelineName)public static IPipelineRef FromPipelineName(Construct scope, string id, string pipelineName)func FromPipelineName(Scope Construct, Id *string, PipelineName *string) IPipelineRefstatic#

Creates a new IPipelineRef from a pipelineName.

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnPipeline(x: any): boolean@staticmethod def is_cfn_pipeline(x: Any) -> boolpublic static Boolean isCfnPipeline(Object x)public static bool IsCfnPipeline(object x)func IsCfnPipeline(X interface{}) *boolstatic#

Checks whether the given object is a CfnPipeline.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.