Class ExecuteCommandLogConfiguration

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

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

See Also:

  • Method Details

    • cloudWatchLogGroupName

      public final String cloudWatchLogGroupName()

      The name of the CloudWatch log group to send logs to.

      The CloudWatch log group must already be created.

      Returns:
      The name of the CloudWatch log group to send logs to.

      The CloudWatch log group must already be created.

    • cloudWatchEncryptionEnabled

      public final Boolean cloudWatchEncryptionEnabled()

      Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

      Returns:
      Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.

    • s3BucketName

      public final String s3BucketName()

      The name of the S3 bucket to send logs to.

      The S3 bucket must already be created.

      Returns:
      The name of the S3 bucket to send logs to.

      The S3 bucket must already be created.

    • s3EncryptionEnabled

      public final Boolean s3EncryptionEnabled()

      Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

      Returns:
      Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      An optional folder in the S3 bucket to place logs in.

      Returns:
      An optional folder in the S3 bucket to place logs in.

    • toBuilder

      public ExecuteCommandLogConfiguration.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<ExecuteCommandLogConfiguration.Builder,ExecuteCommandLogConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ExecuteCommandLogConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExecuteCommandLogConfiguration.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.