Class: AWSCDK::Codepipeline::CfnPipeline::ActionTypeIdProperty

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

Overview

Represents information about an action type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category:, owner:, provider:, version:) ⇒ ActionTypeIdProperty

Returns a new instance of ActionTypeIdProperty.

Parameters:

  • category (String)

    A category defines what kind of action can be taken in the stage, and constrains the provider type for the action.

  • owner (String)

    The creator of the action being called.

  • provider (String)

    The provider of the service being called by the action.

  • version (String)

    A string that describes the action version.



860
861
862
863
864
865
866
867
868
869
# File 'codepipeline/cfn_pipeline.rb', line 860

def initialize(category:, owner:, provider:, version:)
  @category = category
  Jsii::Type.check_type(@category, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "category")
  @owner = owner
  Jsii::Type.check_type(@owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "owner")
  @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")
end

Instance Attribute Details

#categoryString (readonly)

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action.

Valid categories are limited to one of the values below.

  • Source
  • Build
  • Test
  • Deploy
  • Invoke
  • Approval
  • Compute


885
886
887
# File 'codepipeline/cfn_pipeline.rb', line 885

def category
  @category
end

#ownerString (readonly)

The creator of the action being called.

There are three valid values for the Owner field in the action category section within your pipeline structure: AWS , ThirdParty , and Custom . For more information, see Valid Action Types and Providers in CodePipeline .



892
893
894
# File 'codepipeline/cfn_pipeline.rb', line 892

def owner
  @owner
end

#providerString (readonly)

The provider of the service being called by the action.

Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy . For more information, see Valid Action Types and Providers in CodePipeline .



899
900
901
# File 'codepipeline/cfn_pipeline.rb', line 899

def provider
  @provider
end

#versionString (readonly)

A string that describes the action version.



904
905
906
# File 'codepipeline/cfn_pipeline.rb', line 904

def version
  @version
end

Class Method Details

.jsii_propertiesObject



906
907
908
909
910
911
912
913
# File 'codepipeline/cfn_pipeline.rb', line 906

def self.jsii_properties
  {
    :category => "category",
    :owner => "owner",
    :provider => "provider",
    :version => "version",
  }
end

Instance Method Details

#to_jsiiObject



915
916
917
918
919
920
921
922
923
924
# File 'codepipeline/cfn_pipeline.rb', line 915

def to_jsii
  result = {}
  result.merge!({
    "category" => @category,
    "owner" => @owner,
    "provider" => @provider,
    "version" => @version,
  })
  result.compact
end