Exemplos do VPC Lattice usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o VPC Lattice.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar create-listener.

AWS CLI

Criar um receptor

O exemplo create-listener a seguir cria um receptor HTTPS com uma regra padrão que encaminha o tráfego para o grupo de destino do VPC Lattice especificado.


aws vpc-lattice create-listener \
    --name my-service-listener \
    --protocol HTTPS \
    --port 443 \
    --service-identifier svc-0285b53b2eEXAMPLE \
    --default-action file://listener-config.json

Conteúdo de listener-config.json:


{
    "forward": {
        "targetGroups": [
            {
                "targetGroupIdentifier": "tg-0eaa4b9ab4EXAMPLE"
            }
        ]
    }
}

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE/listener/listener-07cc7fb0abEXAMPLE",
    "defaultAction": {
        "forward": {
            "targetGroups": [
                {
                    "targetGroupIdentifier": "tg-0eaa4b9ab4EXAMPLE",
                    "weight": 100
                }
            ]
        }
    },
    "id": "listener-07cc7fb0abEXAMPLE",
    "name": "my-service-listener",
    "port": 443,
    "protocol": "HTTPS",
    "serviceArn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "serviceId": "svc-0285b53b2eEXAMPLE"
}

Para obter mais informações, consulte Receptores no Guia do usuário do Amazon VPC Lattice.

Para obter detalhes da API, consulte CreateListener na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-resource-configuration.

AWS CLI

Como criar uma configuração de recurso

O exemplo de create-resource-configuration a seguir cria uma configuração de recurso que especifica um único endereço IPv4.


aws vpc-lattice create-resource-configuration \
    --name my-resource-config \
    --type SINGLE \
    --resource-gateway-identifier rgw-0bba03f3d56060135 \
    --resource-configuration-definition 'ipResource={ipAddress=10.0.14.85}'

Saída:


{
    "allowAssociationToShareableServiceNetwork": true,
    "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-07129f3acded87625",
    "id": "rcfg-07129f3acded87625",
    "name": "my-resource-config",
    "portRanges": [
        "1-65535"
    ],
    "protocol": "TCP",
    "resourceConfigurationDefinition": {
        "ipResource": {
            "ipAddress": "10.0.14.85"
        }
    },
    "resourceGatewayId": "rgw-0bba03f3d56060135",
    "status": "ACTIVE",
    "type": "SINGLE"
}

Consulte mais informações em Resource configurations for VPC resources no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em CreateResourceConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-resource-gateway.

AWS CLI

Como criar um gateway de recurso

O exemplo de create-resource-gateway a seguir cria um gateway de recurso para a sub-rede especificada.


aws vpc-lattice create-resource-gateway \
    --name my-resource-gateway \
    --vpc-identifier vpc-0bf4c2739bc05a69 \
    --subnet-ids subnet-08e8943905b63a683

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourcegateway/rgw-0bba03f3d56060135",
    "id": "rgw-0bba03f3d56060135",
    "ipAddressType": "IPV4",
    "name": "my-resource-gateway",
    "securityGroupIds": [
        "sg-087ffd596c5fe962c"
    ],
    "status": "ACTIVE",
    "subnetIds": [
        "subnet-08e8943905b63a683"
    ],
    "vpcIdentifier": "vpc-0bf4c2739bc05a694"
}

Consulte mais informações em Resource gateways in VPC Lattice no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em CreateResourceGateway na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-service-network-service-association.

AWS CLI

Para criar uma associação de serviço

O exemplo create-service-network-service-association a seguir associa o serviço especificado à rede de serviços especificada.


aws vpc-lattice create-service-network-service-association \
    --service-identifier svc-0285b53b2eEXAMPLE \
    --service-network-identifier sn-080ec7dc93EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetworkserviceassociation/snsa-0e16955a8cEXAMPLE",
    "createdBy": "123456789012",
    "dnsEntry": {
        "domainName": "my-lattice-service-0285b53b2eEXAMPLE.7d67968.vpc-lattice-svcs.us-east-2.on.aws",
        "hostedZoneId": "Z09127221KTH2CEXAMPLE"
    },
    "id": "snsa-0e16955a8cEXAMPLE",
    "status": "CREATE_IN_PROGRESS"
}

Para obter mais informações, consulte Gerenciar associações de serviços no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte CreateServiceNetworkServiceAssociation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-service-network-vpc-association.

