software.amazon.awssdk.services.auditmanager.model

Class SourceKeyword

java.lang.Object

software.amazon.awssdk.services.auditmanager.model.SourceKeyword

All Implemented Interfaces:

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

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

The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide:

• Config rules supported by Audit Manager

• Security Hub controls supported by Audit Manager

• API calls supported by Audit Manager

• CloudTrail event names supported by Audit Manager

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SourceKeyword.Builder

Method Summary

Modifier and Type	Method and Description
static SourceKeyword.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KeywordInputType	keywordInputType() The input method for the keyword.
String	keywordInputTypeAsString() The input method for the keyword.
String	keywordValue() The value of the keyword that's used when mapping a control data source.
List<SdkField<?>>	sdkFields()
static Class<? extends SourceKeyword.Builder>	serializableBuilderClass()
SourceKeyword.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

keywordInputType

public final KeywordInputType keywordInputType()

The input method for the keyword.

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

Returns:

The input method for the keyword.

See Also:

KeywordInputType

keywordInputTypeAsString

public final String keywordInputTypeAsString()

The input method for the keyword.

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

Returns:

The input method for the keyword.

See Also:

KeywordInputType

keywordValue

public final String keywordValue()

The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:

• For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules.

  • Managed rule name: s3-bucket-acl-prohibited

    keywordValue: S3_BUCKET_ACL_PROHIBITED

• For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.

  • Custom rule name: my-custom-config-rule

    keywordValue: Custom_my-custom-config-rule

• For service -linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.

  • Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w

    keywordValue: Custom_CustomRuleForAccount-conformance-pack

  • Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

Returns:

The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:

• For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules.

  • Managed rule name: s3-bucket-acl-prohibited

    keywordValue: S3_BUCKET_ACL_PROHIBITED

• For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.

  • Custom rule name: my-custom-config-rule

    keywordValue: Custom_my-custom-config-rule

• For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.

  • Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w

    keywordValue: Custom_CustomRuleForAccount-conformance-pack

  • Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

toBuilder

public SourceKeyword.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SourceKeyword.Builder,SourceKeyword>

builder

public static SourceKeyword.Builder builder()

serializableBuilderClass

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