software.amazon.awssdk.services.cloudwatchlogs.model.PutResourcePolicyRequest Maven / Gradle / Ivy
Show all versions of cloudwatchlogs Show documentation
/*
* 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 PutResourcePolicyRequest extends CloudWatchLogsRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("policyName").getter(getter(PutResourcePolicyRequest::policyName)).setter(setter(Builder::policyName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("policyName").build()).build();
private static final SdkField POLICY_DOCUMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("policyDocument").getter(getter(PutResourcePolicyRequest::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(POLICY_NAME_FIELD,
POLICY_DOCUMENT_FIELD));
private final String policyName;
private final String policyDocument;
private PutResourcePolicyRequest(BuilderImpl builder) {
super(builder);
this.policyName = builder.policyName;
this.policyDocument = builder.policyDocument;
}
/**
*
* Name of the new policy. This parameter is required.
*
*
* @return Name of the new policy. This parameter is required.
*/
public final String policyName() {
return policyName;
}
/**
*
* Details of the new policy, including the identity of the principal that is enabled to put logs to this account.
* This is formatted as a JSON string. This parameter is required.
*
*
* The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the
* specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log
* group or log stream.
*
*
* { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }
*
*
* @return Details of the new policy, including the identity of the principal that is enabled to put logs to this
* account. This is formatted as a JSON string. This parameter is required.
*
* The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to
* the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource,
* such as a log group or log stream.
*
*
* { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }
*/
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(policyName());
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 PutResourcePolicyRequest)) {
return false;
}
PutResourcePolicyRequest other = (PutResourcePolicyRequest) obj;
return Objects.equals(policyName(), other.policyName()) && 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("PutResourcePolicyRequest").add("PolicyName", policyName())
.add("PolicyDocument", policyDocument()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "policyName":
return Optional.ofNullable(clazz.cast(policyName()));
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((PutResourcePolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Name of the new policy. This parameter is required.
*
*
* @param policyName
* Name of the new policy. This parameter is required.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyName(String policyName);
/**
*
* Details of the new policy, including the identity of the principal that is enabled to put logs to this
* account. This is formatted as a JSON string. This parameter is required.
*
*
* The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the
* specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a
* log group or log stream.
*
*
* { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }
*
*
* @param policyDocument
* Details of the new policy, including the identity of the principal that is enabled to put logs to this
* account. This is formatted as a JSON string. This parameter is required.
*
* The following example creates a resource policy enabling the Route 53 service to put DNS query logs in
* to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs
* resource, such as a log group or log stream.
*
*
* { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }
* @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 policyName;
private String policyDocument;
private BuilderImpl() {
}
private BuilderImpl(PutResourcePolicyRequest model) {
super(model);
policyName(model.policyName);
policyDocument(model.policyDocument);
}
public final String getPolicyName() {
return policyName;
}
@Override
public final Builder policyName(String policyName) {
this.policyName = policyName;
return this;
}
public final void setPolicyName(String policyName) {
this.policyName = policyName;
}
public final String getPolicyDocument() {
return policyDocument;
}
@Override
public final Builder policyDocument(String policyDocument) {
this.policyDocument = policyDocument;
return this;
}
public final void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutResourcePolicyRequest build() {
return new PutResourcePolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}