Class: AWSCDK::CodePipelineActions::ServiceCatalogDeployActionBeta1Props

Inherits:
AWSCDK::Codepipeline::CommonAWSActionProps
  • Object
show all
Defined in:
code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb

Overview

Construction properties of the ServiceCatalogDeployActionBeta1 ServiceCatalog deploy CodePipeline Action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, product_id:, product_version_name:, template_path:, product_version_description: nil) ⇒ ServiceCatalogDeployActionBeta1Props

Returns a new instance of ServiceCatalogDeployActionBeta1Props.

Parameters:

  • action_name (String) —

    The physical, human-readable name of the Action.

  • run_order (Numeric, nil) (defaults to: nil) —

    The runOrder property for this Action.

  • variables_namespace (String, nil) (defaults to: nil) —

    The name of the namespace to use for variables emitted by this action.

  • role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The Role in which context's this Action will be executing in.

  • product_id (String) —

    The identifier of the product in the Service Catalog.

  • product_version_name (String) —

    The name of the version of the Service Catalog product to be deployed.

  • template_path (AWSCDK::Codepipeline::ArtifactPath) —

    The path to the cloudformation artifact.

  • product_version_description (String, nil) (defaults to: nil) —

    The optional description of this version of the Service Catalog product.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 15

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, product_id:, product_version_name:, template_path:, product_version_description: nil)
  @action_name = action_name
  Jsii::Type.check_type(@action_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionName")
  @run_order = run_order
  Jsii::Type.check_type(@run_order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "runOrder") unless @run_order.nil?
  @variables_namespace = variables_namespace
  Jsii::Type.check_type(@variables_namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "variablesNamespace") unless @variables_namespace.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @product_id = product_id
  Jsii::Type.check_type(@product_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productId")
  @product_version_name = product_version_name
  Jsii::Type.check_type(@product_version_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productVersionName")
  @template_path = template_path
  Jsii::Type.check_type(@template_path, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0UGF0aCJ9")), "templatePath")
  @product_version_description = product_version_description
  Jsii::Type.check_type(@product_version_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productVersionDescription") unless @product_version_description.nil?
end

Instance Attribute Details

#action_name ⇒ String (readonly)

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Returns:

  • (String) 


39
40
41
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 39

def action_name
  @action_name
end

#product_id ⇒ String (readonly)

The identifier of the product in the Service Catalog.

This product must already exist.

Returns:

  • (String) 


69
70
71
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 69

def product_id
  @product_id
end

#product_version_description ⇒ String? (readonly)

Note:

Default: ''

The optional description of this version of the Service Catalog product.

Returns:

  • (String, nil) 


82
83
84
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 82

def product_version_description
  @product_version_description
end

#product_version_name ⇒ String (readonly)

The name of the version of the Service Catalog product to be deployed.

Returns:

  • (String) 


73
74
75
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 73

def product_version_name
  @product_version_name
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: a new Role will be generated

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 IAction.bind method in the ActionBindOptions.role property.

Returns:



63
64
65
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 63

def role
  @role
end

#run_order ⇒ Numeric? (readonly)

Note:

Default: 1

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

  • (Numeric, nil)

See Also:



47
48
49
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 47

def run_order
  @run_order
end

#template_path ⇒ AWSCDK::Codepipeline::ArtifactPath (readonly)

The path to the cloudformation artifact.

Returns:



77
78
79
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 77

def template_path
  @template_path
end

#variables_namespace ⇒ String? (readonly)

Note:

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

The name of the namespace to use for variables emitted by this action.

Returns:

  • (String, nil) 


52
53
54
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 52

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 84

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :role => "role",
    :product_id => "productId",
    :product_version_name => "productVersionName",
    :template_path => "templatePath",
    :product_version_description => "productVersionDescription",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'code_pipeline_actions/service_catalog_deploy_action_beta1_props.rb', line 97

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "role" => @role,
    "productId" => @product_id,
    "productVersionName" => @product_version_name,
    "templatePath" => @template_path,
    "productVersionDescription" => @product_version_description,
  })
  result.compact
end