Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewPipelineDeployStackAction_Override ¶
func NewPipelineDeployStackAction_Override(p PipelineDeployStackAction, props *PipelineDeployStackActionProps)
Experimental.
Types ¶
type PipelineDeployStackAction ¶
type PipelineDeployStackAction interface {
awscodepipeline.IAction
ActionProperties() *awscodepipeline.ActionProperties
DeploymentRole() awsiam.IRole
AddToDeploymentRolePolicy(statement awsiam.PolicyStatement)
Bind(scope awscdk.Construct, stage awscodepipeline.IStage, options *awscodepipeline.ActionBindOptions) *awscodepipeline.ActionConfig
OnStateChange(name *string, target awsevents.IRuleTarget, options *awsevents.RuleProps) awsevents.Rule
}
A class to deploy a stack that is part of a CDK App, using CodePipeline.
This composite Action takes care of preparing and executing a CloudFormation ChangeSet.
It currently does *not* support stacks that make use of “Asset“s, and requires the deployed stack is in the same account and region where the CodePipeline is hosted. Experimental.
func NewPipelineDeployStackAction ¶
func NewPipelineDeployStackAction(props *PipelineDeployStackActionProps) PipelineDeployStackAction
Experimental.
type PipelineDeployStackActionProps ¶
type PipelineDeployStackActionProps struct {
// Whether to grant admin permissions to CloudFormation while deploying this template.
//
// Setting this to `true` affects the defaults for `role` and `capabilities`, if you
// don't specify any alternatives.
//
// The default role that will be created for you will have admin (i.e., `*`)
// permissions on all resources, and the deployment will have named IAM
// capabilities (i.e., able to create all IAM resources).
//
// This is a shorthand that you can use if you fully trust the templates that
// are deployed in this pipeline. If you want more fine-grained permissions,
// use `addToRolePolicy` and `capabilities` to control what the CloudFormation
// deployment is allowed to do.
// Experimental.
AdminPermissions *bool `json:"adminPermissions"`
// The CodePipeline artifact that holds the synthesized app, which is the contents of the “<directory>“ when running “cdk synth -o <directory>“.
// Experimental.
Input awscodepipeline.Artifact `json:"input"`
// The CDK stack to be deployed.
// Experimental.
Stack awscdk.Stack `json:"stack"`
// Acknowledge certain changes made as part of deployment.
//
// For stacks that contain certain resources, explicit acknowledgement that AWS CloudFormation
// might create or update those resources. For example, you must specify AnonymousIAM if your
// stack template contains AWS Identity and Access Management (IAM) resources. For more
// information
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities
//
// Experimental.
Capabilities *[]awscloudformation.CloudFormationCapabilities `json:"capabilities"`
// The name to use when creating a ChangeSet for the stack.
// Experimental.
ChangeSetName *string `json:"changeSetName"`
// The name of the CodePipeline action creating the ChangeSet.
// Experimental.
CreateChangeSetActionName *string `json:"createChangeSetActionName"`
// The runOrder for the CodePipeline action creating the ChangeSet.
// Experimental.
CreateChangeSetRunOrder *float64 `json:"createChangeSetRunOrder"`
// The name of the CodePipeline action creating the ChangeSet.
// Experimental.
ExecuteChangeSetActionName *string `json:"executeChangeSetActionName"`
// The runOrder for the CodePipeline action executing the ChangeSet.
// Experimental.
ExecuteChangeSetRunOrder *float64 `json:"executeChangeSetRunOrder"`
// IAM role to assume when deploying changes.
//
// If not specified, a fresh role is created. The role is created with zero
// permissions unless `adminPermissions` is true, in which case the role will have
// admin permissions.
// Experimental.
Role awsiam.IRole `json:"role"`
}
Experimental.
Click to show internal directories.
Click to hide internal directories.