Class: AWSCDK::Config::CfnConfigurationRecorder::RecordingModeOverrideProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
config/cfn_configuration_recorder.rb

Overview

An object for you to specify your overrides for the recording mode.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(recording_frequency:, resource_types:, description: nil) ⇒ RecordingModeOverrideProperty

Returns a new instance of RecordingModeOverrideProperty.

Parameters:

  • recording_frequency (String)

    The recording frequency that will be applied to all the resource types specified in the override.

  • resource_types (Array<String>)

    A comma-separated list that specifies which resource types AWS Config includes in the override.

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

    A description that you provide for the override.



787
788
789
790
791
792
793
794
# File 'config/cfn_configuration_recorder.rb', line 787

def initialize(recording_frequency:, resource_types:, description: nil)
  @recording_frequency = recording_frequency
  Jsii::Type.check_type(@recording_frequency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "recordingFrequency")
  @resource_types = resource_types
  Jsii::Type.check_type(@resource_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceTypes")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#descriptionString? (readonly)

A description that you provide for the override.



821
822
823
# File 'config/cfn_configuration_recorder.rb', line 821

def description
  @description
end

#recording_frequencyString (readonly)

The recording frequency that will be applied to all the resource types specified in the override.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.
  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

AWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.



805
806
807
# File 'config/cfn_configuration_recorder.rb', line 805

def recording_frequency
  @recording_frequency
end

#resource_typesArray<String> (readonly)

A comma-separated list that specifies which resource types AWS Config includes in the override.

Daily recording cannot be specified for the following resource types:

  • AWS::Config::ResourceCompliance
  • AWS::Config::ConformancePackCompliance
  • AWS::Config::ConfigurationRecorder


816
817
818
# File 'config/cfn_configuration_recorder.rb', line 816

def resource_types
  @resource_types
end

Class Method Details

.jsii_propertiesObject



823
824
825
826
827
828
829
# File 'config/cfn_configuration_recorder.rb', line 823

def self.jsii_properties
  {
    :recording_frequency => "recordingFrequency",
    :resource_types => "resourceTypes",
    :description => "description",
  }
end

Instance Method Details

#to_jsiiObject



831
832
833
834
835
836
837
838
839
# File 'config/cfn_configuration_recorder.rb', line 831

def to_jsii
  result = {}
  result.merge!({
    "recordingFrequency" => @recording_frequency,
    "resourceTypes" => @resource_types,
    "description" => @description,
  })
  result.compact
end