@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DeliveryDestination extends Object implements Serializable, Cloneable, StructuredPojo
This structure contains information about one delivery destination in your account. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery .
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Constructor and Description |
---|
DeliveryDestination() |
Modifier and Type | Method and Description |
---|---|
DeliveryDestination |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
DeliveryDestination |
clearTagsEntries()
Removes all the entries added into Tags.
|
DeliveryDestination |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
|
DeliveryDestinationConfiguration |
getDeliveryDestinationConfiguration()
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
|
String |
getDeliveryDestinationType()
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
|
String |
getName()
The name of this delivery destination.
|
String |
getOutputFormat()
The format of the logs that are sent to this delivery destination.
|
Map<String,String> |
getTags()
The tags that have been assigned to this delivery destination.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
|
void |
setDeliveryDestinationConfiguration(DeliveryDestinationConfiguration deliveryDestinationConfiguration)
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
|
void |
setDeliveryDestinationType(String deliveryDestinationType)
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
|
void |
setName(String name)
The name of this delivery destination.
|
void |
setOutputFormat(String outputFormat)
The format of the logs that are sent to this delivery destination.
|
void |
setTags(Map<String,String> tags)
The tags that have been assigned to this delivery destination.
|
String |
toString()
Returns a string representation of this object.
|
DeliveryDestination |
withArn(String arn)
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
|
DeliveryDestination |
withDeliveryDestinationConfiguration(DeliveryDestinationConfiguration deliveryDestinationConfiguration)
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
|
DeliveryDestination |
withDeliveryDestinationType(DeliveryDestinationType deliveryDestinationType)
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
|
DeliveryDestination |
withDeliveryDestinationType(String deliveryDestinationType)
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
|
DeliveryDestination |
withName(String name)
The name of this delivery destination.
|
DeliveryDestination |
withOutputFormat(OutputFormat outputFormat)
The format of the logs that are sent to this delivery destination.
|
DeliveryDestination |
withOutputFormat(String outputFormat)
The format of the logs that are sent to this delivery destination.
|
DeliveryDestination |
withTags(Map<String,String> tags)
The tags that have been assigned to this delivery destination.
|
public void setName(String name)
The name of this delivery destination.
name
- The name of this delivery destination.public String getName()
The name of this delivery destination.
public DeliveryDestination withName(String name)
The name of this delivery destination.
name
- The name of this delivery destination.public void setArn(String arn)
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
arn
- The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.public String getArn()
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
public DeliveryDestination withArn(String arn)
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
arn
- The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.public void setDeliveryDestinationType(String deliveryDestinationType)
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
deliveryDestinationType
- Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.DeliveryDestinationType
public String getDeliveryDestinationType()
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
DeliveryDestinationType
public DeliveryDestination withDeliveryDestinationType(String deliveryDestinationType)
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
deliveryDestinationType
- Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.DeliveryDestinationType
public DeliveryDestination withDeliveryDestinationType(DeliveryDestinationType deliveryDestinationType)
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
deliveryDestinationType
- Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.DeliveryDestinationType
public void setOutputFormat(String outputFormat)
The format of the logs that are sent to this delivery destination.
outputFormat
- The format of the logs that are sent to this delivery destination.OutputFormat
public String getOutputFormat()
The format of the logs that are sent to this delivery destination.
OutputFormat
public DeliveryDestination withOutputFormat(String outputFormat)
The format of the logs that are sent to this delivery destination.
outputFormat
- The format of the logs that are sent to this delivery destination.OutputFormat
public DeliveryDestination withOutputFormat(OutputFormat outputFormat)
The format of the logs that are sent to this delivery destination.
outputFormat
- The format of the logs that are sent to this delivery destination.OutputFormat
public void setDeliveryDestinationConfiguration(DeliveryDestinationConfiguration deliveryDestinationConfiguration)
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
deliveryDestinationConfiguration
- A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.public DeliveryDestinationConfiguration getDeliveryDestinationConfiguration()
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
public DeliveryDestination withDeliveryDestinationConfiguration(DeliveryDestinationConfiguration deliveryDestinationConfiguration)
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
deliveryDestinationConfiguration
- A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.public Map<String,String> getTags()
The tags that have been assigned to this delivery destination.
public void setTags(Map<String,String> tags)
The tags that have been assigned to this delivery destination.
tags
- The tags that have been assigned to this delivery destination.public DeliveryDestination withTags(Map<String,String> tags)
The tags that have been assigned to this delivery destination.
tags
- The tags that have been assigned to this delivery destination.public DeliveryDestination addTagsEntry(String key, String value)
public DeliveryDestination clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public DeliveryDestination clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.