Class OrganizationCustomRuleMetadata

java.lang.Object
software.amazon.awssdk.services.config.model.OrganizationCustomRuleMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OrganizationCustomRuleMetadata.Builder,OrganizationCustomRuleMetadata>
@Generated("software.amazon.awssdk:codegen") public final class OrganizationCustomRuleMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationCustomRuleMetadata.Builder,OrganizationCustomRuleMetadata>

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger 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.

See Also:

  • Method Details

    • description

      public final String description()

      The description that you provide for your organization Config rule.

      Returns:
      The description that you provide for your organization Config rule.

    • lambdaFunctionArn

      public final String lambdaFunctionArn()

      The lambda function ARN.

      Returns:
      The lambda function ARN.

    • organizationConfigRuleTriggerTypes

      public final List<OrganizationConfigRuleTriggerType> organizationConfigRuleTriggerTypes()

      The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

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

      • OversizedConfigurationItemChangeNotification - Triggers 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.

      • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationConfigRuleTriggerTypes() method.

      Returns:
      The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

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

      • OversizedConfigurationItemChangeNotification - Triggers 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.

      • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

    • hasOrganizationConfigRuleTriggerTypes

      public final boolean hasOrganizationConfigRuleTriggerTypes()
      For responses, this returns true if the service returned a value for the OrganizationConfigRuleTriggerTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • organizationConfigRuleTriggerTypesAsStrings

      public final List<String> organizationConfigRuleTriggerTypesAsStrings()

      The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

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

      • OversizedConfigurationItemChangeNotification - Triggers 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.

      • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationConfigRuleTriggerTypes() method.

      Returns:
      The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

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

      • OversizedConfigurationItemChangeNotification - Triggers 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.

      • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

    • inputParameters

      public final String inputParameters()

      A string, in JSON format, that is passed to your organization Config rule Lambda function.

      Returns:
      A string, in JSON format, that is passed to your organization Config rule Lambda function.

    • maximumExecutionFrequency

      public final MaximumExecutionFrequency maximumExecutionFrequency()

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

      By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

      If the service returns an enum value that is not available in the current SDK version, maximumExecutionFrequency will return MaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maximumExecutionFrequencyAsString().

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

      By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

      See Also:

    • maximumExecutionFrequencyAsString

      public final String maximumExecutionFrequencyAsString()

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

      By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

      If the service returns an enum value that is not available in the current SDK version, maximumExecutionFrequency will return MaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maximumExecutionFrequencyAsString().

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

      By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

      See Also:

    • hasResourceTypesScope

      public final boolean hasResourceTypesScope()
      For responses, this returns true if the service returned a value for the ResourceTypesScope property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resourceTypesScope

      public final List<String> resourceTypesScope()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTypesScope() method.

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

    • resourceIdScope

      public final String resourceIdScope()

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

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

    • tagKeyScope

      public final 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.

      Returns:
      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.

    • tagValueScope

      public final 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).

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

    • toBuilder

      public OrganizationCustomRuleMetadata.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OrganizationCustomRuleMetadata.Builder,OrganizationCustomRuleMetadata>
      Returns:
      a builder for type T

    • builder

      public static OrganizationCustomRuleMetadata.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OrganizationCustomRuleMetadata.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.