Class: AWSCDK::Codepipeline::CfnCustomActionType::ConfigurationPropertiesProperty

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

Overview

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 .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, name:, required:, secret:, description: nil, queryable: nil, type: nil) ⇒ ConfigurationPropertiesProperty

Returns a new instance of ConfigurationPropertiesProperty.

Parameters:

  • key (Boolean, AWSCDK::IResolvable) —

    Whether the configuration property is a key.

  • name (String) —

    The name of the action configuration property.

  • required (Boolean, AWSCDK::IResolvable) —

    Whether the configuration property is a required value.

  • secret (Boolean, AWSCDK::IResolvable) —

    Whether the configuration property is secret.

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

    The description of the action configuration property that is displayed to users.

  • queryable (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates that the property is used with PollForJobs .

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

    The type of the configuration property.



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'codepipeline/cfn_custom_action_type.rb', line 655

def initialize(key:, name:, required:, secret:, description: nil, queryable: nil, type: nil)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "key")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @required = required
  Jsii::Type.check_type(@required, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "required")
  @secret = secret
  Jsii::Type.check_type(@secret, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "secret")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @queryable = queryable
  Jsii::Type.check_type(@queryable, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "queryable") unless @queryable.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the action configuration property that is displayed to users.

Returns:

  • (String, nil)

See Also:



700
701
702
 
# File 'codepipeline/cfn_custom_action_type.rb', line 700

def description
  @description
end

#key ⇒ Boolean, AWSCDK::IResolvable (readonly)

Whether the configuration property is a key.

Returns:

See Also:



676
677
678
 
# File 'codepipeline/cfn_custom_action_type.rb', line 676

def key
  @key
end

#name ⇒ String (readonly)

The name of the action configuration property.

Returns:

  • (String)

See Also:



681
682
683
 
# File 'codepipeline/cfn_custom_action_type.rb', line 681

def name
  @name
end

#queryable ⇒ Boolean, ... (readonly)

Indicates that the property is used with PollForJobs .

When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

Returns:

See Also:



709
710
711
 
# File 'codepipeline/cfn_custom_action_type.rb', line 709

def queryable
  @queryable
end

#required ⇒ Boolean, AWSCDK::IResolvable (readonly)

Whether the configuration property is a required value.

Returns:

See Also:



686
687
688
 
# File 'codepipeline/cfn_custom_action_type.rb', line 686

def required
  @required
end

#secret ⇒ Boolean, AWSCDK::IResolvable (readonly)

Whether the configuration property is secret.

Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

Returns:

See Also:



695
696
697
 
# File 'codepipeline/cfn_custom_action_type.rb', line 695

def secret
  @secret
end

#type ⇒ String? (readonly)

The type of the configuration property.

Returns:

  • (String, nil)

See Also:



714
715
716
 
# File 'codepipeline/cfn_custom_action_type.rb', line 714

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



716
717
718
719
720
721
722
723
724
725
726
 
# File 'codepipeline/cfn_custom_action_type.rb', line 716

def self.jsii_properties
  {
    :key => "key",
    :name => "name",
    :required => "required",
    :secret => "secret",
    :description => "description",
    :queryable => "queryable",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'codepipeline/cfn_custom_action_type.rb', line 728

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "name" => @name,
    "required" => @required,
    "secret" => @secret,
    "description" => @description,
    "queryable" => @queryable,
    "type" => @type,
  })
  result.compact
end