Class: AWSCDK::CodePipelineActions::AlexaSkillDeployActionProps

Inherits:
AWSCDK::Codepipeline::CommonActionProps
  • Object
show all
Defined in:
code_pipeline_actions/alexa_skill_deploy_action_props.rb

Overview

Construction properties of the AlexaSkillDeployAction Alexa deploy Action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action_name:, run_order: nil, variables_namespace: nil, client_id:, client_secret:, input:, refresh_token:, skill_id:, parameter_overrides_artifact: nil) ⇒ AlexaSkillDeployActionProps

Returns a new instance of AlexaSkillDeployActionProps.

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.

  • client_id (String) —

    The client id of the developer console token.

  • client_secret (AWSCDK::SecretValue) —

    The client secret of the developer console token.

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

    The source artifact containing the voice model and skill manifest.

  • refresh_token (AWSCDK::SecretValue) —

    The refresh token of the developer console token.

  • skill_id (String) —

    The Alexa skill id.

  • parameter_overrides_artifact (AWSCDK::Codepipeline::Artifact, nil) (defaults to: nil) —

    An optional artifact containing overrides for the skill manifest.



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

def initialize(action_name:, run_order: nil, variables_namespace: nil, client_id:, client_secret:, input:, refresh_token:, skill_id:, parameter_overrides_artifact: 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?
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId")
  @client_secret = client_secret
  Jsii::Type.check_type(@client_secret, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TZWNyZXRWYWx1ZSJ9")), "clientSecret")
  @input = input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "input")
  @refresh_token = refresh_token
  Jsii::Type.check_type(@refresh_token, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TZWNyZXRWYWx1ZSJ9")), "refreshToken")
  @skill_id = skill_id
  Jsii::Type.check_type(@skill_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "skillId")
  @parameter_overrides_artifact = parameter_overrides_artifact
  Jsii::Type.check_type(@parameter_overrides_artifact, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "parameterOverridesArtifact") unless @parameter_overrides_artifact.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) 


42
43
44
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 42

def action_name
  @action_name
end

#client_id ⇒ String (readonly)

The client id of the developer console token.

Returns:

  • (String) 


59
60
61
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 59

def client_id
  @client_id
end

#client_secret ⇒ AWSCDK::SecretValue (readonly)

The client secret of the developer console token.

Returns:



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

def client_secret
  @client_secret
end

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

The source artifact containing the voice model and skill manifest.

Returns:



67
68
69
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 67

def input
  @input
end

#parameter_overrides_artifact ⇒ AWSCDK::Codepipeline::Artifact? (readonly)

An optional artifact containing overrides for the skill manifest.

Returns:



79
80
81
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 79

def parameter_overrides_artifact
  @parameter_overrides_artifact
end

#refresh_token ⇒ AWSCDK::SecretValue (readonly)

The refresh token of the developer console token.

Returns:



71
72
73
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 71

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



50
51
52
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 50

def run_order
  @run_order
end

#skill_id ⇒ String (readonly)

The Alexa skill id.

Returns:

  • (String) 


75
76
77
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 75

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


55
56
57
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 55

def variables_namespace
  @variables_namespace
end

Class Method Details

.jsii_properties ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'code_pipeline_actions/alexa_skill_deploy_action_props.rb', line 81

def self.jsii_properties
  {
    :action_name => "actionName",
    :run_order => "runOrder",
    :variables_namespace => "variablesNamespace",
    :client_id => "clientId",
    :client_secret => "clientSecret",
    :input => "input",
    :refresh_token => "refreshToken",
    :skill_id => "skillId",
    :parameter_overrides_artifact => "parameterOverridesArtifact",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "actionName" => @action_name,
    "runOrder" => @run_order,
    "variablesNamespace" => @variables_namespace,
    "clientId" => @client_id,
    "clientSecret" => @client_secret,
    "input" => @input,
    "refreshToken" => @refresh_token,
    "skillId" => @skill_id,
    "parameterOverridesArtifact" => @parameter_overrides_artifact,
  })
  result.compact
end