Skip to content

ExecuteCommandConfiguration

Source code in docs_src/capo_ecs/types/execute_command_configuration.py
class ExecuteCommandConfiguration(TypedDict, closed=True):
    kms_key_id: NotRequired["capo_ecs.types.string.String"]
    """<p>Specify an Key Management Service key ID to encrypt the data between the local client and the container.</p>"""
    logging: NotRequired["capo_ecs.types.execute_command_logging.ExecuteCommandLogging"]
    """<p>The log setting to use for redirecting logs for your execute command results. The following log settings are available.</p> <ul> <li> <p> <code>NONE</code>: The execute command session is not logged.</p> </li> <li> <p> <code>DEFAULT</code>: The <code>awslogs</code> configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no <code>awslogs</code> log driver is configured in the task definition, the output won't be logged.</p> </li> <li> <p> <code>OVERRIDE</code>: Specify the logging details as a part of <code>logConfiguration</code>. If the <code>OVERRIDE</code> logging option is specified, the <code>logConfiguration</code> is required.</p> </li> </ul>"""
    log_configuration: NotRequired[
        "capo_ecs.types.execute_command_log_configuration.ExecuteCommandLogConfiguration"
    ]
    """<p>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 <code>logging=OVERRIDE</code> is specified, a <code>logConfiguration</code> must be provided.</p>"""

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

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

log_configuration instance-attribute

log_configuration: NotRequired[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. When logging=OVERRIDE is specified, a logConfiguration must be provided.

logging instance-attribute

logging: NotRequired[ExecuteCommandLogging]

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.