software.amazon.awssdk.services.cloudwatchlogs.model.PutDataProtectionPolicyRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.cloudwatchlogs.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutDataProtectionPolicyRequest extends CloudWatchLogsRequest implements
ToCopyableBuilder {
private static final SdkField LOG_GROUP_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("logGroupIdentifier").getter(getter(PutDataProtectionPolicyRequest::logGroupIdentifier))
.setter(setter(Builder::logGroupIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logGroupIdentifier").build())
.build();
private static final SdkField POLICY_DOCUMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("policyDocument").getter(getter(PutDataProtectionPolicyRequest::policyDocument))
.setter(setter(Builder::policyDocument))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("policyDocument").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LOG_GROUP_IDENTIFIER_FIELD,
POLICY_DOCUMENT_FIELD));
private final String logGroupIdentifier;
private final String policyDocument;
private PutDataProtectionPolicyRequest(BuilderImpl builder) {
super(builder);
this.logGroupIdentifier = builder.logGroupIdentifier;
this.policyDocument = builder.policyDocument;
}
/**
*
* Specify either the log group name or log group ARN.
*
*
* @return Specify either the log group name or log group ARN.
*/
public final String logGroupIdentifier() {
return logGroupIdentifier;
}
/**
*
* Specify the data protection policy, in JSON.
*
*
* This policy must include two JSON blocks:
*
*
* -
*
* The first block must include both a DataIdentifer array and an Operation property with
* an Audit action. The DataIdentifer array lists the types of sensitive data that you
* want to mask. For more information about the available options, see Types of data
* that you can mask.
*
*
* The Operation property with an Audit action is required to find the sensitive data
* terms. This Audit action must contain a FindingsDestination object. You can optionally
* use that FindingsDestination object to list one or more destinations to send audit findings to. If
* you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist.
*
*
* -
*
* The second block must include both a DataIdentifer array and an Operation property with
* an Deidentify action. The DataIdentifer array must exactly match the
* DataIdentifer array in the first block of the policy.
*
*
* The Operation property with the Deidentify action is what actually masks the data, and
* it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be
* empty.
*
*
*
*
* For an example data protection policy, see the Examples section on this page.
*
*
*
* The contents of the two DataIdentifer arrays must match exactly.
*
*
*
* In addition to the two JSON blocks, the policyDocument can also include Name,
* Description, and Version fields. The Name is used as a dimension when
* CloudWatch Logs reports audit findings metrics to CloudWatch.
*
*
* The JSON specified in policyDocument can be up to 30,720 characters.
*
*
* @return Specify the data protection policy, in JSON.
*
* This policy must include two JSON blocks:
*
*
* -
*
* The first block must include both a DataIdentifer array and an Operation
* property with an Audit action. The DataIdentifer array lists the types of
* sensitive data that you want to mask. For more information about the available options, see Types
* of data that you can mask.
*
*
* The Operation property with an Audit action is required to find the sensitive
* data terms. This Audit action must contain a FindingsDestination object. You
* can optionally use that FindingsDestination object to list one or more destinations to send
* audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they
* must already exist.
*
*
* -
*
* The second block must include both a DataIdentifer array and an Operation
* property with an Deidentify action. The DataIdentifer array must exactly match
* the DataIdentifer array in the first block of the policy.
*
*
* The Operation property with the Deidentify action is what actually masks the
* data, and it must contain the "MaskConfig": {} object. The "MaskConfig": {}
* object must be empty.
*
*
*
*
* For an example data protection policy, see the Examples section on this page.
*
*
*
* The contents of the two DataIdentifer arrays must match exactly.
*
*
*
* In addition to the two JSON blocks, the policyDocument can also include Name,
* Description, and Version fields. The Name is used as a dimension
* when CloudWatch Logs reports audit findings metrics to CloudWatch.
*
*
* The JSON specified in policyDocument can be up to 30,720 characters.
*/
public final String policyDocument() {
return policyDocument;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(logGroupIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(policyDocument());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutDataProtectionPolicyRequest)) {
return false;
}
PutDataProtectionPolicyRequest other = (PutDataProtectionPolicyRequest) obj;
return Objects.equals(logGroupIdentifier(), other.logGroupIdentifier())
&& Objects.equals(policyDocument(), other.policyDocument());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PutDataProtectionPolicyRequest").add("LogGroupIdentifier", logGroupIdentifier())
.add("PolicyDocument", policyDocument()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "logGroupIdentifier":
return Optional.ofNullable(clazz.cast(logGroupIdentifier()));
case "policyDocument":
return Optional.ofNullable(clazz.cast(policyDocument()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutDataProtectionPolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchLogsRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Specify either the log group name or log group ARN.
*
*
* @param logGroupIdentifier
* Specify either the log group name or log group ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logGroupIdentifier(String logGroupIdentifier);
/**
*
* Specify the data protection policy, in JSON.
*
*
* This policy must include two JSON blocks:
*
*
* -
*
* The first block must include both a DataIdentifer array and an Operation property
* with an Audit action. The DataIdentifer array lists the types of sensitive data
* that you want to mask. For more information about the available options, see Types of
* data that you can mask.
*
*
* The Operation property with an Audit action is required to find the sensitive data
* terms. This Audit action must contain a FindingsDestination object. You can
* optionally use that FindingsDestination object to list one or more destinations to send audit
* findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must
* already exist.
*
*
* -
*
* The second block must include both a DataIdentifer array and an Operation property
* with an Deidentify action. The DataIdentifer array must exactly match the
* DataIdentifer array in the first block of the policy.
*
*
* The Operation property with the Deidentify action is what actually masks the data,
* and it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must
* be empty.
*
*
*
*
* For an example data protection policy, see the Examples section on this page.
*
*
*
* The contents of the two DataIdentifer arrays must match exactly.
*
*
*
* In addition to the two JSON blocks, the policyDocument can also include Name,
* Description, and Version fields. The Name is used as a dimension when
* CloudWatch Logs reports audit findings metrics to CloudWatch.
*
*
* The JSON specified in policyDocument can be up to 30,720 characters.
*
*
* @param policyDocument
* Specify the data protection policy, in JSON.
*
* This policy must include two JSON blocks:
*
*
* -
*
* The first block must include both a DataIdentifer array and an Operation
* property with an Audit action. The DataIdentifer array lists the types of
* sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.
*
*
* The Operation property with an Audit action is required to find the
* sensitive data terms. This Audit action must contain a FindingsDestination
* object. You can optionally use that FindingsDestination object to list one or more
* destinations to send audit findings to. If you specify destinations such as log groups, Firehose
* streams, and S3 buckets, they must already exist.
*
*
* -
*
* The second block must include both a DataIdentifer array and an Operation
* property with an Deidentify action. The DataIdentifer array must exactly
* match the DataIdentifer array in the first block of the policy.
*
*
* The Operation property with the Deidentify action is what actually masks the
* data, and it must contain the "MaskConfig": {} object. The
* "MaskConfig": {} object must be empty.
*
*
*
*
* For an example data protection policy, see the Examples section on this page.
*
*
*
* The contents of the two DataIdentifer arrays must match exactly.
*
*
*
* In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is used as a
* dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.
*
*
* The JSON specified in policyDocument can be up to 30,720 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyDocument(String policyDocument);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudWatchLogsRequest.BuilderImpl implements Builder {
private String logGroupIdentifier;
private String policyDocument;
private BuilderImpl() {
}
private BuilderImpl(PutDataProtectionPolicyRequest model) {
super(model);
logGroupIdentifier(model.logGroupIdentifier);
policyDocument(model.policyDocument);
}
public final String getLogGroupIdentifier() {
return logGroupIdentifier;
}
public final void setLogGroupIdentifier(String logGroupIdentifier) {
this.logGroupIdentifier = logGroupIdentifier;
}
@Override
public final Builder logGroupIdentifier(String logGroupIdentifier) {
this.logGroupIdentifier = logGroupIdentifier;
return this;
}
public final String getPolicyDocument() {
return policyDocument;
}
public final void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
@Override
public final Builder policyDocument(String policyDocument) {
this.policyDocument = policyDocument;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutDataProtectionPolicyRequest build() {
return new PutDataProtectionPolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}