Overview and basic usage
container:session
Starts an interactive session inside a deployed container.
The session is established using ECS Exec and a secure SSM connection. If your service has multiple containers, you can choose which one to connect to. This is useful for debugging and inspecting running containers.
For more information, refer to the container session documentation.
API reference
region (--r)Required
AWS Region
Type: string
Possible values: af-south-1ap-east-1ap-northeast-1ap-northeast-2ap-northeast-3ap-south-1ap-southeast-1ap-southeast-2ca-central-1eu-central-1eu-north-1eu-south-1eu-west-1eu-west-2eu-west-3me-south-1sa-east-1us-east-1us-east-2us-west-1us-west-2
The AWS region for the operation. For a list of available regions, see the AWS documentation.
resourceName (--rn)Required
Type: string
stage (--s)Required
Stage
Type: string
The stage for the operation (e.g., production, staging, dev-john). You can set a default stage using the defaults:configure command. The maximum length is 12 characters.
awsAccount (--aa)
AWS Account
Type: string
The name of the AWS account to use for the operation. The account must first be connected in the Stacktape console.
command (--cmd)
Command
Type: string
This argument has different meanings depending on the command:
- With
stacktape help, it specifies a command to show detailed help for. - With
stacktape container:session, it specifies a command to run inside the container to start the interactive session.
configPath (--cp)
Config File Path
Type: string
The path to your Stacktape configuration file, relative to the current working directory.
container (--cnt)
Container Name
Type: string
The name of the container as defined in your container compute resource configuration.
currentWorkingDirectory (--cwd)
Current Working Directory
Type: string
The working directory for the operation. All file paths in your configuration will be resolved relative to this directory. By default, this is the directory containing the configuration file.
help (--h)
Show Help
Type: string
If provided, the command will not execute and will instead print help information.
logFormat (--lf)
Log Format
Type: string
Possible values: basicfancyjsonnormal
The format of logs printed to the console.
fancy: Colorized and dynamically re-rendered logs.normal: Colorized but not dynamically re-rendered logs.basic: Simple text only.json: Logs printed as JSON objects.
logLevel (--ll)
Log Level
Type: string
Possible values: debugerrorinfo
The level of logs to print to the console.
info: Basic information about the operation.error: Only errors.debug: Detailed information for debugging.
profile (--p)
AWS Profile
Type: string
The AWS profile to use for the command. You can manage profiles using the aws-profile:* commands and set a default profile with defaults:configure.
projectName (--prj)
Project Name
Type: string
The name of the Stacktape project for this operation.
templateId (--ti)
Template ID
Type: string
The ID of the template to download. You can find a list of available templates on the Config Builder page.