AWS CLI

Para criar uma associação de VPC

O exemplo create-service-network-vpc-association a seguir associa a VPC especificada à rede de serviços especificada. O grupo de segurança especificado controla quais recursos na VPC podem acessar a rede de serviços e seus serviços.


aws vpc-lattice create-service-network-vpc-association \
    --vpc-identifier vpc-0a1b2c3d4eEXAMPLE \
    --service-network-identifier sn-080ec7dc93EXAMPLE \
    --security-group-ids sg-0aee16bc6cEXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetworkvpcassociation/snva-0821fc8631EXAMPLE",
    "createdBy": "123456789012",
    "id": "snva-0821fc8631EXAMPLE",
    "securityGroupIds": [
        "sg-0aee16bc6cEXAMPLE"
    ],
    "status": "CREATE_IN_PROGRESS"
}

Para obter mais informações, consulte Gerenciar associações da VPC no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte CreateServiceNetworkVpcAssociation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-service-network.

AWS CLI

Para criar uma rede de serviços

O exemplo create-service-network a seguir cria uma rede de serviços com o nome especificado.


aws vpc-lattice create-service-network \
    --name my-service-network

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetwork/sn-080ec7dc93EXAMPLE",
    "authType": "NONE",
    "id": "sn-080ec7dc93EXAMPLE",
    "name": "my-service-network"
}

Para obter mais informações, consulte Redes de serviço no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte CreateServiceNetwork na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-service.

AWS CLI

Para criar um serviço

O exemplo create-service a seguir cria um serviço com o nome especificado.


aws vpc-lattice create-service \
    --name my-lattice-service

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "authType": "NONE",
    "dnsEntry": {
        "domainName": "my-lattice-service-0285b53b2eEXAMPLE.1a2b3c4.vpc-lattice-svcs.us-east-2.on.aws",
        "hostedZoneId": "Z09127221KTH2CEXAMPLE"
    },
    "id": "svc-0285b53b2eEXAMPLE",
    "name": "my-lattice-service",
    "status": "CREATE_IN_PROGRESS"
}

Para obter mais informações, consulte Serviços no VPC Lattice no Guia do usuário do Amazon VPC Lattice.

Para obter detalhes da API, consulte CreateService na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-target-group.

AWS CLI

Exemplo 1: criar um grupo de destino do tipo INSTANCE

O exemplo create-target-group a seguir cria um grupo de destino com o nome, o tipo e a configuração especificados.


aws vpc-lattice create-target-group \
    --name my-lattice-target-group-instance \
    --type INSTANCE \
    --config file://tg-config.json

Conteúdo de tg-config.json:


{
    "port": 443,
    "protocol": "HTTPS",
    "protocolVersion": "HTTP1",
    "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
}

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "healthCheck": {
            "enabled": true,
            "healthCheckIntervalSeconds": 30,
            "healthCheckTimeoutSeconds": 5,
            "healthyThresholdCount": 5,
            "matcher": {
                "httpCode": "200"
            },
            "path": "/",
            "protocol": "HTTPS",
            "protocolVersion": "HTTP1",
            "unhealthyThresholdCount": 2
        },
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-instance",
    "status": "CREATE_IN_PROGRESS",
    "type": "INSTANCE"
}

Exemplo 2: criar um grupo de destino do tipo IP

O exemplo create-target-group a seguir cria um grupo de destino com o nome, o tipo e a configuração especificados.


aws vpc-lattice create-target-group \
    --name my-lattice-target-group-ip \
    --type IP \
    --config file://tg-config.json

Conteúdo de tg-config.json:


{
    "ipAddressType": "IPV4",
    "port": 443,
    "protocol": "HTTPS",
    "protocolVersion": "HTTP1",
    "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
}

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "healthCheck": {
            "enabled": true,
            "healthCheckIntervalSeconds": 30,
            "healthCheckTimeoutSeconds": 5,
            "healthyThresholdCount": 5,
            "matcher": {
                "httpCode": "200"
            },
            "path": "/",
            "protocol": "HTTPS",
            "protocolVersion": "HTTP1",
            "unhealthyThresholdCount": 2
        },
        "ipAddressType": "IPV4",
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-ip",
    "status": "CREATE_IN_PROGRESS",
    "type": "IP"
}

Exemplo 3: criar um grupo de destino do tipo LAMBDA

