Class: Aws::ConfigService::Types::PutOrganizationConfigRuleRequest

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 PutOrganizationConfigRuleRequest data as a hash:

{
  organization_config_rule_name: "OrganizationConfigRuleName", # required
  organization_managed_rule_metadata: {
    description: "StringWithCharLimit256Min0",
    rule_identifier: "StringWithCharLimit256", # required
    input_parameters: "StringWithCharLimit2048",
    maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    resource_types_scope: ["StringWithCharLimit256"],
    resource_id_scope: "StringWithCharLimit768",
    tag_key_scope: "StringWithCharLimit128",
    tag_value_scope: "StringWithCharLimit256",
  },
  organization_custom_rule_metadata: {
    description: "StringWithCharLimit256Min0",
    lambda_function_arn: "StringWithCharLimit256", # required
    organization_config_rule_trigger_types: ["ConfigurationItemChangeNotification"], # required, accepts ConfigurationItemChangeNotification, OversizedConfigurationItemChangeNotification, ScheduledNotification
    input_parameters: "StringWithCharLimit2048",
    maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    resource_types_scope: ["StringWithCharLimit256"],
    resource_id_scope: "StringWithCharLimit768",
    tag_key_scope: "StringWithCharLimit128",
    tag_value_scope: "StringWithCharLimit256",
  },
  excluded_accounts: ["AccountId"],
  organization_custom_policy_rule_metadata: {
    description: "StringWithCharLimit256Min0",
    organization_config_rule_trigger_types: ["ConfigurationItemChangeNotification"], # accepts ConfigurationItemChangeNotification, OversizedConfigurationItemChangeNotification
    input_parameters: "StringWithCharLimit2048",
    maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    resource_types_scope: ["StringWithCharLimit256"],
    resource_id_scope: "StringWithCharLimit768",
    tag_key_scope: "StringWithCharLimit128",
    tag_value_scope: "StringWithCharLimit256",
    policy_runtime: "PolicyRuntime", # required
    policy_text: "PolicyText", # required
    debug_log_delivery_accounts: ["AccountId"],
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#excluded_accountsArray<String>

A comma-separated list of accounts that you want to exclude from an organization Config rule.

Returns:

  • (Array<String>)


7180
7181
7182
7183
7184
7185
7186
7187
7188
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7180

class PutOrganizationConfigRuleRequest < Struct.new(
  :organization_config_rule_name,
  :organization_managed_rule_metadata,
  :organization_custom_rule_metadata,
  :excluded_accounts,
  :organization_custom_policy_rule_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#organization_config_rule_nameString

The name that you assign to an organization Config rule.

Returns:

  • (String)


7180
7181
7182
7183
7184
7185
7186
7187
7188
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7180

class PutOrganizationConfigRuleRequest < Struct.new(
  :organization_config_rule_name,
  :organization_managed_rule_metadata,
  :organization_custom_rule_metadata,
  :excluded_accounts,
  :organization_custom_policy_rule_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#organization_custom_policy_rule_metadataTypes::OrganizationCustomPolicyRuleMetadata

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.



7180
7181
7182
7183
7184
7185
7186
7187
7188
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7180

class PutOrganizationConfigRuleRequest < Struct.new(
  :organization_config_rule_name,
  :organization_managed_rule_metadata,
  :organization_custom_rule_metadata,
  :excluded_accounts,
  :organization_custom_policy_rule_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#organization_custom_rule_metadataTypes::OrganizationCustomRuleMetadata

An OrganizationCustomRuleMetadata object.



7180
7181
7182
7183
7184
7185
7186
7187
7188
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7180

class PutOrganizationConfigRuleRequest < Struct.new(
  :organization_config_rule_name,
  :organization_managed_rule_metadata,
  :organization_custom_rule_metadata,
  :excluded_accounts,
  :organization_custom_policy_rule_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#organization_managed_rule_metadataTypes::OrganizationManagedRuleMetadata

An OrganizationManagedRuleMetadata object.



7180
7181
7182
7183
7184
7185
7186
7187
7188
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7180

class PutOrganizationConfigRuleRequest < Struct.new(
  :organization_config_rule_name,
  :organization_managed_rule_metadata,
  :organization_custom_rule_metadata,
  :excluded_accounts,
  :organization_custom_policy_rule_metadata)
  SENSITIVE = []
  include Aws::Structure
end