Back to Yugabyte Db

Yba Ear Aws Update

managed/yba-cli/docs/yba_ear_aws_update.md

2026.1.0.0-b252.8 KB
Original Source

yba ear aws update

Update a YugabyteDB Anywhere AWS encryption at rest (EAR) configuration

Synopsis

Update an AWS encryption at rest (EAR) configuration in YugabyteDB Anywhere

yba ear aws update [flags]

Examples

yba ear aws update --name <config-name> \
	--access-key-id <access-key-id> --secret-access-key <secret-access-key>\
	--endpoint <endpoint>

Options

      --access-key-id string       [Optional] Update AWS Access Key ID. Required for non IAM role based configurations.
      --secret-access-key string   [Optional] Update AWS Secret Access Key. Required for non IAM role based configurations.
      --use-iam-instance-profile   [Optional] Use IAM Role from the YugabyteDB Anywhere Host. EAR creation will fail on insufficient permissions on the host. (default false)
      --endpoint string            [Optional] Updating AWS KMS Endpoint.
  -h, --help                       help for update

Options inherited from parent commands

  -a, --apiToken string    YugabyteDB Anywhere api token.
      --ca-cert string     CA certificate file path for secure connection to YugabyteDB Anywhere. Required when the endpoint is https and --insecure is not set.
      --config string      Full path to a specific configuration file for YBA CLI. If provided, this takes precedence over the directory specified via --directory, and the generated files are added to the same path. If not provided, the CLI will look for '.yba-cli.yaml' in the directory specified by --directory. Defaults to '$HOME/.yba-cli/.yba-cli.yaml'.
      --debug              Use debug mode, same as --logLevel debug.
      --directory string   Directory containing YBA CLI configuration and generated files. If specified, the CLI will look for a configuration file named '.yba-cli.yaml' in this directory. Defaults to '$HOME/.yba-cli/'.
      --disable-color      Disable colors in output. (default false)
  -H, --host string        YugabyteDB Anywhere Host (default "http://localhost:9000")
      --insecure           Allow insecure connections to YugabyteDB Anywhere. Value ignored for http endpoints. Defaults to false for https.
  -l, --logLevel string    Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
  -n, --name string        [Optional] The name of the configuration for the action. Required for create, delete, describe, update and refresh.
  -o, --output string      Select the desired output format. Allowed values: table, json, pretty. (default "table")
      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
      --wait               Wait until the task is completed, otherwise it will exit immediately. (default true)

SEE ALSO

  • yba ear aws - Manage a YugabyteDB Anywhere AWS encryption at rest (EAR) configuration