Class: AWSCDK::AppConfig::CfnExtension::ParameterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_config/cfn_extension.rb

Overview

A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked.

Parameter values are specified in an extension association. For more information about extensions, see Extending workflows in the AWS AppConfig User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(required:, description: nil, dynamic: nil) ⇒ ParameterProperty

Returns a new instance of ParameterProperty.

Parameters:

  • required (Boolean, AWSCDK::IResolvable) —

    A parameter value must be specified in the extension association.

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

    Information about the parameter.

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

    Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association.



677
678
679
680
681
682
683
684
 
# File 'app_config/cfn_extension.rb', line 677

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

Instance Attribute Details

#description ⇒ String? (readonly)

Information about the parameter.

Returns:

  • (String, nil)

See Also:



695
696
697
 
# File 'app_config/cfn_extension.rb', line 695

def description
  @description
end

#dynamic ⇒ Boolean, ... (readonly)

Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association.

Dynamic parameters can't be marked Required .

Returns:

See Also:



702
703
704
 
# File 'app_config/cfn_extension.rb', line 702

def dynamic
  @dynamic
end

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

A parameter value must be specified in the extension association.

Returns:

See Also:



690
691
692
 
# File 'app_config/cfn_extension.rb', line 690

def required
  @required
end

Class Method Details

.jsii_properties ⇒ Object 



704
705
706
707
708
709
710
 
# File 'app_config/cfn_extension.rb', line 704

def self.jsii_properties
  {
    :required => "required",
    :description => "description",
    :dynamic => "dynamic",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



712
713
714
715
716
717
718
719
720
 
# File 'app_config/cfn_extension.rb', line 712

def to_jsii
  result = {}
  result.merge!({
    "required" => @required,
    "description" => @description,
    "dynamic" => @dynamic,
  })
  result.compact
end