com.amazonaws.services.auditmanager.model.SourceKeyword Maven / Gradle / Ivy
Show all versions of aws-java-sdk-auditmanager Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.auditmanager.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SourceKeyword implements Serializable, Cloneable, StructuredPojo {
/**
*
* The input method for the keyword.
*
*/
private String keywordInputType;
/**
*
* 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
*
*
*
*
*
*/
private String keywordValue;
/**
*
* The input method for the keyword.
*
*
* @param keywordInputType
* The input method for the keyword.
* @see KeywordInputType
*/
public void setKeywordInputType(String keywordInputType) {
this.keywordInputType = keywordInputType;
}
/**
*
* The input method for the keyword.
*
*
* @return The input method for the keyword.
* @see KeywordInputType
*/
public String getKeywordInputType() {
return this.keywordInputType;
}
/**
*
* The input method for the keyword.
*
*
* @param keywordInputType
* The input method for the keyword.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeywordInputType
*/
public SourceKeyword withKeywordInputType(String keywordInputType) {
setKeywordInputType(keywordInputType);
return this;
}
/**
*
* The input method for the keyword.
*
*
* @param keywordInputType
* The input method for the keyword.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeywordInputType
*/
public SourceKeyword withKeywordInputType(KeywordInputType keywordInputType) {
this.keywordInputType = keywordInputType.toString();
return this;
}
/**
*
* 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
*
*
*
*
*
*
* @param 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
*
*
*
*
*/
public void setKeywordValue(String keywordValue) {
this.keywordValue = 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
*
*
*
*
*
*
* @return 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
*
*
*
*
*/
public String getKeywordValue() {
return this.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
*
*
*
*
*
*
* @param 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
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SourceKeyword withKeywordValue(String keywordValue) {
setKeywordValue(keywordValue);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKeywordInputType() != null)
sb.append("KeywordInputType: ").append(getKeywordInputType()).append(",");
if (getKeywordValue() != null)
sb.append("KeywordValue: ").append(getKeywordValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SourceKeyword == false)
return false;
SourceKeyword other = (SourceKeyword) obj;
if (other.getKeywordInputType() == null ^ this.getKeywordInputType() == null)
return false;
if (other.getKeywordInputType() != null && other.getKeywordInputType().equals(this.getKeywordInputType()) == false)
return false;
if (other.getKeywordValue() == null ^ this.getKeywordValue() == null)
return false;
if (other.getKeywordValue() != null && other.getKeywordValue().equals(this.getKeywordValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeywordInputType() == null) ? 0 : getKeywordInputType().hashCode());
hashCode = prime * hashCode + ((getKeywordValue() == null) ? 0 : getKeywordValue().hashCode());
return hashCode;
}
@Override
public SourceKeyword clone() {
try {
return (SourceKeyword) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.auditmanager.model.transform.SourceKeywordMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}