Class: AWSCDK::CodePipelineActions::ElasticBeanstalkDeployActionProps

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

Overview

Construction properties of the ElasticBeanstalkDeployAction Elastic Beanstalk 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, application_name:, environment_name:, input:) ⇒ ElasticBeanstalkDeployActionProps

Returns a new instance of ElasticBeanstalkDeployActionProps.

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.

  • application_name (String) —

    The name of the AWS Elastic Beanstalk application to deploy.

  • environment_name (String) —

    The name of the AWS Elastic Beanstalk environment to deploy to.

  • input (AWSCDK::Codepipeline::Artifact) —

    The source to use as input for deployment.



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

def initialize(action_name:, run_order: nil, variables_namespace: nil, role: nil, application_name:, environment_name:, input:)
  @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?
  @application_name = application_name
  Jsii::Type.check_type(@application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName")
  @environment_name = environment_name
  Jsii::Type.check_type(@environment_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentName")
  @input = input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "input")
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) 


36
37
38
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 36

def action_name
  @action_name
end

#application_name ⇒ String (readonly)

The name of the AWS Elastic Beanstalk application to deploy.

Returns:

  • (String) 


64
65
66
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 64

def application_name
  @application_name
end

#environment_name ⇒ String (readonly)

The name of the AWS Elastic Beanstalk environment to deploy to.

Returns:

  • (String) 


68
69
70
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 68

def environment_name
  @environment_name
end

#input ⇒ AWSCDK::Codepipeline::Artifact (readonly)

The source to use as input for deployment.

Returns:



72
73
74
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 72

def input
  @input
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:



60
61
62
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 60

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:



44
45
46
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 44

def run_order
  @run_order
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) 


49
50
51
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 49

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 74

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :role => "role",
    :application_name => "applicationName",
    :environment_name => "environmentName",
    :input => "input",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'code_pipeline_actions/elastic_beanstalk_deploy_action_props.rb', line 86

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "role" => @role,
    "applicationName" => @application_name,
    "environmentName" => @environment_name,
    "input" => @input,
  })
  result.compact
end