software.amazon.awssdk.services.ecs.model

Interface ExecuteCommandConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ExecuteCommandConfiguration.Builder,ExecuteCommandConfiguration>, SdkBuilder<ExecuteCommandConfiguration.Builder,ExecuteCommandConfiguration>, SdkPojo

Enclosing class:

ExecuteCommandConfiguration

public static interface ExecuteCommandConfiguration.Builder
extends SdkPojo, CopyableBuilder<ExecuteCommandConfiguration.Builder,ExecuteCommandConfiguration>

Method Summary

Modifier and Type	Method and Description
ExecuteCommandConfiguration.Builder	kmsKeyId(String kmsKeyId) Specify an Key Management Service key ID to encrypt the data between the local client and the container.
default ExecuteCommandConfiguration.Builder	logConfiguration(Consumer<ExecuteCommandLogConfiguration.Builder> logConfiguration) The log configuration for the results of the execute command actions.
ExecuteCommandConfiguration.Builder	logConfiguration(ExecuteCommandLogConfiguration logConfiguration) The log configuration for the results of the execute command actions.
ExecuteCommandConfiguration.Builder	logging(ExecuteCommandLogging logging) The log setting to use for redirecting logs for your execute command results.
ExecuteCommandConfiguration.Builder	logging(String logging) The log setting to use for redirecting logs for your execute command results.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

kmsKeyId

ExecuteCommandConfiguration.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

logging

ExecuteCommandConfiguration.Builder logging(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecuteCommandLogging, ExecuteCommandLogging

logging

ExecuteCommandConfiguration.Builder logging(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecuteCommandLogging, ExecuteCommandLogging

logConfiguration

ExecuteCommandConfiguration.Builder logConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

logConfiguration

default ExecuteCommandConfiguration.Builder logConfiguration(Consumer<ExecuteCommandLogConfiguration.Builder> 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.

This is a convenience method that creates an instance of the ExecuteCommandLogConfiguration.Builder avoiding the need to create one manually via ExecuteCommandLogConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfiguration(ExecuteCommandLogConfiguration).

Parameters:

logConfiguration - a consumer that will call methods on ExecuteCommandLogConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

logConfiguration(ExecuteCommandLogConfiguration)