O exemplo create-target-group a seguir cria um grupo de destino com o nome, o tipo e a configuração especificados.


aws vpc-lattice create-target-group \
    --name my-lattice-target-group-lambda \
    --type LAMBDA

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-lambda",
    "status": "CREATE_IN_PROGRESS",
    "type": "LAMBDA"
}

Exemplo 4: criar um grupo de destino do tipo ALB

O exemplo create-target-group a seguir cria um grupo de destino com o nome, o tipo e a configuração especificados.


aws vpc-lattice create-target-group \
    --name my-lattice-target-group-alb \
    --type ALB \
    --config file://tg-config.json

Conteúdo de tg-config.json:


{
    "port": 443,
    "protocol": "HTTPS",
    "protocolVersion": "HTTP1",
    "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
}

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "name": "my-lattice-target-group-alb",
    "status": "CREATE_IN_PROGRESS",
    "type": "ALB"
}

Para obter mais informações, consulte Grupos de destino no Guia do usuário do Amazon VPC Lattice.

Para obter detalhes da API, consulte CreateTargetGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-auth-policy.

AWS CLI

Para excluir uma política de autenticação

O exemplo delete-auth-policy a seguir exclui a política de autenticação do serviço especificado.


aws vpc-lattice delete-auth-policy \
    --resource-identifier svc-0285b53b2eEXAMPLE

Este comando não produz saída.

Para obter mais informações, consulte Políticas de autenticação no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte DeleteAuthPolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-listener.

AWS CLI

Excluir um receptor

O exemplo delete-listener a seguir exclui o receptor especificado.


aws vpc-lattice delete-listener \
    --listener-identifier listener-07cc7fb0abEXAMPLE \
    --service-identifier svc-0285b53b2eEXAMPLE

Este comando não produz saída.

Para obter mais informações, consulte Receptores no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte DeleteListener na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-resource-configuration.

AWS CLI

Como excluir uma configuração de recurso

O exemplo de delete-resource-configuration a seguir exclui a configuração de recurso especificada.


aws vpc-lattice delete-resource-configuration \
    --resource-configuration-identifier rcfg-07129f3acded87625

Este comando não produz saída.

Consulte mais informações em Resource gateways in VPC Lattice no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em DeleteResourceConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-resource-gateway.

AWS CLI

Como excluir um gateway de recurso

O exemplo de delete-resource-gateway a seguir exclui o gateway de recurso especificado.


aws vpc-lattice delete-resource-gateway \
    --resource-gateway-identifier rgw-0bba03f3d56060135

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourcegateway/rgw-0bba03f3d56060135",
    "id": "rgw-0bba03f3d56060135",
    "name": "my-resource-gateway",
    "status": "DELETE_IN_PROGRESS"
}

Consulte mais informações em Resource gateways in VPC Lattice no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em DeleteResourceGateway na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-service-network-service-association.

AWS CLI

Para excluir uma associação de serviço

O exemplo delete-service-network-service-association a seguir desassocia a associação de serviço especificada.


aws vpc-lattice delete-service-network-service-association \
    --service-network-service-association-identifier snsa-031fabb4d8EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetworkserviceassociation/snsa-031fabb4d8EXAMPLE",
    "id": "snsa-031fabb4d8EXAMPLE",
    "status": "DELETE_IN_PROGRESS"
}

Para obter mais informações, consulte Gerenciar associações de serviços no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte DeleteServiceNetworkServiceAssociation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-service-network-vpc-association.

AWS CLI

Para excluir uma associação de VPC

O exemplo delete-service-network-vpc-association a seguir dissocia a associação da VPC especificada.


aws vpc-lattice delete-service-network-vpc-association \
    --service-network-vpc-association-identifier snva-0821fc8631EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetworkvpcassociation/snva-0821fc8631EXAMPLE",
    "id": "snva-0821fc8631EXAMPLE",
    "status": "DELETE_IN_PROGRESS"
}

Para obter mais informações, consulte Gerenciar associações da VPC no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte DeleteServiceNetworkVpcAssociation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-service-network.

AWS CLI

Para excluir uma rede de serviços

O exemplo delete-service-network a seguir exclui a rede de serviços especificada.


aws vpc-lattice delete-service-network \
    --service-network-identifier sn-080ec7dc93EXAMPLE

Este comando não produz saída.

Para obter mais informações, consulte Redes de serviço no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte DeleteServiceNetwork na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-service.

