[ aws . odb ]

get-odb-network

Description

Returns information about the specified ODB network.

See also: AWS API Documentation

Synopsis

  get-odb-network
--odb-network-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--odb-network-id (string)

The unique identifier of the ODB network.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

odbNetwork -> (structure)

The ODB network.

odbNetworkId -> (string)

The unique identifier of the ODB network.

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 current status of the ODB network.

odbNetworkArn -> (string)

The Amazon Resource Name (ARN) of the ODB network.

availabilityZone -> (string)

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

availabilityZoneId -> (string)

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

clientSubnetCidr -> (string)

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

backupSubnetCidr -> (string)

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

customDomainName -> (string)

The domain name for the resources in the ODB network.

defaultDnsPrefix -> (string)

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

peeredCidrs -> (list)

The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.

(string)

ociNetworkAnchorId -> (string)

The unique identifier of the OCI network anchor for the ODB network.

ociNetworkAnchorUrl -> (string)

The URL of the OCI network anchor for the ODB network.

ociResourceAnchorName -> (string)

The name of the OCI resource anchor that’s associated with the ODB network.

ociVcnId -> (string)

The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that’s associated with the ODB network.

ociVcnUrl -> (string)

The URL for the VCN that’s associated with the ODB network.

ociDnsForwardingConfigs -> (list)

The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.

(structure)

DNS configuration to forward DNS resolver endpoints to your OCI Private Zone.

domainName -> (string)

Domain name to which DNS resolver forwards to.

ociDnsListenerIp -> (string)

OCI DNS listener IP for custom DNS setup.

createdAt -> (timestamp)

The date and time when the ODB network was created.

percentProgress -> (float)

The amount of progress made on the current operation on the ODB network, expressed as a percentage.

managedServices -> (structure)

The managed services configuration for the ODB network.

serviceNetworkArn -> (string)

The Amazon Resource Name (ARN) of the service network.

resourceGatewayArn -> (string)

The Amazon Resource Name (ARN) of the resource gateway.

managedServicesIpv4Cidrs -> (list)

The IPv4 CIDR blocks for the managed services.

(string)

serviceNetworkEndpoint -> (structure)

The service network endpoint configuration.

vpcEndpointId -> (string)

The identifier of the VPC endpoint.

vpcEndpointType -> (string)

The type of the VPC endpoint.

Valid Values: Interface | Gateway

managedS3BackupAccess -> (structure)

The managed Amazon S3 backup access configuration.

status -> (string)

The status of the managed Amazon S3 backup access.

Valid Values: enabled | disabled

ipv4Addresses -> (list)

The IPv4 addresses for the managed Amazon S3 backup access.

(string)

zeroEtlAccess -> (structure)

The Zero-ETL access configuration.

status -> (string)

The status of the Zero-ETL access.

Valid Values: enabled | disabled

cidr -> (string)

The CIDR block for the Zero-ETL access.

s3Access -> (structure)

The Amazon S3 access configuration.

status -> (string)

The status of the Amazon S3 access.

Valid Values: enabled | disabled

ipv4Addresses -> (list)

The IPv4 addresses for the Amazon S3 access.

(string)

domainName -> (string)

The domain name for the Amazon S3 access.

s3PolicyDocument -> (string)

The endpoint policy for the Amazon S3 access.