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 . vpc-lattice ]

update-resource-configuration

Description

Updates the specified resource configuration.

See also: AWS API Documentation

Synopsis

  update-resource-configuration
[--allow-association-to-shareable-service-network | --no-allow-association-to-shareable-service-network]
[--port-ranges <value>]
[--resource-configuration-definition <value>]
--resource-configuration-identifier <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

--allow-association-to-shareable-service-network | --no-allow-association-to-shareable-service-network (boolean)

Indicates whether to add the resource configuration to service networks that are shared with other accounts.

--port-ranges (list)

The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30

(string)

Syntax:

"string" "string" ...

--resource-configuration-definition (tagged union structure)

The resource configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: arnResource, dnsResource, ipResource.

arnResource -> (structure)

The Amazon Resource Name (ARN) of the resource.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

dnsResource -> (structure)

The DNS name of the resource.

domainName -> (string)

The domain name of the resource.

ipAddressType -> (string)

The type of IP address.

ipResource -> (structure)

The IP resource.

ipAddress -> (string)

The IP address of the IP resource.

Shorthand Syntax:

arnResource={arn=string},dnsResource={domainName=string,ipAddressType=string},ipResource={ipAddress=string}

JSON Syntax:

{
  "arnResource": {
    "arn": "string"
  },
  "dnsResource": {
    "domainName": "string",
    "ipAddressType": "IPV4"|"IPV6"|"DUALSTACK"
  },
  "ipResource": {
    "ipAddress": "string"
  }
}

--resource-configuration-identifier (string)

The ID of the resource configuration.

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

allowAssociationToShareableServiceNetwork -> (boolean)

Indicates whether to add the resource configuration to service networks that are shared with other accounts.

arn -> (string)

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

id -> (string)

The ID of the resource configuration.

name -> (string)

The name of the resource configuration.

portRanges -> (list)

The TCP port ranges that a consumer can use to access a resource configuration. You can separate port ranges with a comma. Example: 1-65535 or 1,2,22-30

(string)

protocol -> (string)

The TCP protocol accepted by the specified resource configuration.

resourceConfigurationDefinition -> (tagged union structure)

The resource configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: arnResource, dnsResource, ipResource.

arnResource -> (structure)

The Amazon Resource Name (ARN) of the resource.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

dnsResource -> (structure)

The DNS name of the resource.

domainName -> (string)

The domain name of the resource.

ipAddressType -> (string)

The type of IP address.

ipResource -> (structure)

The IP resource.

ipAddress -> (string)

The IP address of the IP resource.

resourceConfigurationGroupId -> (string)

The ID of the group resource configuration.

resourceGatewayId -> (string)

The ID of the resource gateway associated with the resource configuration.

status -> (string)

The status of the resource configuration.

type -> (string)

The type of resource configuration.

  • SINGLE - A single resource.
  • GROUP - A group of resources.
  • CHILD - A single resource that is part of a group resource configuration.
  • ARN - An Amazon Web Services resource.