{ "fingerprint": "e5G5MZrGi9gUoE+b5NCFy1GdDZpcxfYA5dDYpA0AoGU=", "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "bundled": { "@aws-cdk/util": "^0.8.2" }, "dependencies": { "@aws-cdk/aws-codepipeline-api": { "dependencies": { "@aws-cdk/aws-events": { "dependencies": { "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" } }, "version": "0.8.2" }, "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "codepipeline-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codepipeline.api" }, "js": { "npm": "@aws-cdk/aws-codepipeline-api" } }, "version": "0.8.2" }, "@aws-cdk/aws-events": { "dependencies": { "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" } }, "version": "0.8.2" }, "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/aws-s3": { "dependencies": { "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/aws-kms": { "dependencies": { "@aws-cdk/aws-iam": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" } }, "version": "0.8.2" }, "@aws-cdk/aws-s3-notifications": { "dependencies": { "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "s3-notifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.notifications" }, "js": { "npm": "@aws-cdk/aws-s3-notifications" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" } }, "version": "0.8.2" }, "@aws-cdk/cdk": { "dependencies": { "@aws-cdk/cx-api": { "targets": { "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" } }, "version": "0.8.2" } }, "targets": { "java": { "maven": { "artifactId": "cdk", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "@aws-cdk/cdk" } }, "version": "0.8.2" } }, "description": "Better interface to AWS Code Pipeline", "homepage": "https://github.com/awslabs/aws-cdk", "license": "Apache-2.0", "name": "@aws-cdk/aws-codepipeline", "readme": { "markdown": "## AWS CodePipeline construct library\n\nConstruct an empty pipeline:\n\n```ts\nconst pipeline = new Pipeline(this, 'MyFirstPipeline', {\n pipelineName: 'MyFirstPipeline',\n});\n```\n\nAll of the components of a pipeline are modeled as constructs.\n\nAppend a stage to the pipeline:\n\n```ts\nconst sourceStage = new Stage(pipeline, 'Source');\n```\n\nAdd an action to a stage:\n\n```ts\nnew codecommit.PipelineSource(this, 'Source', {\n stage: sourceStage,\n artifactName: 'MyPackageSourceArtifact',\n repository: codecommit.RepositoryRef.import(this, 'MyExistingRepository', {\n repositoryName: new codecommit.RepositoryName('MyExistingRepository'),\n }),\n})\n```\n\n### Events\n\n#### Using a pipeline as an event target\n\nA pipeline can be used as a target for a CloudWatch event rule:\n\n```ts\n// kick off the pipeline every day\nconst rule = new EventRule(this, 'Daily', { scheduleExpression: 'rate(1 day)' });\nrule.addTarget(pipeline);\n```\n\nWhen a pipeline is used as an event target, the\n\"codepipeline:StartPipelineExecution\" permission is granted to the AWS\nCloudWatch Events service.\n\n#### Event sources\n\nPipelines emit CloudWatch events. To define event rules for events emitted by\nthe pipeline, stages or action, use the `onXxx` methods on the respective\nconstruct:\n\n```ts\nmyPipeline.onStateChange('MyPipelineStateChage', target);\nmyStage.onStateChange('MyStageStateChange', target);\nmyAction.onStateChange('MyActioStateChange', target);\n```\n" }, "repository": { "type": "git", "url": "https://github.com/awslabs/aws-cdk.git" }, "schema": "jsii/1.0", "targets": { "java": { "maven": { "artifactId": "codepipeline", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codepipeline" }, "js": { "npm": "@aws-cdk/aws-codepipeline" } }, "types": { "@aws-cdk/aws-codepipeline.AmazonS3Source": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/aws-codepipeline-api.SourceAction" }, "docs": { "comment": "Source that is provided by a specific Amazon S3 object." }, "fqn": "@aws-cdk/aws-codepipeline.AmazonS3Source", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-codepipeline.AmazonS3SourceProps" } } ] }, "kind": "class", "name": "AmazonS3Source", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.AmazonS3SourceProps": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "comment": "Construction properties of the {@link AmazonS3Source S3 source action}." }, "fqn": "@aws-cdk/aws-codepipeline.AmazonS3SourceProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "AmazonS3SourceProps", "namespace": "@aws-cdk/aws-codepipeline", "properties": [ { "docs": { "comment": "The name of the source's output artifact. Output artifacts are used by CodePipeline as\ninputs into other actions." }, "name": "artifactName", "type": { "primitive": "string" } }, { "docs": { "comment": "The Amazon S3 bucket that stores the source code" }, "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.BucketRef" } }, { "docs": { "comment": "The key within the S3 bucket that stores the source code" }, "name": "bucketKey", "type": { "primitive": "string" } }, { "docs": { "comment": "Whether or not AWS CodePipeline should poll for source changes", "default": "true" }, "name": "pollForSourceChanges", "type": { "optional": true, "primitive": "boolean" } } ] }, "@aws-cdk/aws-codepipeline.GitHubSource": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/aws-codepipeline-api.SourceAction" }, "docs": { "comment": "Source that is provided by a GitHub repository." }, "fqn": "@aws-cdk/aws-codepipeline.GitHubSource", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-codepipeline.GitHubSourceProps" } } ] }, "kind": "class", "name": "GitHubSource", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.GitHubSourceProps": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "comment": "Construction properties of the {@link GitHubSource GitHub source action}." }, "fqn": "@aws-cdk/aws-codepipeline.GitHubSourceProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "GitHubSourceProps", "namespace": "@aws-cdk/aws-codepipeline", "properties": [ { "docs": { "comment": "The name of the source's output artifact. Output artifacts are used by CodePipeline as\ninputs into other actions." }, "name": "artifactName", "type": { "primitive": "string" } }, { "docs": { "comment": "The GitHub account/user that owns the repo." }, "name": "owner", "type": { "primitive": "string" } }, { "docs": { "comment": "The name of the repo, without the username." }, "name": "repo", "type": { "primitive": "string" } }, { "docs": { "comment": "The branch to use.", "default": "\"master\"" }, "name": "branch", "type": { "optional": true, "primitive": "string" } }, { "docs": { "comment": "A GitHub OAuth token to use for authentication.\n\nIt is recommended to use a `SecretParameter` to obtain the token from the SSM\nParameter Store:\n\n const oauth = new SecretParameter(this, 'GitHubOAuthToken', { ssmParameter: 'my-github-token });\n new GitHubSource(stage, 'GH' { oauthToken: oauth });" }, "name": "oauthToken", "type": { "fqn": "@aws-cdk/cdk.Secret" } }, { "docs": { "comment": "Whether or not AWS CodePipeline should poll for source changes", "default": "true" }, "name": "pollForSourceChanges", "type": { "optional": true, "primitive": "boolean" } } ] }, "@aws-cdk/aws-codepipeline.ManualApprovalAction": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" }, "docs": { "comment": "Manual approval action." }, "fqn": "@aws-cdk/aws-codepipeline.ManualApprovalAction", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-codepipeline.ManualApprovalActionProps" } } ] }, "kind": "class", "name": "ManualApprovalAction", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.ManualApprovalActionProps": { "assembly": "@aws-cdk/aws-codepipeline", "fqn": "@aws-cdk/aws-codepipeline.ManualApprovalActionProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "ManualApprovalActionProps", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.Pipeline": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Construct" }, "docs": { "comment": "An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.", "example": "// create a pipeline\nconst pipeline = new Pipeline(this, 'Pipeline');\n\n// add a stage\nconst sourceStage = new Stage(pipeline, 'Source');\n\n// add a source action to the stage\nnew codecommit.PipelineSource(sourceStage, 'Source', {\nartifactName: 'SourceArtifact',\nrepository: repo,\n});\n\n// ... add more stages" }, "fqn": "@aws-cdk/aws-codepipeline.Pipeline", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-codepipeline.PipelineProps", "optional": true } } ] }, "interfaces": [ { "fqn": "@aws-cdk/aws-events.IEventRuleTarget" } ], "kind": "class", "methods": [ { "docs": { "comment": "Adds a statement to the pipeline role." }, "name": "addToRolePolicy", "parameters": [ { "name": "statement", "type": { "fqn": "@aws-cdk/cdk.PolicyStatement" } } ] }, { "docs": { "comment": "Allows the pipeline to be used as a CloudWatch event rule target.\n\nUsage:\n\n const pipeline = new Pipeline(this, 'MyPipeline');\n const rule = new EventRule(this, 'MyRule', { schedule: 'rate(1 minute)' });\n rule.addTarget(pipeline);" }, "name": "asEventRuleTarget", "parameters": [ { "name": "_ruleArn", "type": { "fqn": "@aws-cdk/aws-events.RuleArn" } }, { "name": "_ruleId", "type": { "primitive": "string" } } ], "returns": { "fqn": "@aws-cdk/aws-events.EventRuleTargetProps" } }, { "docs": { "comment": "Defines an event rule triggered by the \"CodePipeline Pipeline Execution\nState Change\" event emitted from this pipeline." }, "name": "onStateChange", "parameters": [ { "docs": { "comment": "The name of the event rule construct. If you wish to define\nmore than a single onStateChange event, you will need to explicitly\nspecify a name." }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "Initial target to add to the event rule. You can also add\ntargets and customize target inputs by calling `rule.addTarget(target[,\n * options])` after the rule was created." }, "name": "target", "type": { "fqn": "@aws-cdk/aws-events.IEventRuleTarget", "optional": true } }, { "docs": { "comment": "Additional options to pass to the event rule" }, "name": "options", "type": { "fqn": "@aws-cdk/aws-events.EventRuleProps", "optional": true } } ], "returns": { "fqn": "@aws-cdk/aws-events.EventRule" } }, { "docs": { "comment": "Validate the pipeline structure\n\nValidation happens according to the rules documented at\n\nhttps://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#pipeline-requirements", "override": "" }, "name": "validate", "returns": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "comment": "If a stage is added as a child, add it to the list of stages.\nTODO: This is a hack that should be removed once the CDK has an\n onChildAdded type hook.", "override": "" }, "name": "addChild", "parameters": [ { "name": "child", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } } ], "protected": true } ], "name": "Pipeline", "namespace": "@aws-cdk/aws-codepipeline", "properties": [ { "docs": { "comment": "The IAM role AWS CodePipeline will use to perform actions or assume roles for actions with\na more specific IAM role." }, "immutable": true, "name": "role", "type": { "fqn": "@aws-cdk/aws-iam.Role" } }, { "docs": { "comment": "ARN of this pipeline" }, "immutable": true, "name": "pipelineArn", "type": { "fqn": "@aws-cdk/aws-codepipeline.PipelineArn" } }, { "docs": { "comment": "The name of the pipeline" }, "immutable": true, "name": "pipelineName", "type": { "fqn": "@aws-cdk/aws-codepipeline.PipelineName" } }, { "docs": { "comment": "The version of the pipeline" }, "immutable": true, "name": "pipelineVersion", "type": { "fqn": "@aws-cdk/aws-codepipeline.PipelineVersion" } }, { "docs": { "comment": "Bucket used to store output artifacts" }, "immutable": true, "name": "artifactBucket", "type": { "fqn": "@aws-cdk/aws-s3.BucketRef" } } ] }, "@aws-cdk/aws-codepipeline.PipelineArn": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Arn" }, "docs": { "comment": "The ARN of a pipeline" }, "fqn": "@aws-cdk/aws-codepipeline.PipelineArn", "initializer": { "docs": { "comment": "Creates a token that resolves to `value`.\n\nIf value is a function, the function is evaluated upon resolution and\nthe value it returns will be used as the token's value.\n\ndisplayName is used to represent the Token when it's embedded into a string; it\nwill look something like this:\n\n \"embedded in a larger string is ${Token[DISPLAY_NAME.123]}\"\n\nThis value is used as a hint to humans what the meaning of the Token is,\nand does not have any effect on the evaluation.\n\nMust contain only alphanumeric and simple separator characters (_.:-)." }, "initializer": true, "parameters": [ { "docs": { "comment": "What this token will evaluate to, literal or function." }, "name": "valueOrFunction", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "A human-readable display hint for this Token" }, "name": "displayName", "type": { "optional": true, "primitive": "string" } } ] }, "kind": "class", "name": "PipelineArn", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.PipelineName": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Token" }, "docs": { "comment": "The name of the pipeline." }, "fqn": "@aws-cdk/aws-codepipeline.PipelineName", "initializer": { "docs": { "comment": "Creates a token that resolves to `value`.\n\nIf value is a function, the function is evaluated upon resolution and\nthe value it returns will be used as the token's value.\n\ndisplayName is used to represent the Token when it's embedded into a string; it\nwill look something like this:\n\n \"embedded in a larger string is ${Token[DISPLAY_NAME.123]}\"\n\nThis value is used as a hint to humans what the meaning of the Token is,\nand does not have any effect on the evaluation.\n\nMust contain only alphanumeric and simple separator characters (_.:-)." }, "initializer": true, "parameters": [ { "docs": { "comment": "What this token will evaluate to, literal or function." }, "name": "valueOrFunction", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "A human-readable display hint for this Token" }, "name": "displayName", "type": { "optional": true, "primitive": "string" } } ] }, "kind": "class", "name": "PipelineName", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.PipelineProps": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "fqn": "@aws-cdk/aws-codepipeline.PipelineProps", "kind": "interface", "name": "PipelineProps", "namespace": "@aws-cdk/aws-codepipeline", "properties": [ { "docs": { "comment": "The S3 bucket used by this Pipeline to store artifacts.\nIf not specified, a new S3 bucket will be created." }, "name": "artifactBucket", "type": { "fqn": "@aws-cdk/aws-s3.BucketRef", "optional": true } }, { "docs": { "comment": "Indicates whether to rerun the AWS CodePipeline pipeline after you update it." }, "name": "restartExecutionOnUpdate", "type": { "optional": true, "primitive": "boolean" } }, { "docs": { "comment": "Name of the pipeline. If you don't specify a name, AWS CloudFormation generates an ID\nand uses that for the pipeline name." }, "name": "pipelineName", "type": { "optional": true, "primitive": "string" } } ] }, "@aws-cdk/aws-codepipeline.PipelineVersion": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Token" }, "docs": { "comment": "The pipeline version." }, "fqn": "@aws-cdk/aws-codepipeline.PipelineVersion", "initializer": { "docs": { "comment": "Creates a token that resolves to `value`.\n\nIf value is a function, the function is evaluated upon resolution and\nthe value it returns will be used as the token's value.\n\ndisplayName is used to represent the Token when it's embedded into a string; it\nwill look something like this:\n\n \"embedded in a larger string is ${Token[DISPLAY_NAME.123]}\"\n\nThis value is used as a hint to humans what the meaning of the Token is,\nand does not have any effect on the evaluation.\n\nMust contain only alphanumeric and simple separator characters (_.:-)." }, "initializer": true, "parameters": [ { "docs": { "comment": "What this token will evaluate to, literal or function." }, "name": "valueOrFunction", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "A human-readable display hint for this Token" }, "name": "displayName", "type": { "optional": true, "primitive": "string" } } ] }, "kind": "class", "name": "PipelineVersion", "namespace": "@aws-cdk/aws-codepipeline" }, "@aws-cdk/aws-codepipeline.Stage": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Construct" }, "docs": { "comment": "A stage in a pipeline. Stages are added to a pipeline by constructing a Stage with\nthe pipeline as the first argument to the constructor.", "example": "// add a stage to a pipeline\nnew Stage(pipeline, 'MyStage');" }, "fqn": "@aws-cdk/aws-codepipeline.Stage", "initializer": { "docs": { "comment": "Append a new stage to the pipeline\n\nOnly a Pipeline can be passed in as a parent because stages should\nalways be attached to a pipeline. It's illogical to construct a Stage\nwith any other parent." }, "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/aws-codepipeline.Pipeline" } }, { "name": "name", "type": { "primitive": "string" } } ] }, "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.IStage" } ], "kind": "class", "methods": [ { "docs": { "comment": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis." }, "name": "validate", "returns": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "comment": "Grants read & write permissions to the Pipeline's S3 Bucket to the given Identity." }, "name": "grantPipelineBucketReadWrite", "parameters": [ { "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } } ] }, { "name": "render", "returns": { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageDeclarationProperty" } }, { "name": "onStateChange", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "target", "type": { "fqn": "@aws-cdk/aws-events.IEventRuleTarget", "optional": true } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-events.EventRuleProps", "optional": true } } ], "returns": { "fqn": "@aws-cdk/aws-events.EventRule" } } ], "name": "Stage", "namespace": "@aws-cdk/aws-codepipeline", "properties": [ { "docs": { "comment": "The Pipeline this stage is a member of" }, "immutable": true, "name": "pipeline", "type": { "fqn": "@aws-cdk/aws-codepipeline.Pipeline" } }, { "docs": { "comment": "The physical, human-readable name of this Pipeline Stage." }, "immutable": true, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "Get a duplicate of this stage's list of actions." }, "immutable": true, "name": "actions", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" }, "kind": "array" } } }, { "docs": { "comment": "The ARN of the Pipeline." }, "immutable": true, "name": "pipelineArn", "type": { "fqn": "@aws-cdk/cdk.Arn" } }, { "docs": { "comment": "The service Role of the Pipeline." }, "immutable": true, "name": "pipelineRole", "type": { "fqn": "@aws-cdk/aws-iam.Role" } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Resource" }, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "initializer": { "docs": { "comment": "Creates a new ``AWS::CodePipeline::CustomActionType``." }, "initializer": true, "parameters": [ { "docs": { "comment": "the ``cdk.Construct`` this ``CustomActionTypeResource`` is a part of" }, "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "docs": { "comment": "the name of the resource in the ``cdk.Construct`` tree" }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "the properties of this ``CustomActionTypeResource``" }, "name": "properties", "type": { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResourceProps" } } ] }, "kind": "class", "methods": [ { "name": "renderProperties", "protected": true, "returns": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "name": "CustomActionTypeResource", "namespace": "@aws-cdk/aws-codepipeline.cloudformation", "properties": [ { "const": true, "docs": { "comment": "The CloudFormation resource type name for this resource class." }, "immutable": true, "name": "resourceTypeName", "static": true, "type": { "primitive": "string" } } ], "subtypes": [ "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ArtifactDetailsProperty", "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ConfigurationPropertiesProperty", "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.SettingsProperty" ] }, "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ArtifactDetailsProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ArtifactDetailsProperty", "kind": "interface", "name": "ArtifactDetailsProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "properties": [ { "docs": { "comment": "``CustomActionTypeResource.ArtifactDetailsProperty.MaximumCount``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount" }, "name": "maximumCount", "type": { "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ArtifactDetailsProperty.MinimumCount``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount" }, "name": "minimumCount", "type": { "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ConfigurationPropertiesProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ConfigurationPropertiesProperty", "kind": "interface", "name": "ConfigurationPropertiesProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "properties": [ { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Description``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description" }, "name": "description", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Key``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key" }, "name": "key", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name" }, "name": "name", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Queryable``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable" }, "name": "queryable", "type": { "optional": true, "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Required``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required" }, "name": "required", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Secret``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret" }, "name": "secret", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.ConfigurationPropertiesProperty.Type``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type" }, "name": "type", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.SettingsProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.SettingsProperty", "kind": "interface", "name": "SettingsProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource", "properties": [ { "docs": { "comment": "``CustomActionTypeResource.SettingsProperty.EntityUrlTemplate``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate" }, "name": "entityUrlTemplate", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.SettingsProperty.ExecutionUrlTemplate``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate" }, "name": "executionUrlTemplate", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.SettingsProperty.RevisionUrlTemplate``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate" }, "name": "revisionUrlTemplate", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``CustomActionTypeResource.SettingsProperty.ThirdPartyConfigurationUrl``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl" }, "name": "thirdPartyConfigurationUrl", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResourceProps": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResourceProps", "kind": "interface", "name": "CustomActionTypeResourceProps", "namespace": "@aws-cdk/aws-codepipeline.cloudformation", "properties": [ { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.Category``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category" }, "name": "category", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.InputArtifactDetails``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails" }, "name": "inputArtifactDetails", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ArtifactDetailsProperty" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.OutputArtifactDetails``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails" }, "name": "outputArtifactDetails", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ArtifactDetailsProperty" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.Provider``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider" }, "name": "provider", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.ConfigurationProperties``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties" }, "name": "configurationProperties", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.ConfigurationPropertiesProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.Settings``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings" }, "name": "settings", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.CustomActionTypeResource.SettingsProperty" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::CustomActionType.Version``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version" }, "name": "version", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource": { "assembly": "@aws-cdk/aws-codepipeline", "base": { "fqn": "@aws-cdk/cdk.Resource" }, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "initializer": { "docs": { "comment": "Creates a new ``AWS::CodePipeline::Pipeline``." }, "initializer": true, "parameters": [ { "docs": { "comment": "the ``cdk.Construct`` this ``PipelineResource`` is a part of" }, "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "docs": { "comment": "the name of the resource in the ``cdk.Construct`` tree" }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "the properties of this ``PipelineResource``" }, "name": "properties", "type": { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResourceProps" } } ] }, "kind": "class", "methods": [ { "name": "renderProperties", "protected": true, "returns": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "name": "PipelineResource", "namespace": "@aws-cdk/aws-codepipeline.cloudformation", "properties": [ { "const": true, "docs": { "comment": "The CloudFormation resource type name for this resource class." }, "immutable": true, "name": "resourceTypeName", "static": true, "type": { "primitive": "string" } } ], "subtypes": [ "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionDeclarationProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionTypeIdProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ArtifactStoreProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.BlockerDeclarationProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.EncryptionKeyProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.InputArtifactProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.OutputArtifactProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageDeclarationProperty", "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageTransitionProperty" ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionDeclarationProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionDeclarationProperty", "kind": "interface", "name": "ActionDeclarationProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.ActionTypeId``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid" }, "name": "actionTypeId", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionTypeIdProperty" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.Configuration``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration" }, "name": "configuration", "type": { "optional": true, "union": { "types": [ { "primitive": "json" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.InputArtifacts``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts" }, "name": "inputArtifacts", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.InputArtifactProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name" }, "name": "name", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.OutputArtifacts``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts" }, "name": "outputArtifacts", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.OutputArtifactProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.RoleArn``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn" }, "name": "roleArn", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionDeclarationProperty.RunOrder``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder" }, "name": "runOrder", "type": { "optional": true, "union": { "types": [ { "primitive": "number" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionTypeIdProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionTypeIdProperty", "kind": "interface", "name": "ActionTypeIdProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.ActionTypeIdProperty.Category``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category" }, "name": "category", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionTypeIdProperty.Owner``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner" }, "name": "owner", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionTypeIdProperty.Provider``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider" }, "name": "provider", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ActionTypeIdProperty.Version``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-version" }, "name": "version", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ArtifactStoreProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ArtifactStoreProperty", "kind": "interface", "name": "ArtifactStoreProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.ArtifactStoreProperty.EncryptionKey``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey" }, "name": "encryptionKey", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.EncryptionKeyProperty" } ] } } }, { "docs": { "comment": "``PipelineResource.ArtifactStoreProperty.Location``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location" }, "name": "location", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.ArtifactStoreProperty.Type``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type" }, "name": "type", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.BlockerDeclarationProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.BlockerDeclarationProperty", "kind": "interface", "name": "BlockerDeclarationProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.BlockerDeclarationProperty.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-name" }, "name": "name", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.BlockerDeclarationProperty.Type``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-type" }, "name": "type", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.EncryptionKeyProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.EncryptionKeyProperty", "kind": "interface", "name": "EncryptionKeyProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.EncryptionKeyProperty.Id``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id" }, "name": "id", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.EncryptionKeyProperty.Type``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type" }, "name": "type", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.InputArtifactProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.InputArtifactProperty", "kind": "interface", "name": "InputArtifactProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.InputArtifactProperty.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name" }, "name": "name", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.OutputArtifactProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.OutputArtifactProperty", "kind": "interface", "name": "OutputArtifactProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.OutputArtifactProperty.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts-name" }, "name": "name", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageDeclarationProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageDeclarationProperty", "kind": "interface", "name": "StageDeclarationProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.StageDeclarationProperty.Actions``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-actions" }, "name": "actions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ActionDeclarationProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``PipelineResource.StageDeclarationProperty.Blockers``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-blockers" }, "name": "blockers", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.BlockerDeclarationProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``PipelineResource.StageDeclarationProperty.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-name" }, "name": "name", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageTransitionProperty": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageTransitionProperty", "kind": "interface", "name": "StageTransitionProperty", "namespace": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "parenttype": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource", "properties": [ { "docs": { "comment": "``PipelineResource.StageTransitionProperty.Reason``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason" }, "name": "reason", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``PipelineResource.StageTransitionProperty.StageName``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-stagename" }, "name": "stageName", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] }, "@aws-cdk/aws-codepipeline.cloudformation.PipelineResourceProps": { "assembly": "@aws-cdk/aws-codepipeline", "datatype": true, "docs": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html" }, "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResourceProps", "kind": "interface", "name": "PipelineResourceProps", "namespace": "@aws-cdk/aws-codepipeline.cloudformation", "properties": [ { "docs": { "comment": "``AWS::CodePipeline::Pipeline.ArtifactStore``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore" }, "name": "artifactStore", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.ArtifactStoreProperty" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::Pipeline.RoleArn``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn" }, "name": "roleArn", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::Pipeline.Stages``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages" }, "name": "stages", "type": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageDeclarationProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::Pipeline.DisableInboundStageTransitions``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions" }, "name": "disableInboundStageTransitions", "type": { "optional": true, "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/cdk.Token" }, { "fqn": "@aws-cdk/aws-codepipeline.cloudformation.PipelineResource.StageTransitionProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::Pipeline.Name``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name" }, "name": "pipelineName", "type": { "optional": true, "union": { "types": [ { "primitive": "string" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } }, { "docs": { "comment": "``AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate``", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate" }, "name": "restartExecutionOnUpdate", "type": { "optional": true, "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/cdk.Token" } ] } } } ] } }, "version": "0.8.2" }