Back to Yugabyte Db

Yba Provider Aws Create

managed/yba-cli/docs/yba_provider_aws_create.md

2026.1.0.0-b256.7 KB
Original Source

yba provider aws create

Create an AWS YugabyteDB Anywhere provider

Synopsis

Create an AWS provider in YugabyteDB Anywhere

yba provider aws create [flags]

Examples

yba provider aws create -n <provider-name> \
	--region region-name=us-west-2::vpc-id=<vpc-id>::sg-id=<security-group> \
	--zone zone-name=us-west-2a::region-name=us-west-2::subnet=<subnet> \
	--zone zone-name=us-west-2b::region-name=us-west-2::subnet=<subnet> \
	--access-key-id <aws-access-key-id> --secret-access-key <aws-secret-access-key>

Options

      --access-key-id string                       AWS Access Key ID. Required for non IAM role based providers. Can also be set using environment variable AWS_ACCESS_KEY_ID.
      --secret-access-key string                   AWS Secret Access Key. Required for non IAM role based providers. Can also be set using environment variable AWS_SECRET_ACCESS_KEY.
      --use-iam-instance-profile                   [Optional] Use IAM Role from the YugabyteDB Anywhere Host. Provider creation will fail on insufficient permissions on the host. (default false)
      --hosted-zone-id string                      [Optional] Hosted Zone ID corresponding to Amazon Route53.
      --region stringArray                         [Required] Region associated with the AWS provider. Minimum number of required regions = 1. Provide the following double colon (::) separated fields as key-value pairs: "region-name=<region-name>::vpc-id=<vpc-id>::sg-id=<security-group-id>". Region name is required key-value. VPC ID and Security Group ID are optional. Each region needs to be added using a separate --region flag. Example: --region region-name=us-west-2::vpc-id=<vpc-id>::sg-id=<security-group> --region region-name=us-east-2::vpc-id=<vpc-id>::sg-id=<security-group>
      --zone stringArray                           [Required] Zone associated to the AWS Region defined. Provide the following double colon (::) separated fields as key-value pairs:"zone-name=<zone-name>::region-name=<region-name>::subnet=<subnet-id>::secondary-subnet=<secondary-subnet-id>". Zone name, Region name and subnet IDs are required values. Secondary subnet ID is optional. Each --region definition must have atleast one corresponding --zone definition. Multiple --zone definitions can be provided per region.Each zone needs to be added using a separate --zone flag. Example: --zone zone-name=us-west-2a::region-name=us-west-2::subnet=<subnet-id> --zone zone-name=us-west-2b::region-name=us-west-2::subnet=<subnet-id>
      --image-bundle stringArray                   [Optional] Image bundles associated with AWS provider. Provide the following double colon (::) separated fields as key-value pairs: "image-bundle-name=<image-bundle-name>::arch=<architecture>::ssh-user=<ssh-user>::ssh-port=<ssh-port>::imdsv2=<true/false>::default=<true/false>". Image bundle name, architecture and SSH user are required key-value pairs. The default for SSH Port is 22, IMDSv2 (This should be true if the Image bundle requires Instance Metadata Service v2) is false. Default marks the image bundle as default for the provider. Allowed values for architecture are x86_64 and arm64/aarch64.Each image bundle can be added using separate --image-bundle flag. Example: --image-bundle image-bundle-name=<name>::ssh-user=<ssh-user>::ssh-port=22
      --image-bundle-region-override stringArray   [Optional] Image bundle region overrides associated with AWS provider. Provide the following double colon (::) separated fields as key-value pairs: "image-bundle-name=<image-bundle-name>,region-name=<region-name>,machine-image=<machine-image>". Image bundle name and region name are required key-value pairs. Each --image-bundle definition must have atleast one corresponding --image-bundle-region-override definition for every region added. Each image bundle override can be added using separate --image-bundle-region-override flag. Example: --image-bundle-region-override image-bundle-name=<name>::region-name=<region-name>::machine-image=<machine-image>
      --custom-ssh-keypair-name string             [Optional] Provide custom key pair name to access YugabyteDB nodes. If left empty, YugabyteDB Anywhere will generate key pairs to access YugabyteDB nodes.
      --custom-ssh-keypair-file-path string        [Optional] Provide custom key pair file path to access YugabyteDB nodes. Required with --custom-ssh-keypair-name.
      --skip-ssh-keypair-validation                [Optional] Skip ssh keypair validation and upload to AWS. (default false)
      --airgap-install                             [Optional] Are YugabyteDB nodes installed in an air-gapped environment, lacking access to the public internet for package downloads. (default false)
      --ntp-servers stringArray                    [Optional] List of NTP Servers. Can be provided as separate flags or as comma-separated values.
  -h, --help                                       help for create

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 provider for the action. Required for create, delete, describe, update, and some instance-type subcommands.
  -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