Class ExecuteCommandConfiguration

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

The details of the execute command configuration.

See Also:

  • Method Details

    • kmsKeyId

      public final String kmsKeyId()

      Specify an Key Management Service key ID to encrypt the data between the local client and the container.

      Returns:
      Specify an Key Management Service key ID to encrypt the data between the local client and the container.

    • logging

      public final ExecuteCommandLogging logging()

      The log setting to use for redirecting logs for your execute command results. The following log settings are available.

      • NONE: The execute command session is not logged.

      • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

      • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

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

      Returns:
      The log setting to use for redirecting logs for your execute command results. The following log settings are available.

      • NONE: The execute command session is not logged.

      • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

      • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

      See Also:

    • loggingAsString

      public final String loggingAsString()

      The log setting to use for redirecting logs for your execute command results. The following log settings are available.

      • NONE: The execute command session is not logged.

      • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

      • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

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

      Returns:
      The log setting to use for redirecting logs for your execute command results. The following log settings are available.

      • NONE: The execute command session is not logged.

      • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.

      • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

      See Also:

    • logConfiguration

      public final ExecuteCommandLogConfiguration logConfiguration()

      The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

      Returns:
      The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

    • toBuilder

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

    • builder

      public static ExecuteCommandConfiguration.Builder builder()

    • serializableBuilderClass

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