Class: Aws::ConfigService::Types::Source

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb

Overview

Note:

When making an API call, you may pass Source data as a hash:

{
  owner: "CUSTOM_LAMBDA", # required, accepts CUSTOM_LAMBDA, AWS, CUSTOM_POLICY
  source_identifier: "StringWithCharLimit256",
  source_details: [
    {
      event_source: "aws.config", # accepts aws.config
      message_type: "ConfigurationItemChangeNotification", # accepts ConfigurationItemChangeNotification, ConfigurationSnapshotDeliveryCompleted, ScheduledNotification, OversizedConfigurationItemChangeNotification
      maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    },
  ],
  custom_policy_details: {
    policy_runtime: "PolicyRuntime", # required
    policy_text: "PolicyText", # required
    enable_debug_log_delivery: false,
  },
}

Provides the CustomPolicyDetails, the rule owner (Amazon Web Services or customer), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_policy_detailsTypes::CustomPolicyDetails

Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY.



8522
8523
8524
8525
8526
8527
8528
8529
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8522

class Source < Struct.new(
  :owner,
  :source_identifier,
  :source_details,
  :custom_policy_details)
  SENSITIVE = []
  include Aws::Structure
end

#ownerString

Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.

Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more information, see Config Custom Rules in the Config developer guide.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8522

class Source < Struct.new(
  :owner,
  :source_identifier,
  :source_details,
  :custom_policy_details)
  SENSITIVE = []
  include Aws::Structure
end

#source_detailsArray<Types::SourceDetail>

Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

If the owner is set to CUSTOM_POLICY, the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

Returns:



8522
8523
8524
8525
8526
8527
8528
8529
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8522

class Source < Struct.new(
  :owner,
  :source_identifier,
  :source_details,
  :custom_policy_details)
  SENSITIVE = []
  include Aws::Structure
end

#source_identifierString

For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules.

For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

For Config Custom Policy rules, this field will be ignored.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8522

class Source < Struct.new(
  :owner,
  :source_identifier,
  :source_details,
  :custom_policy_details)
  SENSITIVE = []
  include Aws::Structure
end