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

Class DeliverySource

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<DeliverySource.Builder,​DeliverySource>
    @Generated("software.amazon.awssdk:codegen")
public final class DeliverySource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeliverySource.Builder,​DeliverySource>

    This structure contains information about one delivery source in your account. A delivery source is an Amazon Web Services resource that sends logs to an Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.

    Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

    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. For more information, see PutDeliveryDestination.

    • 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:
    Serialized Form

    • Method Detail

      • name

        public final String name()

        The unique name of the delivery source.

        Returns:
        The unique name of the delivery source.

      • arn

        public final String arn()

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

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

      • hasResourceArns

        public final boolean hasResourceArns()
        For responses, this returns true if the service returned a value for the ResourceArns 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.

      • resourceArns

        public final List<String> resourceArns()

        This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

        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 hasResourceArns() method.

        Returns:
        This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

      • service

        public final String service()

        The Amazon Web Services service that is sending logs.

        Returns:
        The Amazon Web Services service that is sending logs.

      • logType

        public final String logType()

        The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

        Returns:
        The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

      • 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 source.

        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 source.

      • hashCode

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

      • equals

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

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