Class: AWSCDK::Codepipeline::CfnPipeline

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCodepipeline::IPipelineRef
Defined in:
codepipeline/cfn_pipeline.rb

Overview

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

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

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPipeline

Create a new AWS::CodePipeline::Pipeline.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Codepipeline::CfnPipelineProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'codepipeline/cfn_pipeline.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnPipelineProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_pipeline(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'codepipeline/cfn_pipeline.rb', line 87

def self.arn_for_pipeline(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2RlcGlwZWxpbmUuSVBpcGVsaW5lUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codepipeline.CfnPipeline", "arnForPipeline", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


207
208
209
 
# File 'codepipeline/cfn_pipeline.rb', line 207

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_codepipeline.CfnPipeline", "CFN_RESOURCE_TYPE_NAME")
end

.from_pipeline_name(scope, id, pipeline_name) ⇒ AWSCDK::Interfaces::AWSCodepipeline::IPipelineRef

Creates a new IPipelineRef from a pipelineName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • pipeline_name (String)

Returns:



98
99
100
101
102
103
 
# File 'codepipeline/cfn_pipeline.rb', line 98

def self.from_pipeline_name(scope, id, pipeline_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(pipeline_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codepipeline.CfnPipeline", "fromPipelineName", [scope, id, pipeline_name])
end

.is_cfn_pipeline(x) ⇒ Boolean

Checks whether the given object is a CfnPipeline.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


109
110
111
112
 
# File 'codepipeline/cfn_pipeline.rb', line 109

def self.is_cfn_pipeline(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codepipeline.CfnPipeline", "isCfnPipeline", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'codepipeline/cfn_pipeline.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :pipeline_ref => { kind: :property, name: "pipelineRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :stages => { kind: :property, name: "stages", is_optional: false },
    :artifact_store => { kind: :property, name: "artifactStore", is_optional: true },
    :artifact_stores => { kind: :property, name: "artifactStores", is_optional: true },
    :disable_inbound_stage_transitions => { kind: :property, name: "disableInboundStageTransitions", is_optional: true },
    :execution_mode => { kind: :property, name: "executionMode", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :pipeline_type => { kind: :property, name: "pipelineType", is_optional: true },
    :restart_execution_on_update => { kind: :property, name: "restartExecutionOnUpdate", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :triggers => { kind: :property, name: "triggers", is_optional: true },
    :variables => { kind: :property, name: "variables", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



416
417
418
419
 
# File 'codepipeline/cfn_pipeline.rb', line 416

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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

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

Parameters:



428
429
430
431
 
# File 'codepipeline/cfn_pipeline.rb', line 428

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

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

Parameters:



438
439
440
441
 
# File 'codepipeline/cfn_pipeline.rb', line 438

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



449
450
451
452
453
 
# File 'codepipeline/cfn_pipeline.rb', line 449

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

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

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

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

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

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

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

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


506
507
508
509
510
 
# File 'codepipeline/cfn_pipeline.rb', line 506

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

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

Parameters:

  • property_path (String) —

    The path to the property.



516
517
518
519
 
# File 'codepipeline/cfn_pipeline.rb', line 516

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

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

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



528
529
530
531
532
 
# File 'codepipeline/cfn_pipeline.rb', line 528

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

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

Parameters:



541
542
543
544
 
# File 'codepipeline/cfn_pipeline.rb', line 541

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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

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

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

Parameters:

See Also:



563
564
565
566
567
568
 
# File 'codepipeline/cfn_pipeline.rb', line 563

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#artifact_store ⇒ AWSCDK::IResolvable, ...

The S3 bucket where artifacts for the pipeline are stored.

Returns:



261
262
263
 
# File 'codepipeline/cfn_pipeline.rb', line 261

def artifact_store()
  jsii_get_property("artifactStore")
end

#artifact_store=(value) ⇒ Object 



265
266
267
268
269
 
# File 'codepipeline/cfn_pipeline.rb', line 265

def artifact_store=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnPipeline::ArtifactStoreProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuUGlwZWxpbmUuQXJ0aWZhY3RTdG9yZVByb3BlcnR5In1dfX0=")), "artifactStore") unless value.nil?
  jsii_set_property("artifactStore", value)
end

#artifact_stores ⇒ AWSCDK::IResolvable, ...

A mapping of artifactStore objects and their corresponding AWS Regions.

Returns:



274
275
276
 
# File 'codepipeline/cfn_pipeline.rb', line 274

def artifact_stores()
  jsii_get_property("artifactStores")
end

#artifact_stores=(value) ⇒ Object 



278
279
280
281
 
# File 'codepipeline/cfn_pipeline.rb', line 278

def artifact_stores=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLkFydGlmYWN0U3RvcmVNYXBQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "artifactStores") unless value.nil?
  jsii_set_property("artifactStores", value)
end

#attr_version ⇒ String

The version of the pipeline.

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

Returns:

  • (String) 


216
217
218
 
# File 'codepipeline/cfn_pipeline.rb', line 216

def attr_version()
  jsii_get_property("attrVersion")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



160
161
162
 
# File 'codepipeline/cfn_pipeline.rb', line 160

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


165
166
167
 
# File 'codepipeline/cfn_pipeline.rb', line 165

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


572
573
574
575
 
# File 'codepipeline/cfn_pipeline.rb', line 572

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


170
171
172
 
# File 'codepipeline/cfn_pipeline.rb', line 170

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


177
178
179
 
# File 'codepipeline/cfn_pipeline.rb', line 177

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


122
123
124
 
# File 'codepipeline/cfn_pipeline.rb', line 122

def creation_stack()
  jsii_get_property("creationStack")
end

#disable_inbound_stage_transitions ⇒ AWSCDK::IResolvable, ...

Represents the input of a DisableStageTransition action.

Returns:



286
287
288
 
# File 'codepipeline/cfn_pipeline.rb', line 286

def disable_inbound_stage_transitions()
  jsii_get_property("disableInboundStageTransitions")
end

#disable_inbound_stage_transitions=(value) ⇒ Object 



290
291
292
293
 
# File 'codepipeline/cfn_pipeline.rb', line 290

def disable_inbound_stage_transitions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLlN0YWdlVHJhbnNpdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "disableInboundStageTransitions") unless value.nil?
  jsii_set_property("disableInboundStageTransitions", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



182
183
184
 
# File 'codepipeline/cfn_pipeline.rb', line 182

def env()
  jsii_get_property("env")
end

#execution_mode ⇒ String?

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

Returns:

  • (String, nil) 


298
299
300
 
# File 'codepipeline/cfn_pipeline.rb', line 298

def execution_mode()
  jsii_get_property("executionMode")
end

#execution_mode=(value) ⇒ Object 



302
303
304
305
 
# File 'codepipeline/cfn_pipeline.rb', line 302

def execution_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionMode") unless value.nil?
  jsii_set_property("executionMode", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

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

Parameters:

Returns:



585
586
587
588
589
 
# File 'codepipeline/cfn_pipeline.rb', line 585

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



596
597
598
599
 
# File 'codepipeline/cfn_pipeline.rb', line 596

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



666
667
668
669
 
# File 'codepipeline/cfn_pipeline.rb', line 666

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


134
135
136
 
# File 'codepipeline/cfn_pipeline.rb', line 134

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the pipeline.

Returns:

  • (String, nil) 


310
311
312
 
# File 'codepipeline/cfn_pipeline.rb', line 310

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



314
315
316
317
 
# File 'codepipeline/cfn_pipeline.rb', line 314

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


117
118
119
 
# File 'codepipeline/cfn_pipeline.rb', line 117

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



607
608
609
 
# File 'codepipeline/cfn_pipeline.rb', line 607

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



614
615
616
 
# File 'codepipeline/cfn_pipeline.rb', line 614

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



407
408
409
410
 
# File 'codepipeline/cfn_pipeline.rb', line 407

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#pipeline_ref ⇒ AWSCDK::Interfaces::AWSCodepipeline::PipelineReference

A reference to a Pipeline resource.

Returns:



223
224
225
 
# File 'codepipeline/cfn_pipeline.rb', line 223

def pipeline_ref()
  jsii_get_property("pipelineRef")
end

#pipeline_type ⇒ String?

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

Returns:

  • (String, nil) 


322
323
324
 
# File 'codepipeline/cfn_pipeline.rb', line 322

def pipeline_type()
  jsii_get_property("pipelineType")
end

#pipeline_type=(value) ⇒ Object 



326
327
328
329
 
# File 'codepipeline/cfn_pipeline.rb', line 326

def pipeline_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineType") unless value.nil?
  jsii_set_property("pipelineType", value)
end

#ref ⇒ String

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

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

Returns:

  • (String) 


153
154
155
 
# File 'codepipeline/cfn_pipeline.rb', line 153

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

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

Parameters:



625
626
627
628
 
# File 'codepipeline/cfn_pipeline.rb', line 625

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


632
633
634
635
 
# File 'codepipeline/cfn_pipeline.rb', line 632

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



642
643
644
645
646
 
# File 'codepipeline/cfn_pipeline.rb', line 642

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#restart_execution_on_update ⇒ Boolean, ...

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

Returns:



334
335
336
 
# File 'codepipeline/cfn_pipeline.rb', line 334

def restart_execution_on_update()
  jsii_get_property("restartExecutionOnUpdate")
end

#restart_execution_on_update=(value) ⇒ Object 



338
339
340
341
 
# File 'codepipeline/cfn_pipeline.rb', line 338

def restart_execution_on_update=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "restartExecutionOnUpdate") unless value.nil?
  jsii_set_property("restartExecutionOnUpdate", value)
end

#role_arn ⇒ String

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

Returns:

  • (String) 


237
238
239
 
# File 'codepipeline/cfn_pipeline.rb', line 237

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



241
242
243
244
 
# File 'codepipeline/cfn_pipeline.rb', line 241

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



651
652
653
 
# File 'codepipeline/cfn_pipeline.rb', line 651

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



143
144
145
 
# File 'codepipeline/cfn_pipeline.rb', line 143

def stack()
  jsii_get_property("stack")
end

#stages ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Codepipeline::CfnPipeline::StageDeclarationProperty>

Represents information about a stage and its definition.

Returns:



249
250
251
 
# File 'codepipeline/cfn_pipeline.rb', line 249

def stages()
  jsii_get_property("stages")
end

#stages=(value) ⇒ Object 



253
254
255
256
 
# File 'codepipeline/cfn_pipeline.rb', line 253

def stages=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLlN0YWdlRGVjbGFyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "stages")
  jsii_set_property("stages", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



230
231
232
 
# File 'codepipeline/cfn_pipeline.rb', line 230

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Specifies the tags applied to the pipeline.

Returns:



346
347
348
 
# File 'codepipeline/cfn_pipeline.rb', line 346

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



350
351
352
353
354
 
# File 'codepipeline/cfn_pipeline.rb', line 350

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



383
384
385
 
# File 'codepipeline/cfn_pipeline.rb', line 383

def to_string()
  jsii_call_method("toString", [])
end

#triggers ⇒ AWSCDK::IResolvable, ...

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

Returns:



359
360
361
 
# File 'codepipeline/cfn_pipeline.rb', line 359

def triggers()
  jsii_get_property("triggers")
end

#triggers=(value) ⇒ Object 



363
364
365
366
 
# File 'codepipeline/cfn_pipeline.rb', line 363

def triggers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLlBpcGVsaW5lVHJpZ2dlckRlY2xhcmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "triggers") unless value.nil?
  jsii_set_property("triggers", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


190
191
192
 
# File 'codepipeline/cfn_pipeline.rb', line 190

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


200
201
202
 
# File 'codepipeline/cfn_pipeline.rb', line 200

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


657
658
659
660
 
# File 'codepipeline/cfn_pipeline.rb', line 657

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#variables ⇒ AWSCDK::IResolvable, ...

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

Returns:



371
372
373
 
# File 'codepipeline/cfn_pipeline.rb', line 371

def variables()
  jsii_get_property("variables")
end

#variables=(value) ⇒ Object 



375
376
377
378
 
# File 'codepipeline/cfn_pipeline.rb', line 375

def variables=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLlZhcmlhYmxlRGVjbGFyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "variables") unless value.nil?
  jsii_set_property("variables", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


396
397
398
399
400
401
 
# File 'codepipeline/cfn_pipeline.rb', line 396

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end