Class DeliveryDestination

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.DeliveryDestination
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeliveryDestination.Builder,DeliveryDestination>
@Generated("software.amazon.awssdk:codegen") public final class DeliveryDestination extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeliveryDestination.Builder,DeliveryDestination>

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, Firehose, and X-Ray are supported as 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.

See Also:

  • Method Details

    • name

      public final String name()

      The name of this delivery destination.

      Returns:
      The name of this delivery destination.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

    • deliveryDestinationType

      public final DeliveryDestinationType deliveryDestinationType()

      Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

      If the service returns an enum value that is not available in the current SDK version, deliveryDestinationType will return DeliveryDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryDestinationTypeAsString().

      Returns:
      Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.
      See Also:

    • deliveryDestinationTypeAsString

      public final String deliveryDestinationTypeAsString()

      Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

      If the service returns an enum value that is not available in the current SDK version, deliveryDestinationType will return DeliveryDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryDestinationTypeAsString().

      Returns:
      Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.
      See Also:

    • outputFormat

      public final OutputFormat outputFormat()

      The format of the logs that are sent to this delivery destination.

      If the service returns an enum value that is not available in the current SDK version, outputFormat will return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

      Returns:
      The format of the logs that are sent to this delivery destination.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The format of the logs that are sent to this delivery destination.

      If the service returns an enum value that is not available in the current SDK version, outputFormat will return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

      Returns:
      The format of the logs that are sent to this delivery destination.
      See Also:

    • deliveryDestinationConfiguration

      public final DeliveryDestinationConfiguration deliveryDestinationConfiguration()

      A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

      Returns:
      A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags that have been assigned to this delivery destination.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags that have been assigned to this delivery destination.

    • toBuilder

      public DeliveryDestination.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeliveryDestination.Builder,DeliveryDestination>
      Returns:
      a builder for type T

    • builder

      public static DeliveryDestination.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.