com.amazonaws.services.logs.model

Class PutDestinationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutDestinationRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PutDestinationRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutDestinationRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutDestinationRequest

public PutDestinationRequest()

Method Detail

getDestinationName

public java.lang.String getDestinationName()

A name for the destination.

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

Returns:

A name for the destination.

setDestinationName

public void setDestinationName(java.lang.String destinationName)

A name for the destination.

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

Parameters:

destinationName -

A name for the destination.

withDestinationName

public PutDestinationRequest withDestinationName(java.lang.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 java.lang.String getTargetArn()

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

Constraints:
Length: 1 -

Returns:

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

setTargetArn

public void setTargetArn(java.lang.String targetArn)

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

Constraints:
Length: 1 -

Parameters:

targetArn -

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

withTargetArn

public PutDestinationRequest withTargetArn(java.lang.String targetArn)

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

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 which to deliver matching log events.

Returns:

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

getRoleArn

public java.lang.String getRoleArn()

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Constraints:
Length: 1 -

Returns:

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Constraints:
Length: 1 -

Parameters:

roleArn -

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

withRoleArn

public PutDestinationRequest withRoleArn(java.lang.String roleArn)

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination 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 CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object