Class: AWSCDK::Lightsail::CfnDatabase::RelationalDatabaseParameterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lightsail/cfn_database.rb

Overview

RelationalDatabaseParameter is a property of the AWS::Lightsail::Database resource. It describes parameters for the database.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allowed_values: nil, apply_method: nil, apply_type: nil, data_type: nil, description: nil, is_modifiable: nil, parameter_name: nil, parameter_value: nil) ⇒ RelationalDatabaseParameterProperty

Returns a new instance of RelationalDatabaseParameterProperty.

Parameters:

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

    The valid range of values for the parameter.

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

    Indicates when parameter updates are applied.

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

    Specifies the engine-specific parameter type.

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

    The valid data type of the parameter.

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

    A description of the parameter.

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

    A Boolean value indicating whether the parameter can be modified.

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

    The name of the parameter.

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

    The value for the parameter.



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
 
# File 'lightsail/cfn_database.rb', line 706

def initialize(allowed_values: nil, apply_method: nil, apply_type: nil, data_type: nil, description: nil, is_modifiable: nil, parameter_name: nil, parameter_value: nil)
  @allowed_values = allowed_values
  Jsii::Type.check_type(@allowed_values, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allowedValues") unless @allowed_values.nil?
  @apply_method = apply_method
  Jsii::Type.check_type(@apply_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applyMethod") unless @apply_method.nil?
  @apply_type = apply_type
  Jsii::Type.check_type(@apply_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applyType") unless @apply_type.nil?
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType") unless @data_type.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @is_modifiable = is_modifiable
  Jsii::Type.check_type(@is_modifiable, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isModifiable") unless @is_modifiable.nil?
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName") unless @parameter_name.nil?
  @parameter_value = parameter_value
  Jsii::Type.check_type(@parameter_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterValue") unless @parameter_value.nil?
end

Instance Attribute Details

#allowed_values ⇒ String? (readonly)

The valid range of values for the parameter.

Returns:

  • (String, nil)

See Also:



729
730
731
 
# File 'lightsail/cfn_database.rb', line 729

def allowed_values
  @allowed_values
end

#apply_method ⇒ String? (readonly)

Indicates when parameter updates are applied.

Can be immediate or pending-reboot .

Returns:

  • (String, nil)

See Also:



736
737
738
 
# File 'lightsail/cfn_database.rb', line 736

def apply_method
  @apply_method
end

#apply_type ⇒ String? (readonly)

Specifies the engine-specific parameter type.

Returns:

  • (String, nil)

See Also:



741
742
743
 
# File 'lightsail/cfn_database.rb', line 741

def apply_type
  @apply_type
end

#data_type ⇒ String? (readonly)

The valid data type of the parameter.

Returns:

  • (String, nil)

See Also:



746
747
748
 
# File 'lightsail/cfn_database.rb', line 746

def data_type
  @data_type
end

#description ⇒ String? (readonly)

A description of the parameter.

Returns:

  • (String, nil)

See Also:



751
752
753
 
# File 'lightsail/cfn_database.rb', line 751

def description
  @description
end

#is_modifiable ⇒ Boolean, ... (readonly)

A Boolean value indicating whether the parameter can be modified.

Returns:

See Also:



756
757
758
 
# File 'lightsail/cfn_database.rb', line 756

def is_modifiable
  @is_modifiable
end

#parameter_name ⇒ String? (readonly)

The name of the parameter.

Returns:

  • (String, nil)

See Also:



761
762
763
 
# File 'lightsail/cfn_database.rb', line 761

def parameter_name
  @parameter_name
end

#parameter_value ⇒ String? (readonly)

The value for the parameter.

Returns:

  • (String, nil)

See Also:



766
767
768
 
# File 'lightsail/cfn_database.rb', line 766

def parameter_value
  @parameter_value
end

Class Method Details

.jsii_properties ⇒ Object 



768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lightsail/cfn_database.rb', line 768

def self.jsii_properties
  {
    :allowed_values => "allowedValues",
    :apply_method => "applyMethod",
    :apply_type => "applyType",
    :data_type => "dataType",
    :description => "description",
    :is_modifiable => "isModifiable",
    :parameter_name => "parameterName",
    :parameter_value => "parameterValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lightsail/cfn_database.rb', line 781

def to_jsii
  result = {}
  result.merge!({
    "allowedValues" => @allowed_values,
    "applyMethod" => @apply_method,
    "applyType" => @apply_type,
    "dataType" => @data_type,
    "description" => @description,
    "isModifiable" => @is_modifiable,
    "parameterName" => @parameter_name,
    "parameterValue" => @parameter_value,
  })
  result.compact
end