Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateServiceNetworkResourceAssociation

Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.

Request Syntax


POST /servicenetworkresourceassociations HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "resourceConfigurationIdentifier": "string",
   "serviceNetworkIdentifier": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

resourceConfigurationIdentifier

The ID of the resource configuration to associate with the service network.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))$

Required: Yes

serviceNetworkIdentifier

The ID of the service network to associate with the resource configuration.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 2048.

Required: Yes

tags

A key-value pair to associate with a resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "createdBy": "string",
   "id": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn

The Amazon Resource Name (ARN) of the association.

Type: String

Length Constraints: Minimum length of 22. Maximum length of 2048.

Pattern: ^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-f]{17}$

createdBy

The ID of the account that created the association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: ^[0-9]{12}$

id

The ID of the association.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^snra-[0-9a-f]{17}$

status

The status of the association.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400