com.amazonaws.services.logs.model

Class PutDestinationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutDestinationRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutDestinationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutDestination operation.

Creates or updates a Destination . A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through PutLogEvents requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.

A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call PutSubscriptionFilter against this destination. To enable that, the destination owner must call PutDestinationPolicy after PutDestination.

See Also:

AWSLogs.putDestination(PutDestinationRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutDestinationRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutDestinationRequest	clone()
boolean	equals(Object obj)
String	getDestinationName() A name for the destination.
String	getRoleArn() The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
String	getTargetArn() The ARN of an Amazon Kinesis stream to deliver matching log events to.
int	hashCode()
void	setDestinationName(String destinationName) A name for the destination.
void	setRoleArn(String roleArn) The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
void	setTargetArn(String targetArn) The ARN of an Amazon Kinesis stream to deliver matching log events to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutDestinationRequest	withDestinationName(String destinationName) A name for the destination.
PutDestinationRequest	withRoleArn(String roleArn) The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
PutDestinationRequest	withTargetArn(String targetArn) The ARN of an Amazon Kinesis stream to deliver matching log events to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutDestinationRequest

public PutDestinationRequest()

Method Detail

getDestinationName

public String getDestinationName()

A name for the destination.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Returns:

A name for the destination.

setDestinationName

public void setDestinationName(String destinationName)

A name for the destination.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

destinationName - A name for the destination.

withDestinationName

public PutDestinationRequest withDestinationName(String destinationName)

A name for the destination.

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

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

destinationName - A name for the destination.

Returns:

A reference to this updated object so that method calls can be chained together.

getTargetArn

public String getTargetArn()

The ARN of an Amazon Kinesis stream to deliver matching log events to.

Constraints:
Length: 1 -

Returns:

The ARN of an Amazon Kinesis stream to deliver matching log events to.

setTargetArn

public void setTargetArn(String targetArn)

The ARN of an Amazon Kinesis stream to deliver matching log events to.

Constraints:
Length: 1 -

Parameters:

targetArn - The ARN of an Amazon Kinesis stream to deliver matching log events to.

withTargetArn

public PutDestinationRequest withTargetArn(String targetArn)

The ARN of an Amazon Kinesis stream to deliver matching log events to.

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

Constraints:
Length: 1 -

Parameters:

targetArn - The ARN of an Amazon Kinesis stream to deliver matching log events to.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public String getRoleArn()

The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

Constraints:
Length: 1 -

Returns:

The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

setRoleArn

public void setRoleArn(String roleArn)

The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

Constraints:
Length: 1 -

Parameters:

roleArn - The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

withRoleArn

public PutDestinationRequest withRoleArn(String roleArn)

The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

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

Constraints:
Length: 1 -

Parameters:

roleArn - The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PutDestinationRequest clone()

Overrides:

clone in class AmazonWebServiceRequest