AWS CLI

Como excluir um serviço

O exemplo delete-service a seguir exclui o serviço especificado.


aws vpc-lattice delete-service \
    --service-identifier svc-0285b53b2eEXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-west-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "id": "svc-0285b53b2eEXAMPLE",
    "name": "my-lattice-service",
    "status": "DELETE_IN_PROGRESS"
}

Para obter mais informações, consulte Serviços no VPC Lattice no Guia do usuário do Amazon VPC Lattice.

Para obter detalhes da API, consulte DeleteService na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-target-group.

AWS CLI

Como excluir um grupo de destino

O exemplo de delete-target-group a seguir exclui o grupo de destino especificado.


aws vpc-lattice delete-target-group \
    --target-group-identifier tg-0eaa4b9ab4EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "status": "DELETE_IN_PROGRESS"
}

Para obter mais informações, consulte Grupos de destino no Guia do usuário do Amazon VPC Lattice.

Para obter detalhes da API, consulte DeleteTargetGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar deregister-targets.

AWS CLI

Como cancelar o registro de um destino

O exemplo deregister-targets a seguir cancela o registro do destino especificado do grupo de destino especificado.


aws vpc-lattice deregister-targets \
    --targets i-07dd579bc5EXAMPLE \
    --target-group-identifier tg-0eaa4b9ab4EXAMPLE

Saída:


{
    "successful": [
        {
            "id": "i-07dd579bc5EXAMPLE",
            "port": 443
        }
    ],
    "unsuccessful": []
}

Para obter mais informações, consulte Registrar destinos no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte DeregisterTargets na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-auth-policy.

AWS CLI

Para obter informações sobre uma política de autenticação

O exemplo get-auth-policy a seguir obtém informações sobre a política de autenticação para o serviço especificado.


aws vpc-lattice get-auth-policy \
    --resource-identifier svc-0285b53b2eEXAMPLE

Saída:


{
    "createdAt": "2023-06-07T03:51:20.266Z",
    "lastUpdatedAt": "2023-06-07T04:39:27.082Z",
    "policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:role/my-clients\"},\"Action\":\"vpc-lattice-svcs:Invoke\",\"Resource\":\"arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE\"}]}",
    "state": "Active"
}

Para obter mais informações, consulte Políticas de autenticação no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetAuthPolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-listener.

AWS CLI

Para obter informações sobre um receptor de serviços

O exemplo get-listener a seguir obtém informações sobre o receptor especificado para o serviço especificado.


aws vpc-lattice get-listener \
    --listener-identifier listener-0ccf55918cEXAMPLE \
    --service-identifier svc-0285b53b2eEXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE/listener/listener-0ccf55918cEXAMPLE",
    "createdAt": "2023-05-07T05:08:45.192Z",
    "defaultAction": {
        "forward": {
            "targetGroups": [
                {
                    "targetGroupIdentifier": "tg-0ff213abb6EXAMPLE",
                    "weight": 1
                }
            ]
        }
    },
    "id": "listener-0ccf55918cEXAMPLE",
    "lastUpdatedAt": "2023-05-07T05:08:45.192Z",
    "name": "http-80",
    "port": 80,
    "protocol": "HTTP",
    "serviceArn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "serviceId": "svc-0285b53b2eEXAMPLE"
}

Para obter mais informações, consulte Definir roteamento no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetListener na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-resource-configuration.

AWS CLI

Como obter informações sobre uma configuração de recurso

O exemplo de get-resource-configuration a seguir obtém informações sobre a configuração de recurso especificada.


aws vpc-lattice get-resource-configuration \
    --resource-configuration-identifier rcfg-07129f3acded87625

Saída:


{
    "allowAssociationToShareableServiceNetwork": true,
    "amazonManaged": false,
    "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-07129f3acded87625",
    "createdAt": "2025-02-01T00:57:35.871000+00:00",
    "id": "rcfg-07129f3acded87625",
    "lastUpdatedAt": "2025-02-01T00:57:46.874000+00:00",
    "name": "my-resource-config",
    "portRanges": [
        "1-65535"
    ],
    "protocol": "TCP",
    "resourceConfigurationDefinition": {
        "ipResource": {
            "ipAddress": "10.0.14.85"
        }
    },
    "resourceGatewayId": "rgw-0bba03f3d56060135",
    "status": "ACTIVE",
    "type": "SINGLE"
}

