Class OrganizationManagedRuleMetadata
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OrganizationManagedRuleMetadata.Builder,
OrganizationManagedRuleMetadata>
An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The description that you provide for your organization Config rule.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResourceTypesScope property.final String
A string, in JSON format, that is passed to your organization Config rule Lambda function.The maximum frequency with which Config runs evaluations for a rule.final String
The maximum frequency with which Config runs evaluations for a rule.final String
The ID of the Amazon Web Services resource that was evaluated.The type of the Amazon Web Services resource that was evaluated.final String
For organization config managed rules, a predefined identifier from a list.static Class
<? extends OrganizationManagedRuleMetadata.Builder> final String
One part of a key-value pair that make up a tag.final String
The optional part of a key-value pair that make up a tag.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
description
The description that you provide for your organization Config rule.
- Returns:
- The description that you provide for your organization Config rule.
-
ruleIdentifier
For organization config managed rules, a predefined identifier from a list. For example,
IAM_PASSWORD_POLICY
is a managed rule. To reference a managed rule, see Using Config managed rules.- Returns:
- For organization config managed rules, a predefined identifier from a list. For example,
IAM_PASSWORD_POLICY
is a managed rule. To reference a managed rule, see Using Config managed rules.
-
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
The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.
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 returnMaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommaximumExecutionFrequencyAsString()
.- Returns:
- The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule
that is triggered at a periodic frequency.
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
The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.
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 returnMaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommaximumExecutionFrequencyAsString()
.- Returns:
- The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule
that is triggered at a periodic frequency.
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 theisEmpty()
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
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
The ID of the Amazon Web Services resource that was evaluated.
- Returns:
- The ID of the Amazon Web Services resource that was evaluated.
-
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
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
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 interfaceToCopyableBuilder<OrganizationManagedRuleMetadata.Builder,
OrganizationManagedRuleMetadata> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-