awscodepipeline

package
v1.114.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 15, 2021 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnCustomActionType_CFN_RESOURCE_TYPE_NAME 

func CfnCustomActionType_CFN_RESOURCE_TYPE_NAME() *string

func CfnCustomActionType_IsCfnElement 

func CfnCustomActionType_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnCustomActionType_IsCfnResource 

func CfnCustomActionType_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnCustomActionType_IsConstruct 

func CfnCustomActionType_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPipeline_CFN_RESOURCE_TYPE_NAME 

func CfnPipeline_CFN_RESOURCE_TYPE_NAME() *string

func CfnPipeline_IsCfnElement 

func CfnPipeline_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPipeline_IsCfnResource 

func CfnPipeline_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPipeline_IsConstruct 

func CfnPipeline_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnWebhook_CFN_RESOURCE_TYPE_NAME 

func CfnWebhook_CFN_RESOURCE_TYPE_NAME() *string

func CfnWebhook_IsCfnElement 

func CfnWebhook_IsCfnElement(x interface{}) *bool

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: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnWebhook_IsCfnResource 

func CfnWebhook_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnWebhook_IsConstruct 

func CfnWebhook_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func GlobalVariables_ExecutionId 

func GlobalVariables_ExecutionId() *string

func NewAction_Override 

func NewAction_Override(a Action)

Experimental.

func NewArtifactPath_Override 

func NewArtifactPath_Override(a ArtifactPath, artifact Artifact, fileName *string)

Experimental.

func NewArtifact_Override 

func NewArtifact_Override(a Artifact, artifactName *string)

Experimental.

func NewCfnCustomActionType_Override 

func NewCfnCustomActionType_Override(c CfnCustomActionType, scope awscdk.Construct, id *string, props *CfnCustomActionTypeProps)

Create a new `AWS::CodePipeline::CustomActionType`.

func NewCfnPipeline_Override 

func NewCfnPipeline_Override(c CfnPipeline, scope awscdk.Construct, id *string, props *CfnPipelineProps)

Create a new `AWS::CodePipeline::Pipeline`.

func NewCfnWebhook_Override 

func NewCfnWebhook_Override(c CfnWebhook, scope awscdk.Construct, id *string, props *CfnWebhookProps)

Create a new `AWS::CodePipeline::Webhook`.

func NewGlobalVariables_Override 

func NewGlobalVariables_Override(g GlobalVariables)

Experimental.

func NewPipeline_Override 

func NewPipeline_Override(p Pipeline, scope constructs.Construct, id *string, props *PipelineProps)

Experimental.

func Pipeline_IsConstruct 

func Pipeline_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Pipeline_IsResource 

func Pipeline_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type Action 

type Action interface {
	IAction
	ActionProperties() *ActionProperties
	ProvidedActionProperties() *ActionProperties
	Bind(scope awscdk.Construct, stage IStage, options *ActionBindOptions) *ActionConfig
	Bound(scope awscdk.Construct, stage IStage, options *ActionBindOptions) *ActionConfig
	OnStateChange(name *string, target awsevents.IRuleTarget, options *awsevents.RuleProps) awsevents.Rule
	VariableExpression(variableName *string) *string
}

Low-level class for generic CodePipeline Actions implementing the {@link IAction} interface.

Contains some common logic that can be re-used by all {@link IAction} implementations. If you're writing your own Action class, feel free to extend this class. Experimental.

type ActionArtifactBounds 

type ActionArtifactBounds struct {
	// Experimental.
	MaxInputs *float64 `json:"maxInputs"`
	// Experimental.
	MaxOutputs *float64 `json:"maxOutputs"`
	// Experimental.
	MinInputs *float64 `json:"minInputs"`
	// Experimental.
	MinOutputs *float64 `json:"minOutputs"`
}

Specifies the constraints on the number of input and output artifacts an action can have.

The constraints for each action type are documented on the {@link https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html Pipeline Structure Reference} page. Experimental.

type ActionBindOptions 