Consulte mais informações em Resource gateways in VPC Lattice no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em GetResourceConfiguration na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-resource-gateway.

AWS CLI

Como obter informações sobre um gateway de recurso

O exemplo de get-resource-gateway a seguir obtém informações sobre o gateway de recurso especificado.


aws vpc-lattice get-resource-gateway \
    --resource-gateway-identifier rgw-0bba03f3d56060135

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourcegateway/rgw-0bba03f3d56060135",
    "createdAt": "2025-02-01T00:57:33.241000+00:00",
    "id": "rgw-0bba03f3d56060135",
    "ipAddressType": "IPV4",
    "lastUpdatedAt": "2025-02-01T00:57:44.351000+00:00",
    "name": "my-resource-gateway",
    "securityGroupIds": [
        "sg-087ffd596c5fe962c"
    ],
    "status": "ACTIVE",
    "subnetIds": [
        "subnet-08e8943905b63a683"
    ],
    "vpcId": "vpc-0bf4c2739bc05a694"
}

Consulte mais informações em Resource gateways in VPC Lattice no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em GetResourceGateway na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-service-network-service-association.

AWS CLI

Para obter informações sobre uma associação de serviços

O exemplo get-service-network-service-association a seguir obtém informações sobre a associação de serviço especificada.


aws vpc-lattice get-service-network-service-association \
    --service-network-service-association-identifier snsa-031fabb4d8EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetworkserviceassociation/snsa-031fabb4d8EXAMPLE",
    "createdAt": "2023-05-05T21:48:16.076Z",
    "createdBy": "123456789012",
    "dnsEntry": {
        "domainName": "my-lattice-service-0285b53b2eEXAMPLE.7d67968.vpc-lattice-svcs.us-east-2.on.aws",
        "hostedZoneId": "Z09127221KTH2CEXAMPLE"
    },
    "id": "snsa-031fabb4d8EXAMPLE",
    "serviceArn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "serviceId": "svc-0285b53b2eEXAMPLE",
    "serviceName": "my-lattice-service",
    "serviceNetworkArn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetwork/sn-080ec7dc93EXAMPLE",
    "serviceNetworkId": "sn-080ec7dc93EXAMPLE",
    "serviceNetworkName": "my-service-network",
    "status": "ACTIVE"
}

Para obter mais informações, consulte Gerenciar associações de serviços no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetServiceNetworkServiceAssociation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-service-network-vpc-association.

AWS CLI

Para obter informações sobre uma associação de VPC

O exemplo get-service-network-vpc-association a seguir obtém informações sobre a associação da VPC especificada.


aws vpc-lattice get-service-network-vpc-association \
    --service-network-vpc-association-identifier snva-0821fc8631EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetworkvpcassociation/snva-0821fc8631EXAMPLE",
    "createdAt": "2023-06-06T23:41:08.421Z",
    "createdBy": "123456789012",
    "id": "snva-0c5dcb60d6EXAMPLE",
    "lastUpdatedAt": "2023-06-06T23:41:08.421Z",
    "securityGroupIds": [
        "sg-0aee16bc6cEXAMPLE"
    ],
    "serviceNetworkArn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetwork/sn-080ec7dc93EXAMPLE",
    "serviceNetworkId": "sn-080ec7dc93EXAMPLE",
    "serviceNetworkName": "my-service-network",
    "status": "ACTIVE",
    "vpcId": "vpc-0a1b2c3d4eEXAMPLE"
}

Para obter mais informações, consulte Gerenciar associações da VPC no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetServiceNetworkVpcAssociation na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-service-network.

AWS CLI

Para obter informações sobre uma rede de serviços

O exemplo get-service-network a seguir obtém informações sobre a rede de serviço especificada.


aws vpc-lattice get-service-network \
    --service-network-identifier sn-080ec7dc93EXAMPLE

Saída:


{
   "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetwork/sn-080ec7dc93EXAMPLE",
   "authType": "AWS_IAM",
   "createdAt": "2023-05-05T15:26:08.417Z",
   "id": "sn-080ec7dc93EXAMPLE",
   "lastUpdatedAt": "2023-05-05T15:26:08.417Z",
   "name": "my-service-network",
   "numberOfAssociatedServices": 2,
   "numberOfAssociatedVPCs": 3
}

Para obter mais informações, consulte Redes de serviço no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetServiceNetwork na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-service.

AWS CLI

Para obter informações sobre um serviço

O exemplo get-service a seguir obtém informações sobre o serviço especificado.


aws vpc-lattice get-service \
    --service-identifier svc-0285b53b2eEXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "authType": "AWS_IAM",
    "createdAt": "2023-05-05T21:35:29.339Z",
    "dnsEntry": {
        "domainName": "my-lattice-service-0285b53b2eEXAMPLE.7d67968.vpc-lattice-svcs.us-east-2.on.aws",
        "hostedZoneId": "Z09127221KTH2CFUOHIZH"
    },
    "id": "svc-0285b53b2eEXAMPLE",
    "lastUpdatedAt": "2023-05-05T21:35:29.339Z",
    "name": "my-lattice-service",
    "status": "ACTIVE"
}

Para obter mais informações, consulte Serviços no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetService na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-target-group.

AWS CLI

Para obter informações sobre um grupo de destino

O exemplo get-target-group a seguir obtém informações sobre o grupo de destino especificado que tem um tipo de destino de INSTANCE.


aws vpc-lattice get-target-group \
    --target-group-identifier tg-0eaa4b9ab4EXAMPLE

Saída:


{
    "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-0eaa4b9ab4EXAMPLE",
    "config": {
        "healthCheck": {
            "enabled": true,
            "healthCheckIntervalSeconds": 30,
            "healthCheckTimeoutSeconds": 5,
            "healthyThresholdCount": 5,
            "matcher": {
                "httpCode": "200"
            },
            "path": "/",
            "protocol": "HTTPS",
            "protocolVersion": "HTTP1",
            "unhealthyThresholdCount": 2
        },
        "port": 443,
        "protocol": "HTTPS",
        "protocolVersion": "HTTP1",
        "vpcIdentifier": "vpc-f1663d9868EXAMPLE"
    },
    "createdAt": "2023-05-06T04:41:04.122Z",
    "id": "tg-0eaa4b9ab4EXAMPLE",
    "lastUpdatedAt": "2023-05-06T04:41:04.122Z",
    "name": "my-target-group",
    "serviceArns": [
        "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE"
    ],
    "status": "ACTIVE",
    "type": "INSTANCE"
}

Para obter mais informações, consulte Grupos de destino no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte GetTargetGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-listeners.

AWS CLI

Para listar os receptores de serviço

O exemplo list-listeners a seguir lista os receptores do serviço especificado.


aws vpc-lattice list-listeners \
    --service-identifier svc-0285b53b2eEXAMPLE

Saída:


{
    "items": [
        {
            "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE/listener/listener-0ccf55918cEXAMPLE",
            "createdAt": "2023-05-07T05:08:45.192Z",
            "id": "listener-0ccf55918cEXAMPLE",
            "lastUpdatedAt": "2023-05-07T05:08:45.192Z",
            "name": "http-80",
            "port": 80,
            "protocol": "HTTP"
        }
    ]
}

Para obter mais informações, consulte Definir roteamento no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte ListListeners na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-resource-configurations.

AWS CLI

Como listar as configurações de recursos

O exemplo de list-resource-configurations a seguir lista todas as configurações de recursos.


aws vpc-lattice list-resource-configurations

Saída:


{
    "items": [
        {
            "amazonManaged": false,
            "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-07129f3acded87625",
            "createdAt": "2025-02-01T00:57:35.871000+00:00",
            "id": "rcfg-07129f3acded87625",
            "lastUpdatedAt": "2025-02-01T00:57:46.874000+00:00",
            "name": "my-resource-config",
            "resourceGatewayId": "rgw-0bba03f3d56060135",
            "status": "ACTIVE",
            "type": "SINGLE"
        }
    ]
}

Consulte mais informações em Resource configurations no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em ListResourceConfigurations na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-resource-endpoint-associations.

AWS CLI

Como listar as associações de endpoint da VPC

O exemplo de list-resource-endpoint-associations a seguir lista os endpoints da VPC associados à configuração de recurso especificada.


aws vpc-lattice list-resource-endpoint-associations \
    --resource-configuration-identifier rcfg-07129f3acded87625

Saída:


{
    "items": [
        {
            "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceendpointassociation/rea-0956a7435baf89326",
            "createdAt": "2025-02-01T00:57:38.998000+00:00",
            "id": "rea-0956a7435baf89326",
            "resourceConfigurationArn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourceconfiguration/rcfg-07129f3acded87625",
            "resourceConfigurationId": "rcfg-07129f3acded87625",
            "vpcEndpointId": "vpce-019b90d6f16d4f958",
            "vpcEndpointOwner": "123456789012"
        }
    ]
}

Consulte mais informações em Manage associations for a VPC Lattice resource configuration no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em ListResourceEndpointAssociations na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-resource-gateways.

AWS CLI

Como listar os gateways de recurso

O exemplo de list-resource-gateways a seguir lista todos os gateways de recurso.


aws vpc-lattice list-resource-gateways

Saída:


{
    "items": [
        {
            "arn": "arn:aws:vpc-lattice:us-east-1:123456789012:resourcegateway/rgw-0bba03f3d56060135",
            "createdAt": "2025-02-01T00:57:33.241000+00:00",
            "id": "rgw-0bba03f3d56060135",
            "ipAddressType": "IPV4",
            "lastUpdatedAt": "2025-02-01T00:57:44.351000+00:00",
            "name": "my-resource-gateway",
            "seurityGroupIds": [
                "sg-087ffd596c5fe962c"
            ],
            "status": "ACTIVE",
            "subnetIds": [
                "subnet-08e8943905b63a683"
            ],
            "vpcIdentifier": "vpc-0bf4c2739bc05a694"
        }
    ]
}

Consulte mais informações em Resource gateways in VPC Lattice no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em ListResourceGateways na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-service-network-service-associations.

AWS CLI

Para listar associações de serviço

O exemplo list-service-network-service-associations a seguir lista as associações de serviço para a rede de serviços especificada. A opção --query define o escopo da saída para os IDs das associações de serviços.


aws vpc-lattice list-service-network-service-associations \
    --service-network-identifier sn-080ec7dc93EXAMPLE \
    --query items[*].id

Saída:


[
    "snsa-031fabb4d8EXAMPLE",
    "snsa-0e16955a8cEXAMPLE"
]

Para obter mais informações, consulte Gerenciar associações de serviços no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte ListServiceNetworkServiceAssociations na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-service-network-vpc-associations.

AWS CLI

Para listar associações de VPC

O exemplo list-service-network-vpc-associations a seguir lista as associações da VPC para a rede de serviços especificada. A opção --query define o escopo da saída para os IDs das associações da VPC.


aws vpc-lattice list-service-network-vpc-associations \
    --service-network-identifier sn-080ec7dc93EXAMPLE \
    --query items[*].id

Saída:


[
    "snva-0821fc8631EXAMPLE",
    "snva-0c5dcb60d6EXAMPLE"
]

Para obter mais informações, consulte Gerenciar associações da VPC no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte ListServiceNetworkVpcAssociations na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-service-network-vpc-endpoint-associations.

AWS CLI

Como listar as associações de endpoint da VPC

O exemplo de list-service-network-vpc-endpoint-associations a seguir lista os endpoints da VPC associados à rede de serviço especificada.


aws vpc-lattice list-service-network-vpc-endpoint-associations \
    --service-network-identifier sn-0808d1748faee0c1e

Saída:


{
    "items": [
        {
            "createdAt": "2025-02-01T01:21:36.667000+00:00",
            "serviceNetworkArn": "arn:aws:vpc-lattice:us-east-1:123456789012:servicenetwork/sn-0808d1748faee0c1e",
            "state": "ACTIVE",
            "vpcEndpointId": "vpce-0cc199f605eaeace7",
            "vpcEndpointOwnerId": "123456789012"
        }
    ]
}

Consulte mais informações em Manage the associations for a VPC Lattice service network no Guia do usuário da Amazon VPC Lattice.

Consulte detalhes da API em ListServiceNetworkVpcEndpointAssociations na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-service-networks.

AWS CLI

Para listar suas redes de serviços

O exemplo list-service-networks a seguir lista as redes de serviço pertencentes ou compartilhadas com a conta de chamada. A opção --query atribui os resultados aos nomes do recurso da Amazon (ARNs) das redes de serviços.


aws vpc-lattice list-service-networks \
    --query items[*].arn

Saída:


[
    "arn:aws:vpc-lattice:us-east-2:123456789012:servicenetwork/sn-080ec7dc93EXAMPLE",
    "arn:aws:vpc-lattice:us-east-2:111122223333:servicenetwork/sn-0ec4d436cfEXAMPLE"
]

