Package software.amazon.awssdk.services.cloudwatchlogs.model

Class PutDestinationPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutDestinationPolicyRequest.Builder,PutDestinationPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutDestinationPolicyRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<PutDestinationPolicyRequest.Builder,PutDestinationPolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutDestinationPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessPolicy()	An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination.
static PutDestinationPolicyRequest.Builder	builder()
String	destinationName()	A name for an existing destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	forceUpdate()	Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutDestinationPolicyRequest.Builder>	serializableBuilderClass()
PutDestinationPolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

destinationName

public final String destinationName()

A name for an existing destination.

Returns:

A name for an existing destination.

accessPolicy

public final String accessPolicy()

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

Returns:

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

forceUpdate

public final Boolean forceUpdate()

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of false is used.

Returns:

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of false is used.

toBuilder

public PutDestinationPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutDestinationPolicyRequest.Builder,PutDestinationPolicyRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static PutDestinationPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutDestinationPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo