Package software.amazon.awssdk.services.config.model

Interface OrganizationCustomPolicyRuleMetadata.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OrganizationCustomPolicyRuleMetadata.Builder,OrganizationCustomPolicyRuleMetadata>, SdkBuilder<OrganizationCustomPolicyRuleMetadata.Builder,OrganizationCustomPolicyRuleMetadata>, SdkPojo
Enclosing class:
OrganizationCustomPolicyRuleMetadata
public static interface OrganizationCustomPolicyRuleMetadata.Builder extends SdkPojo, CopyableBuilder<OrganizationCustomPolicyRuleMetadata.Builder,OrganizationCustomPolicyRuleMetadata>

  • Method Details

    • description

      OrganizationCustomPolicyRuleMetadata.Builder description(String description)

      The description that you provide for your organization Config Custom Policy rule.

      Parameters:
      description - The description that you provide for your organization Config Custom Policy rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationConfigRuleTriggerTypesWithStrings

      OrganizationCustomPolicyRuleMetadata.Builder organizationConfigRuleTriggerTypesWithStrings(Collection<String> organizationConfigRuleTriggerTypes)

      The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Parameters:
      organizationConfigRuleTriggerTypes - The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationConfigRuleTriggerTypesWithStrings

      OrganizationCustomPolicyRuleMetadata.Builder organizationConfigRuleTriggerTypesWithStrings(String... organizationConfigRuleTriggerTypes)

      The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Parameters:
      organizationConfigRuleTriggerTypes - The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationConfigRuleTriggerTypes

      OrganizationCustomPolicyRuleMetadata.Builder organizationConfigRuleTriggerTypes(Collection<OrganizationConfigRuleTriggerTypeNoSN> organizationConfigRuleTriggerTypes)

      The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Parameters:
      organizationConfigRuleTriggerTypes - The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationConfigRuleTriggerTypes

      OrganizationCustomPolicyRuleMetadata.Builder organizationConfigRuleTriggerTypes(OrganizationConfigRuleTriggerTypeNoSN... organizationConfigRuleTriggerTypes)

      The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Parameters:
      organizationConfigRuleTriggerTypes - The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

      • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

      • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputParameters

      OrganizationCustomPolicyRuleMetadata.Builder inputParameters(String inputParameters)

      A string, in JSON format, that is passed to your organization Config Custom Policy rule.

      Parameters:
      inputParameters - A string, in JSON format, that is passed to your organization Config Custom Policy rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumExecutionFrequency

      OrganizationCustomPolicyRuleMetadata.Builder maximumExecutionFrequency(String maximumExecutionFrequency)

      The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

      Parameters:
      maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maximumExecutionFrequency

      OrganizationCustomPolicyRuleMetadata.Builder maximumExecutionFrequency(MaximumExecutionFrequency maximumExecutionFrequency)

      The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

      Parameters:
      maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceTypesScope

      OrganizationCustomPolicyRuleMetadata.Builder resourceTypesScope(Collection<String> resourceTypesScope)

      The type of the Amazon Web Services resource that was evaluated.

      Parameters:
      resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceTypesScope

      OrganizationCustomPolicyRuleMetadata.Builder resourceTypesScope(String... resourceTypesScope)

      The type of the Amazon Web Services resource that was evaluated.

      Parameters:
      resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceIdScope

      OrganizationCustomPolicyRuleMetadata.Builder resourceIdScope(String resourceIdScope)

      The ID of the Amazon Web Services resource that was evaluated.

      Parameters:
      resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagKeyScope

      OrganizationCustomPolicyRuleMetadata.Builder tagKeyScope(String tagKeyScope)

      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      Parameters:
      tagKeyScope - One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagValueScope

      OrganizationCustomPolicyRuleMetadata.Builder tagValueScope(String tagValueScope)

      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      Parameters:
      tagValueScope - The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyRuntime

      OrganizationCustomPolicyRuleMetadata.Builder policyRuntime(String policyRuntime)

      The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

      Parameters:
      policyRuntime - The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyText

      OrganizationCustomPolicyRuleMetadata.Builder policyText(String policyText)

      The policy definition containing the logic for your organization Config Custom Policy rule.

      Parameters:
      policyText - The policy definition containing the logic for your organization Config Custom Policy rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugLogDeliveryAccounts

      OrganizationCustomPolicyRuleMetadata.Builder debugLogDeliveryAccounts(Collection<String> debugLogDeliveryAccounts)

      A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

      Parameters:
      debugLogDeliveryAccounts - A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugLogDeliveryAccounts

      OrganizationCustomPolicyRuleMetadata.Builder debugLogDeliveryAccounts(String... debugLogDeliveryAccounts)

      A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

      Parameters:
      debugLogDeliveryAccounts - A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.