Package software.amazon.awssdk.services.ecs.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExecuteCommandConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ExecuteCommandConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId()	Specify an Key Management Service key ID to encrypt the data between the local client and the container.
ExecuteCommandLogConfiguration	logConfiguration()	The log configuration for the results of the execute command actions.
ExecuteCommandLogging	logging()	The log setting to use for redirecting logs for your execute command results.
String	loggingAsString()	The log setting to use for redirecting logs for your execute command results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExecuteCommandConfiguration.Builder>	serializableBuilderClass()
ExecuteCommandConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ExecuteCommandLogging

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:

ExecuteCommandLogging

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

Specified by:

toBuilder in interface ToCopyableBuilder<ExecuteCommandConfiguration.Builder,ExecuteCommandConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo