Skip to content

Create Service Network Vpc Association

vpclattice_create_service_network_vpc_association R Documentation

Associates a VPC with a service network

Description

Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it.

As a result of this operation, the association gets created in the service network account and the VPC owner account.

If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Usage

vpclattice_create_service_network_vpc_association(clientToken,
  securityGroupIds, serviceNetworkIdentifier, tags, vpcIdentifier)

Arguments

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.

securityGroupIds

The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide.

serviceNetworkIdentifier

[required] The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN when the resources specified in the operation are in different accounts.

tags

The tags for the association.

vpcIdentifier

[required] The ID of the VPC.

Value

A list with the following syntax: 

list(
  arn = "string",
  createdBy = "string",
  id = "string",
  securityGroupIds = list(
    "string"
  ),
  status = "CREATE_IN_PROGRESS"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"CREATE_FAILED"|"DELETE_FAILED"|"UPDATE_FAILED"
)

Request syntax

svc$create_service_network_vpc_association(
  clientToken = "string",
  securityGroupIds = list(
    "string"
  ),
  serviceNetworkIdentifier = "string",
  tags = list(
    "string"
  ),
  vpcIdentifier = "string"
)