Class: AWSCDK::Codepipeline::CfnPipeline::RuleTypeIdProperty

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

Overview

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

For more information about conditions, see Stage conditions . For more information about rules, see the AWS CodePipeline rule reference .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category: nil, owner: nil, provider: nil, version: nil) ⇒ RuleTypeIdProperty

Returns a new instance of RuleTypeIdProperty.

Parameters:

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

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

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

    The creator of the rule being called.

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

    The rule provider, such as the DeploymentWindow rule.

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

    A string that describes the rule version.



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
 
# File 'codepipeline/cfn_pipeline.rb', line 1898

def initialize(category: nil, owner: nil, provider: nil, version: nil)
  @category = category
  Jsii::Type.check_type(@category, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "category") unless @category.nil?
  @owner = owner
  Jsii::Type.check_type(@owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "owner") unless @owner.nil?
  @provider = provider
  Jsii::Type.check_type(@provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provider") unless @provider.nil?
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#category ⇒ String? (readonly)

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

The valid category is Rule .

Returns:

  • (String, nil)

See Also:



1915
1916
1917
 
# File 'codepipeline/cfn_pipeline.rb', line 1915

def category
  @category
end

#owner ⇒ String? (readonly)

The creator of the rule being called.

The valid value for the Owner field in the rule category is AWS .

Returns:

  • (String, nil)

See Also:



1922
1923
1924
 
# File 'codepipeline/cfn_pipeline.rb', line 1922

def owner
  @owner
end

#provider ⇒ String? (readonly)

The rule provider, such as the DeploymentWindow rule.

For a list of rule provider names, see the rules listed in the AWS CodePipeline rule reference .

Returns:

  • (String, nil)

See Also:



1929
1930
1931
 
# File 'codepipeline/cfn_pipeline.rb', line 1929

def provider
  @provider
end

#version ⇒ String? (readonly)

A string that describes the rule version.

Returns:

  • (String, nil)

See Also:



1934
1935
1936
 
# File 'codepipeline/cfn_pipeline.rb', line 1934

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'codepipeline/cfn_pipeline.rb', line 1936

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

Instance Method Details

#to_jsii ⇒ Object 



1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
 
# File 'codepipeline/cfn_pipeline.rb', line 1945

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