software.amazon.awssdk.services.config.model

Class OrganizationManagedRuleMetadata

java.lang.Object

software.amazon.awssdk.services.config.model.OrganizationManagedRuleMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrganizationManagedRuleMetadata.Builder,OrganizationManagedRuleMetadata>

@Generated(value="software.amazon.awssdk:codegen")
public final class OrganizationManagedRuleMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationManagedRuleMetadata.Builder,OrganizationManagedRuleMetadata>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OrganizationManagedRuleMetadata.Builder

Method Summary

Modifier and Type	Method and Description
static OrganizationManagedRuleMetadata.Builder	builder()
String	description() The description that you provide for your organization Config rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceTypesScope() For responses, this returns true if the service returned a value for the ResourceTypesScope property.
String	inputParameters() A string, in JSON format, that is passed to your organization Config rule Lambda function.
MaximumExecutionFrequency	maximumExecutionFrequency() The maximum frequency with which Config runs evaluations for a rule.
String	maximumExecutionFrequencyAsString() The maximum frequency with which Config runs evaluations for a rule.
String	resourceIdScope() The ID of the Amazon Web Services resource that was evaluated.
List<String>	resourceTypesScope() The type of the Amazon Web Services resource that was evaluated.
String	ruleIdentifier() For organization config managed rules, a predefined identifier from a list.
List<SdkField<?>>	sdkFields()
static Class<? extends OrganizationManagedRuleMetadata.Builder>	serializableBuilderClass()
String	tagKeyScope() One part of a key-value pair that make up a tag.
String	tagValueScope() The optional part of a key-value pair that make up a tag.
OrganizationManagedRuleMetadata.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

ruleIdentifier

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

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

MaximumExecutionFrequency

maximumExecutionFrequencyAsString

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

MaximumExecutionFrequency

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 OrganizationManagedRuleMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OrganizationManagedRuleMetadata.Builder,OrganizationManagedRuleMetadata>

builder

public static OrganizationManagedRuleMetadata.Builder builder()

serializableBuilderClass

public static Class<? extends OrganizationManagedRuleMetadata.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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