{ "fingerprint": "W2a3umSdVt/+q/BjHU9q3iv7eBovPci1sOiX5wOoYXo=", "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-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" } }, "description": "Actions API for AWS Code Pipeline", "homepage": "https://github.com/awslabs/aws-cdk", "license": "Apache-2.0", "name": "@aws-cdk/aws-codepipeline-api", "readme": { "markdown": "## AWS CodePipeline Actions API\n\nThis package contains the abstract API of Pipeline Actions.\nIt's used by the `aws-codepipeline` module,\nand the AWS service modules that integrate with AWS CodePipeline.\n\nYou shoould never need to depend on it directly -\ninstead, depend on `aws-codepipeline`,\nand the module you need the concrete Actions from\n(like `aws-codecommit`, `aws-codebuild`, etc.).\n" }, "repository": { "type": "git", "url": "https://github.com/awslabs/aws-cdk.git" }, "schema": "jsii/1.0", "targets": { "java": { "maven": { "artifactId": "codepipeline-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codepipeline.api" }, "js": { "npm": "@aws-cdk/aws-codepipeline-api" } }, "types": { "@aws-cdk/aws-codepipeline-api.Action": { "abstract": true, "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/cdk.Construct" }, "docs": { "comment": "Low-level class for generic CodePipeline Actions.\nIt is recommended that concrete types are used instead, such as {@link codecommit.PipelineSource} or\n{@link codebuild.PipelineBuildAction}." }, "fqn": "@aws-cdk/aws-codepipeline-api.Action", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ActionProps" } } ] }, "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" } } }, { "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" } }, { "docs": { "comment": "Adds a child construct to this node." }, "name": "addChild", "parameters": [ { "name": "child", "type": { "fqn": "@aws-cdk/cdk.Construct" } }, { "name": "name", "type": { "primitive": "string" } } ], "protected": true }, { "name": "addOutputArtifact", "parameters": [ { "name": "name", "type": { "primitive": "string" } } ], "protected": true, "returns": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } }, { "name": "addInputArtifact", "parameters": [ { "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } } ], "protected": true, "returns": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" } } ], "name": "Action", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "docs": { "comment": "The category of the action.\nThe category defines which action type the owner\n(the entity that performs the action) performs." }, "immutable": true, "name": "category", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ActionCategory" } }, { "docs": { "comment": "The service provider that the action calls." }, "immutable": true, "name": "provider", "type": { "primitive": "string" } }, { "docs": { "comment": "The action's configuration. These are key-value pairs that specify input values for an action.\nFor more information, see the AWS CodePipeline User Guide.\n\nhttp://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements" }, "immutable": true, "name": "configuration", "type": { "optional": true, "primitive": "any" } }, { "docs": { "comment": "The order in which AWS CodePipeline runs this action.\nFor more information, see the AWS CodePipeline User Guide.\n\nhttps://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements" }, "name": "runOrder", "type": { "primitive": "number" } }, { "immutable": true, "name": "owner", "type": { "primitive": "string" } }, { "immutable": true, "name": "version", "type": { "primitive": "string" } }, { "immutable": true, "name": "inputArtifacts", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" }, "kind": "array" } } }, { "immutable": true, "name": "outputArtifacts", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" }, "kind": "array" } } } ] }, "@aws-cdk/aws-codepipeline-api.ActionArtifactBounds": { "assembly": "@aws-cdk/aws-codepipeline-api", "datatype": true, "docs": { "comment": "Specifies the constraints on the number of input and output\nartifacts an action can have.\n\nThe constraints for each action type are documented on the\n{@link https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html Pipeline Structure Reference} page." }, "fqn": "@aws-cdk/aws-codepipeline-api.ActionArtifactBounds", "kind": "interface", "name": "ActionArtifactBounds", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "immutable": true, "name": "minInputs", "type": { "primitive": "number" } }, { "immutable": true, "name": "maxInputs", "type": { "primitive": "number" } }, { "immutable": true, "name": "minOutputs", "type": { "primitive": "number" } }, { "immutable": true, "name": "maxOutputs", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-codepipeline-api.ActionCategory": { "assembly": "@aws-cdk/aws-codepipeline-api", "fqn": "@aws-cdk/aws-codepipeline-api.ActionCategory", "kind": "enum", "members": [ { "name": "Source" }, { "name": "Build" }, { "name": "Test" }, { "name": "Approval" }, { "name": "Deploy" }, { "name": "Invoke" } ], "name": "ActionCategory", "namespace": "@aws-cdk/aws-codepipeline-api" }, "@aws-cdk/aws-codepipeline-api.ActionProps": { "assembly": "@aws-cdk/aws-codepipeline-api", "datatype": true, "docs": { "comment": "Construction properties of the low-level {@link Action Action class}." }, "fqn": "@aws-cdk/aws-codepipeline-api.ActionProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "ActionProps", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "name": "category", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ActionCategory" } }, { "name": "provider", "type": { "primitive": "string" } }, { "name": "artifactBounds", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ActionArtifactBounds" } }, { "name": "configuration", "type": { "optional": true, "primitive": "any" } }, { "name": "version", "type": { "optional": true, "primitive": "string" } }, { "name": "owner", "type": { "optional": true, "primitive": "string" } } ] }, "@aws-cdk/aws-codepipeline-api.Artifact": { "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/cdk.Construct" }, "docs": { "comment": "An output artifact of an action. Artifacts can be used as input by some actions." }, "fqn": "@aws-cdk/aws-codepipeline-api.Artifact", "initializer": { "initializer": true, "parameters": [ { "name": "parent", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" } }, { "name": "name", "type": { "primitive": "string" } } ] }, "kind": "class", "methods": [ { "docs": { "comment": "Returns an ArtifactPath for a file within this artifact.\nOutput is in the form \"::\"" }, "name": "subartifact", "parameters": [ { "docs": { "comment": "The name of the file" }, "name": "fileName", "type": { "primitive": "string" } } ], "returns": { "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactPath" } }, { "docs": { "comment": "Returns a token for a value inside a JSON file within this artifact." }, "name": "getParam", "parameters": [ { "docs": { "comment": "The JSON file name." }, "name": "jsonFile", "type": { "primitive": "string" } }, { "docs": { "comment": "The hash key." }, "name": "keyName", "type": { "primitive": "string" } } ], "returns": { "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactGetParam" } }, { "docs": { "comment": "Returns a string representation of this construct." }, "name": "toString", "returns": { "primitive": "string" } } ], "name": "Artifact", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "immutable": true, "name": "name", "type": { "primitive": "string" } }, { "docs": { "comment": "The artifact attribute for the name of the S3 bucket where the artifact is stored." }, "immutable": true, "name": "bucketName", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactAttribute" } }, { "docs": { "comment": "The artifact attribute for The name of the .zip file that contains the artifact that is\ngenerated by AWS CodePipeline, such as 1ABCyZZ.zip." }, "immutable": true, "name": "objectKey", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactAttribute" } }, { "docs": { "comment": "The artifact attribute of the Amazon Simple Storage Service (Amazon S3) URL of the artifact,\nsuch as https://s3-us-west-2.amazonaws.com/artifactstorebucket-yivczw8jma0c/test/TemplateSo/1ABCyZZ.zip." }, "immutable": true, "name": "url", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactAttribute" } } ] }, "@aws-cdk/aws-codepipeline-api.ArtifactAttribute": { "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/cdk.Token" }, "docs": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html" }, "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactAttribute", "initializer": { "initializer": true, "parameters": [ { "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } }, { "name": "attributeName", "type": { "primitive": "string" } } ] }, "kind": "class", "name": "ArtifactAttribute", "namespace": "@aws-cdk/aws-codepipeline-api" }, "@aws-cdk/aws-codepipeline-api.ArtifactGetParam": { "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/cdk.Token" }, "docs": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html" }, "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactGetParam", "initializer": { "initializer": true, "parameters": [ { "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } }, { "name": "jsonFile", "type": { "primitive": "string" } }, { "name": "keyName", "type": { "primitive": "string" } } ] }, "kind": "class", "name": "ArtifactGetParam", "namespace": "@aws-cdk/aws-codepipeline-api" }, "@aws-cdk/aws-codepipeline-api.ArtifactPath": { "assembly": "@aws-cdk/aws-codepipeline-api", "docs": { "comment": "A specific file within an output artifact.\n\nThe most common use case for this is specifying the template file\nfor a CloudFormation action." }, "fqn": "@aws-cdk/aws-codepipeline-api.ArtifactPath", "initializer": { "initializer": true, "parameters": [ { "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } }, { "name": "fileName", "type": { "primitive": "string" } } ] }, "kind": "class", "name": "ArtifactPath", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "immutable": true, "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } }, { "immutable": true, "name": "fileName", "type": { "primitive": "string" } }, { "immutable": true, "name": "location", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-codepipeline-api.BuildAction": { "abstract": true, "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" }, "docs": { "comment": "Low level class for build actions.\nIt is recommended that concrete types are used instead,\nsuch as {@link codebuild.PipelineBuildAction}." }, "fqn": "@aws-cdk/aws-codepipeline-api.BuildAction", "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-api.BuildActionProps" } } ] }, "kind": "class", "name": "BuildAction", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "immutable": true, "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact", "optional": true } } ] }, "@aws-cdk/aws-codepipeline-api.BuildActionProps": { "assembly": "@aws-cdk/aws-codepipeline-api", "datatype": true, "docs": { "comment": "Construction properties of the low level {@link BuildAction build action}." }, "fqn": "@aws-cdk/aws-codepipeline-api.BuildActionProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "BuildActionProps", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "docs": { "comment": "The source to use as input for this build." }, "name": "inputArtifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } }, { "docs": { "comment": "The service provider that the action calls. For example, a valid provider for Source actions is CodeBuild." }, "name": "provider", "type": { "primitive": "string" } }, { "docs": { "comment": "The name of the build's output artifact." }, "name": "artifactName", "type": { "optional": true, "primitive": "string" } }, { "docs": { "comment": "The action's configuration. These are key-value pairs that specify input values for an action.\nFor more information, see the AWS CodePipeline User Guide.\n\nhttp://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements" }, "name": "configuration", "type": { "optional": true, "primitive": "any" } } ] }, "@aws-cdk/aws-codepipeline-api.CommonActionProps": { "assembly": "@aws-cdk/aws-codepipeline-api", "datatype": true, "docs": { "comment": "Common properties shared by all Actions." }, "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps", "kind": "interface", "name": "CommonActionProps", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "docs": { "comment": "The Pipeline Stage to add this Action to." }, "name": "stage", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.IStage" } } ] }, "@aws-cdk/aws-codepipeline-api.DeployAction": { "abstract": true, "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" }, "fqn": "@aws-cdk/aws-codepipeline-api.DeployAction", "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-api.DeployActionProps" } } ] }, "kind": "class", "name": "DeployAction", "namespace": "@aws-cdk/aws-codepipeline-api" }, "@aws-cdk/aws-codepipeline-api.DeployActionProps": { "assembly": "@aws-cdk/aws-codepipeline-api", "datatype": true, "fqn": "@aws-cdk/aws-codepipeline-api.DeployActionProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "DeployActionProps", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "name": "provider", "type": { "primitive": "string" } }, { "name": "artifactBounds", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.ActionArtifactBounds" } }, { "name": "configuration", "type": { "optional": true, "primitive": "any" } } ] }, "@aws-cdk/aws-codepipeline-api.IStage": { "assembly": "@aws-cdk/aws-codepipeline-api", "docs": { "comment": "The abstract interface of a Pipeline Stage that is used by Actions." }, "fqn": "@aws-cdk/aws-codepipeline-api.IStage", "kind": "interface", "methods": [ { "docs": { "comment": "Grants read & write permissions to the Pipeline's S3 Bucket to the given Identity." }, "name": "grantPipelineBucketReadWrite", "parameters": [ { "docs": { "comment": "the IAM Identity to grant the permissions to" }, "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } } ] } ], "name": "IStage", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "docs": { "comment": "The physical, human-readable name of this Pipeline Stage." }, "immutable": true, "name": "name", "type": { "primitive": "string" } }, { "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-api.SourceAction": { "abstract": true, "assembly": "@aws-cdk/aws-codepipeline-api", "base": { "fqn": "@aws-cdk/aws-codepipeline-api.Action" }, "docs": { "comment": "Low-level class for source actions.\nIt is recommended that concrete types are used instead,\nsuch as {@link codepipeline.AmazonS3Source} or\n{@link codecommit.PipelineSource}." }, "fqn": "@aws-cdk/aws-codepipeline-api.SourceAction", "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-api.SourceActionProps" } } ] }, "kind": "class", "name": "SourceAction", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "immutable": true, "name": "artifact", "type": { "fqn": "@aws-cdk/aws-codepipeline-api.Artifact" } } ] }, "@aws-cdk/aws-codepipeline-api.SourceActionProps": { "assembly": "@aws-cdk/aws-codepipeline-api", "datatype": true, "docs": { "comment": "Construction properties of the low-level {@link SourceAction source Action}." }, "fqn": "@aws-cdk/aws-codepipeline-api.SourceActionProps", "interfaces": [ { "fqn": "@aws-cdk/aws-codepipeline-api.CommonActionProps" } ], "kind": "interface", "name": "SourceActionProps", "namespace": "@aws-cdk/aws-codepipeline-api", "properties": [ { "docs": { "comment": "The source action owner (could be \"AWS\", \"ThirdParty\" or \"Custom\").", "default": "\"AWS\"" }, "name": "owner", "type": { "optional": true, "primitive": "string" } }, { "docs": { "comment": "The source action verison.", "default": "\"1\"" }, "name": "version", "type": { "optional": true, "primitive": "string" } }, { "docs": { "comment": "The name of the source's output artifact.\nOutput artifacts are used by CodePipeline as inputs into other actions." }, "name": "artifactName", "type": { "primitive": "string" } }, { "docs": { "comment": "The service provider that the action calls.\nFor example, a valid provider for Source actions is \"S3\"." }, "name": "provider", "type": { "primitive": "string" } }, { "docs": { "comment": "The action's configuration. These are key-value pairs that specify input values for an action.\nFor more information, see the AWS CodePipeline User Guide.\n\nhttp://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements" }, "name": "configuration", "type": { "optional": true, "primitive": "any" } } ] } }, "version": "0.8.2" }