ExecuteCommandConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.ExecuteCommandConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExecuteCommandConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The details of the execute command configuration.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExecuteCommandConfiguration()

Constructors
Constructor and Description
`ExecuteCommandConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExecuteCommandConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKmsKeyId()` Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
`ExecuteCommandLogConfiguration`	`getLogConfiguration()` The log configuration for the results of the execute command actions.
`String`	`getLogging()` The log setting to use for redirecting logs for your execute command results.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setKmsKeyId(String kmsKeyId)` Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
`void`	`setLogConfiguration(ExecuteCommandLogConfiguration logConfiguration)` The log configuration for the results of the execute command actions.
`void`	`setLogging(String logging)` The log setting to use for redirecting logs for your execute command results.
`String`	`toString()` Returns a string representation of this object.
`ExecuteCommandConfiguration`	`withKmsKeyId(String kmsKeyId)` Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
`ExecuteCommandConfiguration`	`withLogConfiguration(ExecuteCommandLogConfiguration logConfiguration)` The log configuration for the results of the execute command actions.
`ExecuteCommandConfiguration`	`withLogging(ExecuteCommandLogging logging)` The log setting to use for redirecting logs for your execute command results.
`ExecuteCommandConfiguration`	`withLogging(String logging)` The log setting to use for redirecting logs for your execute command results.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ExecuteCommandConfiguration
```
public ExecuteCommandConfiguration()
```
- Method Detail
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
    
    Parameters:
    
    kmsKeyId - Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
    
    Returns:
    
    Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
  - withKmsKeyId
```
public ExecuteCommandConfiguration withKmsKeyId(String kmsKeyId)
```
    Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
    
    Parameters:
    
    kmsKeyId - Specify an AWS 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.
  - setLogging
```
public void setLogging(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.
    See Also:
    
    ExecuteCommandLogging
  - getLogging
```
public String getLogging()
```
    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:
    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
  - withLogging
```
public ExecuteCommandConfiguration withLogging(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
  - withLogging
```
public ExecuteCommandConfiguration withLogging(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
  - setLogConfiguration
```
public void setLogConfiguration(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.
  - getLogConfiguration
```
public ExecuteCommandLogConfiguration getLogConfiguration()
```
    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.
  - withLogConfiguration
```
public ExecuteCommandConfiguration withLogConfiguration(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ExecuteCommandConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ExecuteCommandConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExecuteCommandConfiguration

Method Detail

setKmsKeyId

getKmsKeyId

withKmsKeyId

setLogging

getLogging

withLogging

withLogging

setLogConfiguration

getLogConfiguration

withLogConfiguration

toString

equals

hashCode

clone

marshall