Para obter mais informações, consulte Redes de serviço no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte ListServiceNetworks na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-services.

AWS CLI

Para listar seus serviços

O exemplo list-services a seguir lista os serviços de propriedade ou compartilhados com a conta de chamada. A opção --query atribui os resultados aos nomes do recurso da Amazon (ARNs) dos serviços.


aws vpc-lattice list-services \
    --query items[*].arn

Saída:


[
    "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE",
    "arn:aws:vpc-lattice:us-east-2:111122223333:service/svc-0b8ac96550EXAMPLE"
]

Para obter mais informações, consulte Serviços no Guia do usuário do Amazon VPC Lattice.

Para obter detalhes da API, consulte ListServices na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-target-groups.

AWS CLI

Para listar seus grupos de destino

O exemplo list-target-groups a seguir lista os grupos de destino com um tipo de destino de LAMBDA.


aws vpc-lattice list-target-groups \
    --target-group-type LAMBDA

Saída:


{
    "items": [
        {
            "arn": "arn:aws:vpc-lattice:us-east-2:123456789012:targetgroup/tg-045c1b7d9dEXAMPLE",
            "createdAt": "2023-05-06T05:22:16.637Z",
            "id": "tg-045c1b7d9dEXAMPLE",
            "lastUpdatedAt": "2023-05-06T05:22:16.637Z",
            "name": "my-target-group-lam",
            "serviceArns": [
                "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE"
            ],
            "status": "ACTIVE",
            "type": "LAMBDA"
        }
    ]
}

Para obter mais informações, consulte Grupos de destino no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte ListTargetGroups na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-targets.

AWS CLI

Para listar os destinos de um grupo de destino

O exemplo list-targets a seguir lista os destinos para o grupo de destino especificado.


aws vpc-lattice list-targets \
    --target-group-identifier tg-0eaa4b9ab4EXAMPLE

Saída:


{
    "items": [
        {
            "id": "i-07dd579bc5EXAMPLE",
            "port": 443,
            "status": "HEALTHY"
        },
        {
            "id": "i-047b3c9078EXAMPLE",
            "port": 443,
            "reasonCode": "HealthCheckFailed",
            "status": "UNHEALTHY"
        }
    ]
}

Para obter mais informações, consulte Grupos de destino no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte ListTargets na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-auth-policy.

AWS CLI

Para criar uma política de autenticação para um serviço

O exemplo put-auth-policy a seguir concede acesso às solicitações de qualquer entidade principal autenticada que use o perfil do IAM especificado. O recurso é o ARN do serviço ao qual a política está anexada.


aws vpc-lattice put-auth-policy \
    --resource-identifier svc-0285b53b2eEXAMPLE \
    --policy file://auth-policy.json

Conteúdo de auth-policy.json:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::123456789012:role/my-clients"
            },
            "Action": "vpc-lattice-svcs:Invoke",
            "Resource": "arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE"
        }
    ]
}

Saída:


{
    "policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:role/my-clients\"},\"Action\":\"vpc-lattice-svcs:Invoke\",\"Resource\":\"arn:aws:vpc-lattice:us-east-2:123456789012:service/svc-0285b53b2eEXAMPLE\"}]}",
    "state": "Active"
}

Para obter mais informações, consulte Políticas de autenticação no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte PutAuthPolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar register-targets.

AWS CLI

Para registrar um destino

O exemplo register-targets a seguir registra os destinos especificados com o grupo de destino especificado.


aws vpc-lattice register-targets \
    --targets id=i-047b3c9078EXAMPLE id=i-07dd579bc5EXAMPLE \
    --target-group-identifier tg-0eaa4b9ab4EXAMPLE

Saída:


{
    "successful": [
        {
            "id": "i-07dd579bc5EXAMPLE",
            "port": 443
        }
    ],
    "unsuccessful": [
        {
            "failureCode": "UnsupportedTarget",
            "failureMessage": "Instance targets must be in the same VPC as their target group",
            "id": "i-047b3c9078EXAMPLE",
            "port": 443
        }
    ]
}

Para obter mais informações, consulte Registrar destinos no Guia do usuário do Amazon VPC Lattice.

Para ver detalhes da API, consulte RegisterTargets na Referência de comandos da AWS CLI.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Permissões verificadas

AWS WAF Classic