AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . odb ]

create-odb-network

Description

Creates an ODB network.

See also: AWS API Documentation

Synopsis

  create-odb-network
--display-name <value>
[--availability-zone <value>]
[--availability-zone-id <value>]
--client-subnet-cidr <value>
[--backup-subnet-cidr <value>]
[--custom-domain-name <value>]
[--default-dns-prefix <value>]
[--client-token <value>]
[--s3-access <value>]
[--zero-etl-access <value>]
[--s3-policy-document <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--display-name (string)

A user-friendly name for the ODB network.

--availability-zone (string)

The Amazon Web Services Availability Zone (AZ) where the ODB network is located.

This operation requires that you specify a value for either availabilityZone or availabilityZoneId .

--availability-zone-id (string)

The AZ ID of the AZ where the ODB network is located.

This operation requires that you specify a value for either availabilityZone or availabilityZoneId .

--client-subnet-cidr (string)

The CIDR range of the client subnet for the ODB network.

Constraints:

  • Must not overlap with the CIDR range of the backup subnet.
  • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
  • Must not use the following CIDR ranges that are reserved by OCI:
    • 100.106.0.0/16 and 100.107.0.0/16
    • 169.254.0.0/16
    • 224.0.0.0 - 239.255.255.255
    • 240.0.0.0 - 255.255.255.255

--backup-subnet-cidr (string)

The CIDR range of the backup subnet for the ODB network.

Constraints:

  • Must not overlap with the CIDR range of the client subnet.
  • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
  • Must not use the following CIDR ranges that are reserved by OCI:
    • 100.106.0.0/16 and 100.107.0.0/16
    • 169.254.0.0/16
    • 224.0.0.0 - 239.255.255.255
    • 240.0.0.0 - 255.255.255.255

--custom-domain-name (string)

The domain name to use for the resources in the ODB network.

--default-dns-prefix (string)

The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it’s first used.

--s3-access (string)

Specifies the configuration for Amazon S3 access from the ODB network.

Possible values:

  • ENABLED
  • DISABLED

--zero-etl-access (string)

Specifies the configuration for Zero-ETL access from the ODB network.

Possible values:

  • ENABLED
  • DISABLED

--s3-policy-document (string)

Specifies the endpoint policy for Amazon S3 access from the ODB network.

--tags (map)

The list of resource tags to apply to the ODB network.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

displayName -> (string)

The user-friendly name of the ODB network.

status -> (string)

The current status of the ODB network.

statusReason -> (string)

Additional information about the status of the ODB network.

odbNetworkId -> (string)

The unique identifier of the ODB network.