com.amazonaws.services.auditmanager.model

Class SourceKeyword

java.lang.Object

com.amazonaws.services.auditmanager.model.SourceKeyword

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SourceKeyword
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SourceKeyword()

Method Summary

Modifier and Type	Method and Description
SourceKeyword	clone()
boolean	equals(Object obj)
String	getKeywordInputType() The input method for the keyword.
String	getKeywordValue() The value of the keyword that's used when mapping a control data source.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setKeywordInputType(String keywordInputType) The input method for the keyword.
void	setKeywordValue(String keywordValue) The value of the keyword that's used when mapping a control data source.
String	toString() Returns a string representation of this object.
SourceKeyword	withKeywordInputType(KeywordInputType keywordInputType) The input method for the keyword.
SourceKeyword	withKeywordInputType(String keywordInputType) The input method for the keyword.
SourceKeyword	withKeywordValue(String keywordValue) The value of the keyword that's used when mapping a control data source.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SourceKeyword

public SourceKeyword()

Method Detail

setKeywordInputType

public void setKeywordInputType(String keywordInputType)

The input method for the keyword.

Parameters:

keywordInputType - The input method for the keyword.

See Also:

KeywordInputType

getKeywordInputType

public String getKeywordInputType()

The input method for the keyword.

Returns:

The input method for the keyword.

See Also:

KeywordInputType

withKeywordInputType

public SourceKeyword withKeywordInputType(String keywordInputType)

The input method for the keyword.

Parameters:

keywordInputType - The input method for the keyword.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

KeywordInputType

withKeywordInputType

public SourceKeyword withKeywordInputType(KeywordInputType keywordInputType)

The input method for the keyword.

Parameters:

keywordInputType - The input method for the keyword.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

KeywordInputType

setKeywordValue

public void setKeywordValue(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: securityhub-api-gw-cache-encrypted-101104e1

    keywordValue: Custom_securityhub-api-gw-cache-encrypted

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

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

Parameters:

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: securityhub-api-gw-cache-encrypted-101104e1

    keywordValue: Custom_securityhub-api-gw-cache-encrypted

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

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

getKeywordValue

public String getKeywordValue()

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: securityhub-api-gw-cache-encrypted-101104e1

    keywordValue: Custom_securityhub-api-gw-cache-encrypted

  • 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: securityhub-api-gw-cache-encrypted-101104e1

    keywordValue: Custom_securityhub-api-gw-cache-encrypted

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

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

withKeywordValue

public SourceKeyword withKeywordValue(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: securityhub-api-gw-cache-encrypted-101104e1

    keywordValue: Custom_securityhub-api-gw-cache-encrypted

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

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

Parameters:

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: securityhub-api-gw-cache-encrypted-101104e1

    keywordValue: Custom_securityhub-api-gw-cache-encrypted

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

    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SourceKeyword clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.