Class: AWSCDK::Codepipeline::CfnCustomActionTypeProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
codepipeline/cfn_custom_action_type_props.rb

Overview

Properties for defining a CfnCustomActionType.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category:, input_artifact_details:, output_artifact_details:, provider:, version:, configuration_properties: nil, settings: nil, tags: nil) ⇒ CfnCustomActionTypeProps

Returns a new instance of CfnCustomActionTypeProps.

Parameters:



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

def initialize(category:, input_artifact_details:, output_artifact_details:, provider:, version:, configuration_properties: nil, settings: nil, tags: nil)
  @category = category
  Jsii::Type.check_type(@category, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "category")
  @input_artifact_details = input_artifact_details.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnCustomActionType::ArtifactDetailsProperty.new(**input_artifact_details.transform_keys(&:to_sym)) : input_artifact_details
  Jsii::Type.check_type(@input_artifact_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuQ3VzdG9tQWN0aW9uVHlwZS5BcnRpZmFjdERldGFpbHNQcm9wZXJ0eSJ9XX19")), "inputArtifactDetails")
  @output_artifact_details = output_artifact_details.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnCustomActionType::ArtifactDetailsProperty.new(**output_artifact_details.transform_keys(&:to_sym)) : output_artifact_details
  Jsii::Type.check_type(@output_artifact_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuQ3VzdG9tQWN0aW9uVHlwZS5BcnRpZmFjdERldGFpbHNQcm9wZXJ0eSJ9XX19")), "outputArtifactDetails")
  @provider = provider
  Jsii::Type.check_type(@provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provider")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version")
  @configuration_properties = configuration_properties
  Jsii::Type.check_type(@configuration_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmbkN1c3RvbUFjdGlvblR5cGUuQ29uZmlndXJhdGlvblByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "configurationProperties") unless @configuration_properties.nil?
  @settings = settings.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnCustomActionType::SettingsProperty.new(**settings.transform_keys(&:to_sym)) : settings
  Jsii::Type.check_type(@settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuQ3VzdG9tQWN0aW9uVHlwZS5TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "settings") unless @settings.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#category ⇒ String (readonly)

The category of the custom action, such as a build action or a test action.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 40

def category
  @category
end

#configuration_properties ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of Config:name, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline .

Returns:

See Also:



67
68
69
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 67

def configuration_properties
  @configuration_properties
end

#input_artifact_details ⇒ AWSCDK::IResolvable, AWSCDK::Codepipeline::CfnCustomActionType::ArtifactDetailsProperty (readonly)

The details of the input artifact for the action, such as its commit ID.

Returns:

See Also:



45
46
47
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 45

def input_artifact_details
  @input_artifact_details
end

#output_artifact_details ⇒ AWSCDK::IResolvable, AWSCDK::Codepipeline::CfnCustomActionType::ArtifactDetailsProperty (readonly)

The details of the output artifact of the action, such as its commit ID.

Returns:

See Also:



50
51
52
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 50

def output_artifact_details
  @output_artifact_details
end

#provider ⇒ String (readonly)

The provider of the service used in the custom action, such as CodeDeploy.

Returns:

  • (String)

See Also:



55
56
57
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 55

def provider
  @provider
end

#settings ⇒ AWSCDK::IResolvable, ... (readonly)

URLs that provide users information about this custom action.

Returns:

See Also:



72
73
74
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 72

def settings
  @settings
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags for the custom action.

Returns:

See Also:



77
78
79
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 77

def tags
  @tags
end

#version ⇒ String (readonly)

The version identifier of the custom action.

Returns:

  • (String)

See Also:



60
61
62
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 60

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 79

def self.jsii_properties
  {
    :category => "category",
    :input_artifact_details => "inputArtifactDetails",
    :output_artifact_details => "outputArtifactDetails",
    :provider => "provider",
    :version => "version",
    :configuration_properties => "configurationProperties",
    :settings => "settings",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'codepipeline/cfn_custom_action_type_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "category" => @category,
    "inputArtifactDetails" => @input_artifact_details,
    "outputArtifactDetails" => @output_artifact_details,
    "provider" => @provider,
    "version" => @version,
    "configurationProperties" => @configuration_properties,
    "settings" => @settings,
    "tags" => @tags,
  })
  result.compact
end