type ActionBindOptions struct {
	// Experimental.
	Bucket awss3.IBucket `json:"bucket"`
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Experimental.

type ActionCategory 

type ActionCategory string

Experimental. 

const (
	ActionCategory_SOURCE   ActionCategory = "SOURCE"
	ActionCategory_BUILD    ActionCategory = "BUILD"
	ActionCategory_TEST     ActionCategory = "TEST"
	ActionCategory_APPROVAL ActionCategory = "APPROVAL"
	ActionCategory_DEPLOY   ActionCategory = "DEPLOY"
	ActionCategory_INVOKE   ActionCategory = "INVOKE"
)

type ActionConfig 

type ActionConfig struct {
	// Experimental.
	Configuration interface{} `json:"configuration"`
}

Experimental.

type ActionProperties 

type ActionProperties struct {
	// Experimental.
	ActionName *string `json:"actionName"`
	// Experimental.
	ArtifactBounds *ActionArtifactBounds `json:"artifactBounds"`
	// The category of the action.
	//
	// The category defines which action type the owner
	// (the entity that performs the action) performs.
	// Experimental.
	Category ActionCategory `json:"category"`
	// The service provider that the action calls.
	// Experimental.
	Provider *string `json:"provider"`
	// The account the Action is supposed to live in.
	//
	// For Actions backed by resources,
	// this is inferred from the Stack {@link resource} is part of.
	// However, some Actions, like the CloudFormation ones,
	// are not backed by any resource, and they still might want to be cross-account.
	// In general, a concrete Action class should specify either {@link resource},
	// or {@link account} - but not both.
	// Experimental.
	Account *string `json:"account"`
	// Experimental.
	Inputs *[]Artifact `json:"inputs"`
	// Experimental.
	Outputs *[]Artifact `json:"outputs"`
	// Experimental.
	Owner *string `json:"owner"`
	// The AWS region the given Action resides in.
	//
	// Note that a cross-region Pipeline requires replication buckets to function correctly.
	// You can provide their names with the {@link PipelineProps#crossRegionReplicationBuckets} property.
	// If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets,
	// that you will need to `cdk deploy` before deploying the main, Pipeline-containing Stack.
	// Experimental.
	Region *string `json:"region"`
	// The optional resource that is backing this Action.
	//
	// This is used for automatically handling Actions backed by
	// resources from a different account and/or region.
	// Experimental.
	Resource awscdk.IResource `json:"resource"`
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide.
	//
	// https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements
	// Experimental.
	RunOrder *float64 `json:"runOrder"`
	// The name of the namespace to use for variables emitted by this action.
	// Experimental.
	VariablesNamespace *string `json:"variablesNamespace"`
	// Experimental.
	Version *string `json:"version"`
}

Experimental.

type Artifact 

type Artifact interface {
	ArtifactName() *string
	BucketName() *string
	ObjectKey() *string
	S3Location() *awss3.Location
	Url() *string
	AtPath(fileName *string) ArtifactPath
	GetMetadata(key *string) interface{}
	GetParam(jsonFile *string, keyName *string) *string
	SetMetadata(key *string, value interface{})
	ToString() *string
}

An output artifact of an action.

Artifacts can be used as input by some actions. Experimental.

func Artifact_Artifact 

func Artifact_Artifact(name *string) Artifact

A static factory method used to create instances of the Artifact class.

Mainly meant to be used from `decdk`. Experimental.

func NewArtifact 

func NewArtifact(artifactName *string) Artifact

Experimental.

type ArtifactPath 

type ArtifactPath interface {
	Artifact() Artifact
	FileName() *string
	Location() *string
}

A specific file within an output artifact.

The most common use case for this is specifying the template file for a CloudFormation action. Experimental.

func ArtifactPath_ArtifactPath 

func ArtifactPath_ArtifactPath(artifactName *string, fileName *string) ArtifactPath

Experimental.

func NewArtifactPath 

func NewArtifactPath(artifact Artifact, fileName *string) ArtifactPath

Experimental.

type CfnCustomActionType 

type CfnCustomActionType interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Category() *string
	SetCategory(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConfigurationProperties() interface{}
	SetConfigurationProperties(val interface{})
	CreationStack() *[]*string
	InputArtifactDetails() interface{}
	SetInputArtifactDetails(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	OutputArtifactDetails() interface{}
	SetOutputArtifactDetails(val interface{})
	Provider() *string
	SetProvider(val *string)
	Ref() *string
	Settings() interface{}
	SetSettings(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Version() *string
	SetVersion(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodePipeline::CustomActionType`.

func NewCfnCustomActionType 

func NewCfnCustomActionType(scope awscdk.Construct, id *string, props *CfnCustomActionTypeProps) CfnCustomActionType

Create a new `AWS::CodePipeline::CustomActionType`.

type CfnCustomActionTypeProps 

type CfnCustomActionTypeProps struct {
	// `AWS::CodePipeline::CustomActionType.Category`.
	Category *string `json:"category"`
	// `AWS::CodePipeline::CustomActionType.InputArtifactDetails`.
	InputArtifactDetails interface{} `json:"inputArtifactDetails"`
	// `AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.
	OutputArtifactDetails interface{} `json:"outputArtifactDetails"`
	// `AWS::CodePipeline::CustomActionType.Provider`.
	Provider *string `json:"provider"`
	// `AWS::CodePipeline::CustomActionType.Version`.
	Version *string `json:"version"`
	// `AWS::CodePipeline::CustomActionType.ConfigurationProperties`.
	ConfigurationProperties interface{} `json:"configurationProperties"`
	// `AWS::CodePipeline::CustomActionType.Settings`.
	Settings interface{} `json:"settings"`
	// `AWS::CodePipeline::CustomActionType.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::CodePipeline::CustomActionType`.

type CfnCustomActionType_ArtifactDetailsProperty 

type CfnCustomActionType_ArtifactDetailsProperty struct {
	// `CfnCustomActionType.ArtifactDetailsProperty.MaximumCount`.
	MaximumCount *float64 `json:"maximumCount"`
	// `CfnCustomActionType.ArtifactDetailsProperty.MinimumCount`.
	MinimumCount *float64 `json:"minimumCount"`
}

type CfnCustomActionType_ConfigurationPropertiesProperty 

type CfnCustomActionType_ConfigurationPropertiesProperty struct {
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Key`.
	Key interface{} `json:"key"`
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Name`.
	Name *string `json:"name"`
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Required`.
	Required interface{} `json:"required"`
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Secret`.
	Secret interface{} `json:"secret"`
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Description`.
	Description *string `json:"description"`
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Queryable`.
	Queryable interface{} `json:"queryable"`
	// `CfnCustomActionType.ConfigurationPropertiesProperty.Type`.
	Type *string `json:"type"`
}

type CfnCustomActionType_SettingsProperty 

type CfnCustomActionType_SettingsProperty struct {
	// `CfnCustomActionType.SettingsProperty.EntityUrlTemplate`.
	EntityUrlTemplate *string `json:"entityUrlTemplate"`
	// `CfnCustomActionType.SettingsProperty.ExecutionUrlTemplate`.
	ExecutionUrlTemplate *string `json:"executionUrlTemplate"`
	// `CfnCustomActionType.SettingsProperty.RevisionUrlTemplate`.
	RevisionUrlTemplate *string `json:"revisionUrlTemplate"`
	// `CfnCustomActionType.SettingsProperty.ThirdPartyConfigurationUrl`.
	ThirdPartyConfigurationUrl *string `json:"thirdPartyConfigurationUrl"`
}

type CfnPipeline 

type CfnPipeline interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ArtifactStore() interface{}
	SetArtifactStore(val interface{})
	ArtifactStores() interface{}
	SetArtifactStores(val interface{})
	AttrVersion() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DisableInboundStageTransitions() interface{}
	SetDisableInboundStageTransitions(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	RestartExecutionOnUpdate() interface{}
	SetRestartExecutionOnUpdate(val interface{})
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Stages() interface{}
	SetStages(val interface{})
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodePipeline::Pipeline`.

func NewCfnPipeline 

func NewCfnPipeline(scope awscdk.Construct, id *string, props *CfnPipelineProps) CfnPipeline

Create a new `AWS::CodePipeline::Pipeline`.

type CfnPipelineProps 

type CfnPipelineProps struct {
	// `AWS::CodePipeline::Pipeline.RoleArn`.
	RoleArn *string `json:"roleArn"`
	// `AWS::CodePipeline::Pipeline.Stages`.
	Stages interface{} `json:"stages"`
	// `AWS::CodePipeline::Pipeline.ArtifactStore`.
	ArtifactStore interface{} `json:"artifactStore"`
	// `AWS::CodePipeline::Pipeline.ArtifactStores`.
	ArtifactStores interface{} `json:"artifactStores"`
	// `AWS::CodePipeline::Pipeline.DisableInboundStageTransitions`.
	DisableInboundStageTransitions interface{} `json:"disableInboundStageTransitions"`
	// `AWS::CodePipeline::Pipeline.Name`.
	Name *string `json:"name"`
	// `AWS::CodePipeline::Pipeline.RestartExecutionOnUpdate`.
	RestartExecutionOnUpdate interface{} `json:"restartExecutionOnUpdate"`
	// `AWS::CodePipeline::Pipeline.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::CodePipeline::Pipeline`.

type CfnPipeline_ActionDeclarationProperty 

type CfnPipeline_ActionDeclarationProperty struct {
	// `CfnPipeline.ActionDeclarationProperty.ActionTypeId`.
	ActionTypeId interface{} `json:"actionTypeId"`
	// `CfnPipeline.ActionDeclarationProperty.Name`.
	Name *string `json:"name"`
	// `CfnPipeline.ActionDeclarationProperty.Configuration`.
	Configuration interface{} `json:"configuration"`
	// `CfnPipeline.ActionDeclarationProperty.InputArtifacts`.
	InputArtifacts interface{} `json:"inputArtifacts"`
	// `CfnPipeline.ActionDeclarationProperty.Namespace`.
	Namespace *string `json:"namespace"`
	// `CfnPipeline.ActionDeclarationProperty.OutputArtifacts`.
	OutputArtifacts interface{} `json:"outputArtifacts"`
	// `CfnPipeline.ActionDeclarationProperty.Region`.
	Region *string `json:"region"`
	// `CfnPipeline.ActionDeclarationProperty.RoleArn`.
	RoleArn *string `json:"roleArn"`
	// `CfnPipeline.ActionDeclarationProperty.RunOrder`.
	RunOrder *float64 `json:"runOrder"`
}

type CfnPipeline_ActionTypeIdProperty 

type CfnPipeline_ActionTypeIdProperty struct {
	// `CfnPipeline.ActionTypeIdProperty.Category`.
	Category *string `json:"category"`
	// `CfnPipeline.ActionTypeIdProperty.Owner`.
	Owner *string `json:"owner"`
	// `CfnPipeline.ActionTypeIdProperty.Provider`.
	Provider *string `json:"provider"`
	// `CfnPipeline.ActionTypeIdProperty.Version`.
	Version *string `json:"version"`
}

type CfnPipeline_ArtifactStoreMapProperty 

type CfnPipeline_ArtifactStoreMapProperty struct {
	// `CfnPipeline.ArtifactStoreMapProperty.ArtifactStore`.
	ArtifactStore interface{} `json:"artifactStore"`
	// `CfnPipeline.ArtifactStoreMapProperty.Region`.
	Region *string `json:"region"`
}

type CfnPipeline_ArtifactStoreProperty 

type CfnPipeline_ArtifactStoreProperty struct {
	// `CfnPipeline.ArtifactStoreProperty.Location`.
	Location *string `json:"location"`
	// `CfnPipeline.ArtifactStoreProperty.Type`.
	Type *string `json:"type"`
	// `CfnPipeline.ArtifactStoreProperty.EncryptionKey`.
	EncryptionKey interface{} `json:"encryptionKey"`
}

type CfnPipeline_BlockerDeclarationProperty 

type CfnPipeline_BlockerDeclarationProperty struct {
	// `CfnPipeline.BlockerDeclarationProperty.Name`.
	Name *string `json:"name"`
	// `CfnPipeline.BlockerDeclarationProperty.Type`.
	Type *string `json:"type"`
}

type CfnPipeline_EncryptionKeyProperty 

type CfnPipeline_EncryptionKeyProperty struct {
	// `CfnPipeline.EncryptionKeyProperty.Id`.
	Id *string `json:"id"`
	// `CfnPipeline.EncryptionKeyProperty.Type`.
	Type *string `json:"type"`
}

type CfnPipeline_InputArtifactProperty 

type CfnPipeline_InputArtifactProperty struct {
	// `CfnPipeline.InputArtifactProperty.Name`.
	Name *string `json:"name"`
}

type CfnPipeline_OutputArtifactProperty 

type CfnPipeline_OutputArtifactProperty struct {
	// `CfnPipeline.OutputArtifactProperty.Name`.
	Name *string `json:"name"`
}

type CfnPipeline_StageDeclarationProperty 

type CfnPipeline_StageDeclarationProperty struct {
	// `CfnPipeline.StageDeclarationProperty.Actions`.
	Actions interface{} `json:"actions"`
	// `CfnPipeline.StageDeclarationProperty.Name`.
	Name *string `json:"name"`
	// `CfnPipeline.StageDeclarationProperty.Blockers`.
	Blockers interface{} `json:"blockers"`
}

type CfnPipeline_StageTransitionProperty 

type CfnPipeline_StageTransitionProperty struct {
	// `CfnPipeline.StageTransitionProperty.Reason`.
	Reason *string `json:"reason"`
	// `CfnPipeline.StageTransitionProperty.StageName`.
	StageName *string `json:"stageName"`
}

type CfnWebhook 

type CfnWebhook interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrUrl() *string
	Authentication() *string
	SetAuthentication(val *string)
	AuthenticationConfiguration() interface{}
	SetAuthenticationConfiguration(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Filters() interface{}
	SetFilters(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	RegisterWithThirdParty() interface{}
	SetRegisterWithThirdParty(val interface{})
	Stack() awscdk.Stack
	TargetAction() *string
	SetTargetAction(val *string)
	TargetPipeline() *string
	SetTargetPipeline(val *string)
	TargetPipelineVersion() *float64
	SetTargetPipelineVersion(val *float64)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodePipeline::Webhook`.

func NewCfnWebhook 

func NewCfnWebhook(scope awscdk.Construct, id *string, props *CfnWebhookProps) CfnWebhook

Create a new `AWS::CodePipeline::Webhook`.

type CfnWebhookProps 

type CfnWebhookProps struct {
	// `AWS::CodePipeline::Webhook.Authentication`.
	Authentication *string `json:"authentication"`
	// `AWS::CodePipeline::Webhook.AuthenticationConfiguration`.
	AuthenticationConfiguration interface{} `json:"authenticationConfiguration"`
	// `AWS::CodePipeline::Webhook.Filters`.
	Filters interface{} `json:"filters"`
	// `AWS::CodePipeline::Webhook.TargetAction`.
	TargetAction *string `json:"targetAction"`
	// `AWS::CodePipeline::Webhook.TargetPipeline`.
	TargetPipeline *string `json:"targetPipeline"`
	// `AWS::CodePipeline::Webhook.TargetPipelineVersion`.
	TargetPipelineVersion *float64 `json:"targetPipelineVersion"`
	// `AWS::CodePipeline::Webhook.Name`.
	Name *string `json:"name"`
	// `AWS::CodePipeline::Webhook.RegisterWithThirdParty`.
	RegisterWithThirdParty interface{} `json:"registerWithThirdParty"`
}

Properties for defining a `AWS::CodePipeline::Webhook`.

type CfnWebhook_WebhookAuthConfigurationProperty 

type CfnWebhook_WebhookAuthConfigurationProperty struct {
	// `CfnWebhook.WebhookAuthConfigurationProperty.AllowedIPRange`.
	AllowedIpRange *string `json:"allowedIpRange"`
	// `CfnWebhook.WebhookAuthConfigurationProperty.SecretToken`.
	SecretToken *string `json:"secretToken"`
}

type CfnWebhook_WebhookFilterRuleProperty 

type CfnWebhook_WebhookFilterRuleProperty struct {
	// `CfnWebhook.WebhookFilterRuleProperty.JsonPath`.
	JsonPath *string `json:"jsonPath"`
	// `CfnWebhook.WebhookFilterRuleProperty.MatchEquals`.
	MatchEquals *string `json:"matchEquals"`
}

type CommonActionProps 

type CommonActionProps struct {
	// The physical, human-readable name of the Action.
	//
	// Note that Action names must be unique within a single Stage.
	// Experimental.
	ActionName *string `json:"actionName"`
	// The runOrder property for this Action.
	//
	// RunOrder determines the relative order in which multiple Actions in the same Stage execute.
	// See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
	//
	// Experimental.
	RunOrder *float64 `json:"runOrder"`
	// The name of the namespace to use for variables emitted by this action.
	// Experimental.
	VariablesNamespace *string `json:"variablesNamespace"`
}

Common properties shared by all Actions. Experimental.

type CommonAwsActionProps 

type CommonAwsActionProps struct {
	// The physical, human-readable name of the Action.
	//
	// Note that Action names must be unique within a single Stage.
	// Experimental.
	ActionName *string `json:"actionName"`
	// The runOrder property for this Action.
	//
	// RunOrder determines the relative order in which multiple Actions in the same Stage execute.
	// See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
	//
	// Experimental.
	RunOrder *float64 `json:"runOrder"`
	// The name of the namespace to use for variables emitted by this action.
	// Experimental.
	VariablesNamespace *string `json:"variablesNamespace"`
	// The Role in which context's this Action will be executing in.
	//
	// The Pipeline's Role will assume this Role
	// (the required permissions for that will be granted automatically)
	// right before executing this Action.
	// This Action will be passed into your {@link IAction.bind}
	// method in the {@link ActionBindOptions.role} property.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Common properties shared by all Actions whose {@link ActionProperties.owner} field is 'AWS' (or unset, as 'AWS' is the default). Experimental.

type CrossRegionSupport 

type CrossRegionSupport struct {
	// The replication Bucket used by CodePipeline to operate in this region.
	//
	// Belongs to {@link stack}.
	// Experimental.
	ReplicationBucket awss3.IBucket `json:"replicationBucket"`
	// The Stack that has been created to house the replication Bucket required for this  region.
	// Experimental.
	Stack awscdk.Stack `json:"stack"`
}

An interface representing resources generated in order to support the cross-region capabilities of CodePipeline.

You get instances of this interface from the {@link Pipeline#crossRegionSupport} property. Experimental.

type GlobalVariables 

type GlobalVariables interface {
}

The CodePipeline variables that are global, not bound to a specific action.

This class defines a bunch of static fields that represent the different variables. These can be used can be used in any action configuration. Experimental.

func NewGlobalVariables 

func NewGlobalVariables() GlobalVariables

Experimental.

type IAction 

type IAction interface {
	// The callback invoked when this Action is added to a Pipeline.
	// Experimental.
	Bind(scope awscdk.Construct, stage IStage, options *ActionBindOptions) *ActionConfig
	// Creates an Event that will be triggered whenever the state of this Action changes.
	// Experimental.
	OnStateChange(name *string, target awsevents.IRuleTarget, options *awsevents.RuleProps) awsevents.Rule
	// The simple properties of the Action, like its Owner, name, etc.
	//
	// Note that this accessor will be called before the {@link bind} callback.
	// Experimental.
	ActionProperties() *ActionProperties
}

A Pipeline Action.

If you want to implement this interface, consider extending the {@link Action} class, which contains some common logic. Experimental.

type IPipeline 

type IPipeline interface {
	awscodestarnotifications.INotificationRuleSource
	awscdk.IResource
	// Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to `onEvent` API.
	//
	// You can also use the methods `notifyOnExecutionStateChange`, `notifyOnAnyStageStateChange`,
	// `notifyOnAnyActionStateChange` and `notifyOnAnyManualApprovalStateChange`
	// to define rules for these specific event emitted.
	//
	// Returns: CodeStar notification rule associated with this build project.
	// Experimental.
	NotifyOn(id *string, target awscodestarnotifications.INotificationRuleTarget, options *PipelineNotifyOnOptions) awscodestarnotifications.INotificationRule
	// Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline
	//
	// Experimental.
	NotifyOnAnyActionStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline
	//
	// Experimental.
	NotifyOnAnyManualApprovalStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline
	//
	// Experimental.
	NotifyOnAnyStageStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline
	//
	// Experimental.
	NotifyOnExecutionStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Define an event rule triggered by this CodePipeline.
	// Experimental.
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
	// Experimental.
	OnStateChange(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// The ARN of the Pipeline.
	// Experimental.
	PipelineArn() *string
	// The name of the Pipeline.
	// Experimental.
	PipelineName() *string
}

The abstract view of an AWS CodePipeline as required and used by Actions.

It extends {@link events.IRuleTarget}, so this interface can be used as a Target for CloudWatch Events. Experimental.

func Pipeline_FromPipelineArn 

func Pipeline_FromPipelineArn(scope constructs.Construct, id *string, pipelineArn *string) IPipeline

Import a pipeline into this app. Experimental.

type IStage 

type IStage interface {
	// Experimental.
	AddAction(action IAction)
	// Experimental.
	OnStateChange(name *string, target awsevents.IRuleTarget, options *awsevents.RuleProps) awsevents.Rule
	// The actions belonging to this stage.
	// Experimental.
	Actions() *[]IAction
	// Experimental.
	Pipeline() IPipeline
	// The physical, human-readable name of this Pipeline Stage.
	// Experimental.
	StageName() *string
}

The abstract interface of a Pipeline Stage that is used by Actions. Experimental.

type Pipeline 

type Pipeline interface {
	awscdk.Resource
	IPipeline
	ArtifactBucket() awss3.IBucket
	CrossRegionSupport() *map[string]*CrossRegionSupport
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	PipelineArn() *string
	PipelineName() *string
	PipelineVersion() *string
	Role() awsiam.IRole
	Stack() awscdk.Stack
	StageCount() *float64
	Stages() *[]IStage
	AddStage(props *StageOptions) IStage
	AddToRolePolicy(statement awsiam.PolicyStatement)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BindAsNotificationRuleSource(_scope constructs.Construct) *awscodestarnotifications.NotificationRuleSourceConfig
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	NotifyOn(id *string, target awscodestarnotifications.INotificationRuleTarget, options *PipelineNotifyOnOptions) awscodestarnotifications.INotificationRule
	NotifyOnAnyActionStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnAnyManualApprovalStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnAnyStageStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnExecutionStateChange(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnPrepare()
	OnStateChange(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Stage(stageName *string) IStage
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An AWS CodePipeline pipeline with its associated IAM role and S3 bucket.

TODO: EXAMPLE

Experimental.

func NewPipeline 

func NewPipeline(scope constructs.Construct, id *string, props *PipelineProps) Pipeline

Experimental.

type PipelineNotificationEvents 

type PipelineNotificationEvents string

The list of event types for AWS Codepipeline Pipeline. See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

Experimental. 

const (
	PipelineNotificationEvents_PIPELINE_EXECUTION_FAILED     PipelineNotificationEvents = "PIPELINE_EXECUTION_FAILED"
	PipelineNotificationEvents_PIPELINE_EXECUTION_CANCELED   PipelineNotificationEvents = "PIPELINE_EXECUTION_CANCELED"
	PipelineNotificationEvents_PIPELINE_EXECUTION_STARTED    PipelineNotificationEvents = "PIPELINE_EXECUTION_STARTED"
	PipelineNotificationEvents_PIPELINE_EXECUTION_RESUMED    PipelineNotificationEvents = "PIPELINE_EXECUTION_RESUMED"
	PipelineNotificationEvents_PIPELINE_EXECUTION_SUCCEEDED  PipelineNotificationEvents = "PIPELINE_EXECUTION_SUCCEEDED"
	PipelineNotificationEvents_PIPELINE_EXECUTION_SUPERSEDED PipelineNotificationEvents = "PIPELINE_EXECUTION_SUPERSEDED"
	PipelineNotificationEvents_STAGE_EXECUTION_STARTED       PipelineNotificationEvents = "STAGE_EXECUTION_STARTED"
	PipelineNotificationEvents_STAGE_EXECUTION_SUCCEEDED     PipelineNotificationEvents = "STAGE_EXECUTION_SUCCEEDED"
	PipelineNotificationEvents_STAGE_EXECUTION_RESUMED       PipelineNotificationEvents = "STAGE_EXECUTION_RESUMED"
	PipelineNotificationEvents_STAGE_EXECUTION_CANCELED      PipelineNotificationEvents = "STAGE_EXECUTION_CANCELED"
	PipelineNotificationEvents_STAGE_EXECUTION_FAILED        PipelineNotificationEvents = "STAGE_EXECUTION_FAILED"
	PipelineNotificationEvents_ACTION_EXECUTION_SUCCEEDED    PipelineNotificationEvents = "ACTION_EXECUTION_SUCCEEDED"
	PipelineNotificationEvents_ACTION_EXECUTION_FAILED       PipelineNotificationEvents = "ACTION_EXECUTION_FAILED"
	PipelineNotificationEvents_ACTION_EXECUTION_CANCELED     PipelineNotificationEvents = "ACTION_EXECUTION_CANCELED"
	PipelineNotificationEvents_ACTION_EXECUTION_STARTED      PipelineNotificationEvents = "ACTION_EXECUTION_STARTED"
	PipelineNotificationEvents_MANUAL_APPROVAL_FAILED        PipelineNotificationEvents = "MANUAL_APPROVAL_FAILED"
	PipelineNotificationEvents_MANUAL_APPROVAL_NEEDED        PipelineNotificationEvents = "MANUAL_APPROVAL_NEEDED"
	PipelineNotificationEvents_MANUAL_APPROVAL_SUCCEEDED     PipelineNotificationEvents = "MANUAL_APPROVAL_SUCCEEDED"
)

type PipelineNotifyOnOptions 

type PipelineNotifyOnOptions struct {
	// The level of detail to include in the notifications for this resource.
	//
	// BASIC will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
	// Experimental.
	DetailType awscodestarnotifications.DetailType `json:"detailType"`
	// The status of the notification rule.
	//
	// If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
	// Experimental.
	Enabled *bool `json:"enabled"`
	// The name for the notification rule.
	//
	// Notification rule names must be unique in your AWS account.
	// Experimental.
	NotificationRuleName *string `json:"notificationRuleName"`
	// A list of event types associated with this notification rule for CodePipeline Pipeline.
	//
	// For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api
	//
	// Experimental.
	Events *[]PipelineNotificationEvents `json:"events"`
}

Additional options to pass to the notification rule. Experimental.

type PipelineProps 

type PipelineProps struct {
	// The S3 bucket used by this Pipeline to store artifacts.
	// Experimental.
	ArtifactBucket awss3.IBucket `json:"artifactBucket"`
	// Create KMS keys for cross-account deployments.
	//
	// This controls whether the pipeline is enabled for cross-account deployments.
	//
	// By default cross-account deployments are enabled, but this feature requires
	// that KMS Customer Master Keys are created which have a cost of $1/month.
	//
	// If you do not need cross-account deployments, you can set this to `false` to
	// not create those keys and save on that cost (the artifact bucket will be
	// encrypted with an AWS-managed key). However, cross-account deployments will
	// no longer be possible.
	// Experimental.
	CrossAccountKeys *bool `json:"crossAccountKeys"`
	// A map of region to S3 bucket name used for cross-region CodePipeline.
	//
	// For every Action that you specify targeting a different region than the Pipeline itself,
	// if you don't provide an explicit Bucket for that region using this property,
	// the construct will automatically create a Stack containing an S3 Bucket in that region.
	// Experimental.
	CrossRegionReplicationBuckets *map[string]awss3.IBucket `json:"crossRegionReplicationBuckets"`
	// Name of the pipeline.
	// Experimental.
	PipelineName *string `json:"pipelineName"`
	// Indicates whether to rerun the AWS CodePipeline pipeline after you update it.
	// Experimental.
	RestartExecutionOnUpdate *bool `json:"restartExecutionOnUpdate"`
	// The IAM role to be assumed by this Pipeline.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The list of Stages, in order, to create this Pipeline with.
	//
	// You can always add more Stages later by calling {@link Pipeline#addStage}.
	// Experimental.
	Stages *[]*StageProps `json:"stages"`
}

Experimental.

type StageOptions 

type StageOptions struct {
	// The physical, human-readable name to assign to this Pipeline Stage.
	// Experimental.
	StageName *string `json:"stageName"`
	// The list of Actions to create this Stage with.
	//
	// You can always add more Actions later by calling {@link IStage#addAction}.
	// Experimental.
	Actions *[]IAction `json:"actions"`
	// Experimental.
	Placement *StagePlacement `json:"placement"`
}

Experimental.

type StagePlacement 

type StagePlacement struct {
	// Inserts the new Stage as a child of the given Stage (changing its current child Stage, if it had one).
	// Experimental.
	JustAfter IStage `json:"justAfter"`
	// Inserts the new Stage as a parent of the given Stage (changing its current parent Stage, if it had one).
	// Experimental.
	RightBefore IStage `json:"rightBefore"`
}

Allows you to control where to place a new Stage when it's added to the Pipeline.

Note that you can provide only one of the below properties - specifying more than one will result in a validation error. See: #justAfter

Experimental.

type StageProps 

type StageProps struct {
	// The physical, human-readable name to assign to this Pipeline Stage.
	// Experimental.
	StageName *string `json:"stageName"`
	// The list of Actions to create this Stage with.
	//
	// You can always add more Actions later by calling {@link IStage#addAction}.
	// Experimental.
	Actions *[]IAction `json:"actions"`
}

Construction properties of a Pipeline Stage. Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.