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

Class PutOrganizationConfigRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.config.model.ConfigRequest

software.amazon.awssdk.services.config.model.PutOrganizationConfigRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutOrganizationConfigRuleRequest.Builder,PutOrganizationConfigRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutOrganizationConfigRuleRequest
extends ConfigRequest
implements ToCopyableBuilder<PutOrganizationConfigRuleRequest.Builder,PutOrganizationConfigRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutOrganizationConfigRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutOrganizationConfigRuleRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	excludedAccounts()	A comma-separated list of accounts that you want to exclude from an organization Config rule.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludedAccounts()	For responses, this returns true if the service returned a value for the ExcludedAccounts property.
int	hashCode()
String	organizationConfigRuleName()	The name that you assign to an organization Config rule.
OrganizationCustomPolicyRuleMetadata	organizationCustomPolicyRuleMetadata()	An OrganizationCustomPolicyRuleMetadata object.
OrganizationCustomRuleMetadata	organizationCustomRuleMetadata()	An OrganizationCustomRuleMetadata object.
OrganizationManagedRuleMetadata	organizationManagedRuleMetadata()	An OrganizationManagedRuleMetadata object.
List<SdkField<?>>	sdkFields()
static Class<? extends PutOrganizationConfigRuleRequest.Builder>	serializableBuilderClass()
PutOrganizationConfigRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

organizationConfigRuleName

public final String organizationConfigRuleName()

The name that you assign to an organization Config rule.

Returns:

The name that you assign to an organization Config rule.

organizationManagedRuleMetadata

public final OrganizationManagedRuleMetadata organizationManagedRuleMetadata()

An OrganizationManagedRuleMetadata object. This object 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.

Returns:

An OrganizationManagedRuleMetadata object. This object 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.

organizationCustomRuleMetadata

public final OrganizationCustomRuleMetadata organizationCustomRuleMetadata()

An OrganizationCustomRuleMetadata object. This object 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.

Returns:

An OrganizationCustomRuleMetadata object. This object 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.

hasExcludedAccounts

public final boolean hasExcludedAccounts()

For responses, this returns true if the service returned a value for the ExcludedAccounts 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.

excludedAccounts

public final List<String> excludedAccounts()

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

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 hasExcludedAccounts() method.

Returns:

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

organizationCustomPolicyRuleMetadata

public final OrganizationCustomPolicyRuleMetadata organizationCustomPolicyRuleMetadata()

An OrganizationCustomPolicyRuleMetadata object. This object 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.

Returns:

An OrganizationCustomPolicyRuleMetadata object. This object 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.

toBuilder

public PutOrganizationConfigRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutOrganizationConfigRuleRequest.Builder,PutOrganizationConfigRuleRequest>

Specified by:

toBuilder in class ConfigRequest

builder

public static PutOrganizationConfigRuleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo