Exemplos do Network Manager usando AWS CLI - AWS Command Line Interface
Ações

Esta documentação é para a AWS CLI única versão 1. Para obter a documentação relacionada à versão 2 do AWS CLI, consulte o Guia do usuário da versão 2.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Exemplos do Network Manager usando AWS CLI

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

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções 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, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

O código de exemplo a seguir mostra como usar associate-customer-gateway.

AWS CLI

Para associar um gateway do cliente

O associate-customer-gateway exemplo a seguir associa o gateway do cliente cgw-11223344556677889 na rede global especificada ao dispositivodevice-07f6fd08867abc123.

aws networkmanager associate-customer-gateway \
    --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889  \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --region us-west-2

Saída:

{
    "CustomerGatewayAssociation": {
        "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889",
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "State": "PENDING"
    }
}

Para obter mais informações, consulte Customer Gateway Associations no Guia do Gerenciador de Rede do Transit Gateway.

O código de exemplo a seguir mostra como usar associate-link.

AWS CLI

Para associar um link

O associate-link exemplo a seguir associa o link link-11112222aaaabbbb1 ao dispositivodevice-07f6fd08867abc123. O link e o dispositivo estão na rede global especificada.

aws networkmanager associate-link \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --link-id link-11112222aaaabbbb1 \
    --region us-west-2

Saída:

{
    "LinkAssociation": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "LinkId": "link-11112222aaaabbbb1",
        "LinkAssociationState": "PENDING"
    }
}

Para obter mais informações, consulte Associações de dispositivos e links no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte AssociateLinkna Referência de AWS CLI Comandos.

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

AWS CLI

Para criar uma rede principal

O create-core-network exemplo a seguir cria uma rede principal usando uma descrição e tags opcionais em uma rede WAN global do AWS Cloud.

aws networkmanager create-core-network \
    --global-network-id global-network-cdef-EXAMPLE22222 \
    --description "Main headquarters location" \
    --tags Key=Name,Value="New York City office"

Saída:

{
    "CoreNetwork": {
        "GlobalNetworkId": "global-network-cdef-EXAMPLE22222",
        "CoreNetworkId": "core-network-cdef-EXAMPLE33333",
        "CoreNetworkArn": "arn:aws:networkmanager::987654321012:core-network/core-network-cdef-EXAMPLE33333",
        "Description": "Main headquarters location",
        "CreatedAt": "2022-01-10T19:53:59+00:00",
        "State": "AVAILABLE",
        "Tags": [
            {
                "Key": "Name",
                "Value": "New York City office"
            }
        ]
    }
}

Para obter mais informações, consulte Redes globais e principais no Guia WAN do usuário da AWS nuvem.

  • Para API obter detalhes, consulte CreateCoreNetworkna Referência de AWS CLI Comandos.

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

AWS CLI

Para criar um dispositivo

O create-device exemplo a seguir cria um dispositivo na rede global especificada. Os detalhes do dispositivo incluem uma descrição, o tipo, o fornecedor, o modelo e o número de série.

aws networkmanager create-device
    --global-network-id global-network-01231231231231231 \
    --description "New York office device" \
    --type "office device" \
    --vendor "anycompany" \
    --model "abcabc" \
    --serial-number "1234" \
    --region us-west-2

Saída:

{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York office device",
        "Type": "office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "CreatedAt": 1575554005.0,
        "State": "PENDING"
    }
}

Para obter mais informações, consulte Trabalhando com dispositivos no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte CreateDevicena Referência de AWS CLI Comandos.

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

AWS CLI

Para criar uma rede global

Os create-global-network exemplos a seguir criam uma nova rede global. O estado inicial após a criação éPENDING.

aws networkmanager create-global-network

Saída:

{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-00a77fc0f722dae74",
        "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-00a77fc0f722dae74",
        "CreatedAt": "2022-03-14T20:31:56+00:00",
        "State": "PENDING"
    }
}

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

AWS CLI

Para criar um link

O create-link exemplo a seguir cria um link na rede global especificada. O link inclui uma descrição e detalhes sobre o tipo de link, a largura de banda e o provedor. O ID do site indica o site ao qual o link está associado.

aws networkmanager create-link \
    --global-network-id global-network-01231231231231231 \
    --description "VPN Link" \
    --type "broadband" \
    --bandwidth UploadSpeed=10,DownloadSpeed=20 \
    --provider "AnyCompany" \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

Saída:

{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 10,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "PENDING"
    }
}

Para obter mais informações, consulte Trabalhando com links no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte CreateLinkna Referência de AWS CLI Comandos.

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

AWS CLI

Para criar um site

O create-site exemplo a seguir cria um site na rede global especificada. Os detalhes do site incluem uma descrição e as informações de localização.

aws networkmanager create-site \
    --global-network-id global-network-01231231231231231 \
    --description  "New York head office" \
    --location Latitude=40.7128,Longitude=-74.0060 \
    --region us-west-2

Saída:

{
    "Site": {
        "SiteId": "site-444555aaabbb11223",
        "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York head office",
        "Location": {
            "Latitude": "40.7128",
            "Longitude": "-74.0060"
        },
        "CreatedAt": 1575554300.0,
        "State": "PENDING"
    }
}

Para obter mais informações, consulte Trabalhando com sites no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte CreateSitena Referência de AWS CLI Comandos.

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

AWS CLI

Para criar um VPC anexo

O create-vpc-attachment exemplo a seguir cria um VPC anexo com IPv6 suporte em uma rede principal.

aws networkmanager create-vpc-attachment \
    --core-network-id core-network-0fab62fe438d94db6 \
    --vpc-arn arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8  \
    --subnet-arns arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7 \
    --Ipv6Support=true

Saída:

{
    "VpcAttachment": {
        "Attachment": {
            "CoreNetworkId": "core-network-0fab62fe438d94db6",
            "AttachmentId": "attachment-05e1da6eba87a06e6",
            "OwnerAccountId": "987654321012",
            "AttachmentType": "VPC",
            "State": "CREATING",
            "EdgeLocation": "us-east-1",
            "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8",
            "Tags": [],
            "CreatedAt": "2022-03-10T20:59:14+00:00",
            "UpdatedAt": "2022-03-10T20:59:14+00:00"
        },
        "SubnetArns": [
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7"
        ],
        "Options": {
            "Ipv6Support": true
        }
    }
}

Para obter mais informações, consulte Criar um anexo no Cloud WAN User Guide.

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

AWS CLI

Para excluir um anexo

O delete-attachment exemplo a seguir exclui um anexo do Connect.

aws networkmanager delete-attachment \
    --attachment-id attachment-01feddaeae26ab68c

Saída:

{
    "Attachment": {
        "CoreNetworkId": "core-network-0f4b0a9d5ee7761d1",
        "AttachmentId": "attachment-01feddaeae26ab68c",
        "OwnerAccountId": "987654321012",
        "AttachmentType": "CONNECT",
        "State": "DELETING",
        "EdgeLocation": "us-east-1",
        "ResourceArn": "arn:aws:networkmanager::987654321012:attachment/attachment-02c3964448fedf5aa",
        "CreatedAt": "2022-03-15T19:18:41+00:00",
        "UpdatedAt": "2022-03-15T19:28:59+00:00"
    }
}

Para obter mais informações, consulte Excluir anexos no Cloud WAN User Guide.

  • Para API obter detalhes, consulte DeleteAttachmentna Referência de AWS CLI Comandos.

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

AWS CLI

Para excluir uma configuração de análise de um bucket

O exemplo delete-bucket-analytics-configuration a seguir recupera a configuração referente ao bucket e ID especificados.

aws s3api delete-bucket-analytics-configuration \
    --bucket my-bucket \
    --id 1

Este comando não produz saída.

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

AWS CLI

Para excluir uma configuração de métricas referente a um bucket

O exemplo delete-bucket-metrics-configuration a seguir remove a configuração referente ao bucket e ID especificados.

aws s3api delete-bucket-metrics-configuration \
    --bucket my-bucket \
    --id 123

Este comando não produz saída.

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

AWS CLI

Para excluir uma rede principal

O delete-core-network exemplo a seguir exclui uma rede principal de uma rede WAN global em nuvem.

aws networkmanager delete-core-network \
    --core-network-id core-network-0fab62fe438d94db6

Saída:

{
    "CoreNetwork": {
        "GlobalNetworkId": "global-network-0d59060f16a73bc41",
        "CoreNetworkId": "core-network-0fab62fe438d94db6",
        "Description": "Main headquarters location",
        "CreatedAt": "2021-12-09T18:31:11+00:00",
        "State": "DELETING",
        "Segments": [
            {
                "Name": "dev",
                "EdgeLocations": [
                    "us-east-1"
                ],
                "SharedSegments": []
            }
        ],
        "Edges": [
            {
                "EdgeLocation": "us-east-1",
                "Asn": 64512,
                "InsideCidrBlocks": []
            }
        ]
    }
}

Para obter mais informações, consulte o Guia do WAN usuário de redes principais no Cloud.

  • Para API obter detalhes, consulte DeleteCoreNetworkna Referência de AWS CLI Comandos.

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

AWS CLI

Para excluir um dispositivo

O delete-device exemplo a seguir exclui o dispositivo especificado da rede global especificada.

aws networkmanager delete-device \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --region us-west-2

Saída:

{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York office device",
        "Type": "office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "SiteId": "site-444555aaabbb11223",
        "CreatedAt": 1575554005.0,
        "State": "DELETING"
    }
}

Para obter mais informações, consulte Trabalhando com dispositivos no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte DeleteDevicena Referência de AWS CLI Comandos.

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

AWS CLI

Para excluir uma rede global

O delete-global-network exemplo a seguir exclui uma rede global.

aws networkmanager delete-global-network \
    --global-network-id global-network-052bedddccb193b6b

Saída:

{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-052bedddccb193b6b",
        "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-052bedddccb193b6b",
        "CreatedAt": "2021-12-09T18:19:12+00:00",
        "State": "DELETING"
    }
}

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

AWS CLI

Para excluir um link

O delete-link exemplo a seguir exclui o link especificado da rede global especificada.

aws networkmanager delete-link \
    --global-network-id global-network-01231231231231231  \
    --link-id link-11112222aaaabbbb1 \
    --region us-west-2

Saída:

{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 20,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "DELETING"
    }
}

Para obter mais informações, consulte Trabalhando com links no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte DeleteLinkna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-public-access-block.

AWS CLI

Para excluir a configuração do Bloqueio de Acesso Público para um bucket

O exemplo delete-public-access-block a seguir remove a configuração do Bloqueio de Acesso Público no bucket especificado.

aws s3api delete-public-access-block \
    --bucket my-bucket

Este comando não produz saída.

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

AWS CLI

Para excluir um site

O delete-site exemplo a seguir exclui o site especificado (site-444555aaabbb11223) na rede global especificada.

aws networkmanager delete-site \
    --global-network-id global-network-01231231231231231  \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

Saída:

{
    "Site": {
        "SiteId": "site-444555aaabbb11223",
        "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York head office",
        "Location": {
            "Latitude": "40.7128",
            "Longitude": "-74.0060"
        },
        "CreatedAt": 1575554300.0,
        "State": "DELETING"
    }
}

Para obter mais informações, consulte Trabalhando com sites no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte DeleteSitena Referência de AWS CLI Comandos.

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

AWS CLI

Para cancelar o registro de um gateway de trânsito de uma rede global

O deregister-transit-gateway exemplo a seguir cancela o registro do gateway de trânsito especificado da rede global especificada.

aws networkmanager deregister-transit-gateway \
    --global-network-id global-network-01231231231231231 \
    --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \
    --region us-west-2

Saída:

{
    "TransitGatewayRegistration": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
        "State": {
            "Code": "DELETING"
        }
    }
}

Para obter mais informações, consulte Registros do Transit Gateway no Guia do Gerenciador de Rede do Transit Gateway.

O código de exemplo a seguir mostra como usar describe-global-networks.

AWS CLI

Para descrever suas redes globais

O describe-global-networks exemplo a seguir descreve todas as suas redes globais em sua conta.

aws networkmanager describe-global-networks \
    --region us-west-2

Saída:

{
    "GlobalNetworks": [
        {
            "GlobalNetworkId": "global-network-01231231231231231",
            "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
            "Description": "Company 1 global network",
            "CreatedAt": 1575553525.0,
            "State": "AVAILABLE"
        }
    ]
}

O código de exemplo a seguir mostra como usar disassociate-customer-gateway.

AWS CLI

Para desassociar um gateway do cliente

O disassociate-customer-gateway exemplo a seguir desassocia o gateway do cliente especificado (cgw-11223344556677889) da rede global especificada.

aws networkmanager disassociate-customer-gateway \
    --global-network-id global-network-01231231231231231 \
    --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \
    --region us-west-2

Saída:

{
    "CustomerGatewayAssociation": {
        "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889",
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "State": "DELETING"
    }
}

Para obter mais informações, consulte Customer Gateway Associations no Guia do Gerenciador de Rede do Transit Gateway.

O código de exemplo a seguir mostra como usar disassociate-link.

AWS CLI

Para desassociar um link

O disassociate-link exemplo a seguir desassocia o link especificado do dispositivo device-07f6fd08867abc123 na rede global especificada.

aws networkmanager disassociate-link \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --link-id link-11112222aaaabbbb1 \
    --region us-west-2

Saída:

{
    "LinkAssociation": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "LinkId": "link-11112222aaaabbbb1",
        "LinkAssociationState": "DELETING"
    }
}

Para obter mais informações, consulte Associações de dispositivos e links no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte DisassociateLinkna Referência de AWS CLI Comandos.

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

AWS CLI

Para recuperar a configuração de análise de um bucket com um ID específico

O exemplo get-bucket-analytics-configuration a seguir recupera a configuração de análise referente ao bucket e ID especificados.

aws s3api get-bucket-analytics-configuration \
    --bucket my-bucket \
    --id 1

Saída:

{
    "AnalyticsConfiguration": {
        "StorageClassAnalysis": {},
        "Id": "1"
    }
}

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

AWS CLI

Para recuperar a configuração de métricas de um bucket com um ID específico

O exemplo get-bucket-metrics-configuration a seguir exibe a configuração de métricas referente ao bucket e ID especificados.

aws s3api get-bucket-metrics-configuration \
    --bucket my-bucket \
    --id 123

Saída:

{
    "MetricsConfiguration": {
        "Filter": {
            "Prefix": "logs"
        },
        "Id": "123"
    }
}

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

AWS CLI

Para obter suas associações de gateway de clientes

O get-customer-gateway-associations exemplo a seguir obtém as associações de gateway do cliente para a rede global especificada.

aws networkmanager get-customer-gateway-associations \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

Saída:

{
    "CustomerGatewayAssociations": [
        {
            "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889",
            "GlobalNetworkId": "global-network-01231231231231231",
            "DeviceId": "device-07f6fd08867abc123",
            "State": "AVAILABLE"
        }
    ]
}

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

AWS CLI

Para obter seus dispositivos

O get-devices exemplo a seguir obtém os dispositivos na rede global especificada.

aws networkmanager get-devices \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

Saída:

{
    "Devices": [
        {
            "DeviceId": "device-07f6fd08867abc123",
            "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
            "GlobalNetworkId": "global-network-01231231231231231",
            "Description": "NY office device",
            "Type": "office device",
            "Vendor": "anycompany",
            "Model": "abcabc",
            "SerialNumber": "1234",
            "CreatedAt": 1575554005.0,
            "State": "AVAILABLE"
        }
    ]
}

  • Para API obter detalhes, consulte GetDevicesna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter suas associações de links

O get-link-associations exemplo a seguir obtém as associações de links na rede global especificada.

aws networkmanager get-link-associations \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

Saída:

{
    "LinkAssociations": [
        {
            "GlobalNetworkId": "global-network-01231231231231231",
            "DeviceId": "device-07f6fd08867abc123",
            "LinkId": "link-11112222aaaabbbb1",
            "LinkAssociationState": "AVAILABLE"
        }
    ]
}

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

AWS CLI

Para obter seus links

O get-links exemplo a seguir obtém os links na rede global especificada.

aws networkmanager get-links \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

Saída:

{
    "Links": [
        {
            "LinkId": "link-11112222aaaabbbb1",
            "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
            "GlobalNetworkId": "global-network-01231231231231231",
            "SiteId": "site-444555aaabbb11223",
            "Description": "VPN Link",
            "Type": "broadband",
            "Bandwidth": {
                "UploadSpeed": 10,
                "DownloadSpeed": 20
            },
            "Provider": "AnyCompany",
            "CreatedAt": 1575555811.0,
            "State": "AVAILABLE"
        }
    ]
}

  • Para API obter detalhes, consulte GetLinksna Referência de AWS CLI Comandos.

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

AWS CLI

Como recuperar a configuração de retenção de objetos de um objeto

O exemplo de get-object-retention a seguir recupera a configuração de retenção de objetos do objeto especificado.

aws s3api get-object-retention \
    --bucket my-bucket-with-object-lock \
    --key doc1.rtf

Saída:

{
    "Retention": {
        "Mode": "GOVERNANCE",
        "RetainUntilDate": "2025-01-01T00:00:00.000Z"
    }
}

O código de exemplo a seguir mostra como usar get-public-access-block.

AWS CLI

Para definir ou modificar a configuração do Bloqueio de Acesso Público de um bucket

O exemplo get-public-access-block a seguir exibe a configuração do Bloqueio de Acesso Público do bucket especificado.

aws s3api get-public-access-block --bucket my-bucket

Saída:

{
    "PublicAccessBlockConfiguration": {
        "IgnorePublicAcls": true,
        "BlockPublicPolicy": true,
        "BlockPublicAcls": true,
        "RestrictPublicBuckets": true
    }
}

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

AWS CLI

Para obter seus sites

O get-sites exemplo a seguir obtém os sites na rede global especificada.

aws networkmanager get-sites \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

Saída:

{
    "Sites": [
        {
            "SiteId": "site-444555aaabbb11223",
            "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
            "GlobalNetworkId": "global-network-01231231231231231",
            "Description": "NY head office",
            "Location": {
                "Latitude": "40.7128",
                "Longitude": "-74.0060"
            },
            "CreatedAt": 1575554528.0,
            "State": "AVAILABLE"
        }
    ]
}

  • Para API obter detalhes, consulte GetSitesna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter seus registros de gateway de trânsito

O get-transit-gateway-registrations exemplo a seguir obtém os gateways de trânsito registrados na rede global especificada.

aws networkmanager get-transit-gateway-registrations \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

Saída:

{
    "TransitGatewayRegistrations": [
        {
            "GlobalNetworkId": "global-network-01231231231231231",
            "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
            "State": {
                "Code": "AVAILABLE"
            }
        }
    ]
}

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

AWS CLI

Para obter um VPC anexo

O get-vpc-attachment exemplo a seguir retorna informações sobre um VPC anexo.

aws networkmanager get-vpc-attachment \
    --attachment-id  attachment-03b7ea450134787da

Saída:

{
    "VpcAttachment": {
        "Attachment": {
            "CoreNetworkId": "core-network-0522de1b226a5d7b3",
            "AttachmentId": "attachment-03b7ea450134787da",
            "OwnerAccountId": "987654321012",
            "AttachmentType": "VPC",
            "State": "CREATING",
            "EdgeLocation": "us-east-1",
            "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda",
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "DevVPC"
                }
            ],
            "CreatedAt": "2022-03-11T17:48:58+00:00",
            "UpdatedAt": "2022-03-11T17:48:58+00:00"
        },
        "SubnetArns": [
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-202cde6c",
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-e5022dba",
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-2387ae02",
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-cda9dffc"
        ],
        "Options": {
            "Ipv6Support": false
        }
    }
}

Para obter mais informações, consulte Anexos no Guia do WANusuário do Cloud.

  • Para API obter detalhes, consulte GetVpcAttachmentna Referência de AWS CLI Comandos.

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

AWS CLI

Como recuperar uma lista de configurações de análise de um bucket

O exemplo list-bucket-analytics-configurations a seguir recupera uma lista de configurações de análise do bucket especificado.

aws s3api list-bucket-analytics-configurations \
    --bucket my-bucket

Saída:

{
    "AnalyticsConfigurationList": [
        {
            "StorageClassAnalysis": {},
            "Id": "1"
        }
    ],
    "IsTruncated": false
}

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

AWS CLI

Para recuperar uma lista de configurações de métricas para um bucket

O list-bucket-metrics-configurations exemplo a seguir recupera uma lista de configurações de métricas para o bucket especificado.

aws s3api list-bucket-metrics-configurations \
    --bucket my-bucket

Saída:

{
    "IsTruncated": false,
    "MetricsConfigurationList": [
        {
            "Filter": {
                "Prefix": "logs"
            },
            "Id": "123"
        },
        {
            "Filter": {
                "Prefix": "tmp"
            },
            "Id": "234"
        }
    ]
}

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

AWS CLI

Para listar as tags de um recurso

O list-tags-for-resource exemplo a seguir lista as tags do recurso de dispositivo especificado (device-07f6fd08867abc123).

aws networkmanager list-tags-for-resource \
    --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \
    --region us-west-2

Saída:

{
    "TagList": [
        {
            "Key": "Network",
            "Value": "Northeast"
        }
    ]
}

O código de exemplo a seguir mostra como usar put-bucket-metrics-configuration.

AWS CLI

Para definir uma configuração de métricas para um bucket

O put-bucket-metrics-configuration exemplo a seguir define uma configuração métrica com ID 123 para o bucket especificado.

aws s3api put-bucket-metrics-configuration \
    --bucket my-bucket \
    --id 123 \
    --metrics-configuration '{"Id": "123", "Filter": {"Prefix": "logs"}}'

Este comando não produz saída.

O código de exemplo a seguir mostra como usar put-object-retention.

AWS CLI

Como definir uma configuração de retenção de objetos para um objeto

O exemplo de put-object-retention a seguir define uma configuração de retenção de objetos para o objeto especificado até 2025-01-01.

aws s3api put-object-retention \
    --bucket my-bucket-with-object-lock \
    --key doc1.rtf \
    --retention '{ "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00" }'

Este comando não produz saída.

O código de exemplo a seguir mostra como usar put-public-access-block.

AWS CLI

Para definir a configuração do bloco de acesso público para um bucket

O put-public-access-block exemplo a seguir define uma configuração restritiva de acesso público de blocos para o bucket especificado.

aws s3api put-public-access-block \
    --bucket my-bucket \
    --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true"

Este comando não produz saída.

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

AWS CLI

Para registrar um gateway de trânsito em uma rede global

O register-transit-gateway exemplo a seguir registra o gateway de trânsito tgw-123abc05e04123abc na rede global especificada.

aws networkmanager register-transit-gateway \
    --global-network-id global-network-01231231231231231 \
    --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \
    --region us-west-2

Saída:

{
    "TransitGatewayRegistration": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
        "State": {
            "Code": "PENDING"
        }
    }
}

Para obter mais informações, consulte Registros do Transit Gateway no Guia do Gerenciador de Rede do Transit Gateway.

O código de exemplo a seguir mostra como usar reject-attachment.

AWS CLI

Para rejeitar um anexo

O reject-attachment exemplo a seguir rejeita uma solicitação de VPC anexo.

aws networkmanager reject-attachment \
    --attachment-id  attachment-03b7ea450134787da

Saída:

{
    "Attachment": {
        "CoreNetworkId": "core-network-0522de1b226a5d7b3",
        "AttachmentId": "attachment-03b7ea450134787da",
        "OwnerAccountId": "987654321012",
        "AttachmentType": "VPC",
        "State": "AVAILABLE",
        "EdgeLocation": "us-east-1",
        "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda",
        "CreatedAt": "2022-03-11T17:48:58+00:00",
        "UpdatedAt": "2022-03-11T17:51:25+00:00"
    }
}

Para obter mais informações, consulte Aceitação de anexos no Cloud WAN User Guide.

  • Para API obter detalhes, consulte RejectAttachmentna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar start-route-analysis.

AWS CLI

Para iniciar a análise da rota

O start-route-analysis exemplo a seguir inicia a análise entre a origem e o destino, incluindo o opcionalinclude-return-path.

aws networkmanager start-route-analysis \
    --global-network-id global-network-00aa0aaa0b0aaa000 \
    --source TransitGatewayAttachmentArn=arn:aws:ec2:us-east-1:503089527312:transit-gateway-attachment/tgw-attach-0d4a2d491bf68c093,IpAddress=10.0.0.0 \
    --destination TransitGatewayAttachmentArn=arn:aws:ec2:us-west-1:503089527312:transit-gateway-attachment/tgw-attach-002577f30bb181742,IpAddress=11.0.0.0 \
    --include-return-path

Saída:

{
    "RouteAnalysis": {
        "GlobalNetworkId": "global-network-00aa0aaa0b0aaa000
        "OwnerAccountId": "1111222233333",
        "RouteAnalysisId": "a1873de1-273c-470c-1a2bc2345678",
        "StartTimestamp": 1695760154.0,
        "Status": "RUNNING",
        "Source": {
            "TransitGatewayAttachmentArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway-attachment/tgw-attach-1234567890abcdef0,
            "TransitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-abcdef01234567890",
            "IpAddress": "10.0.0.0"
        },
        "Destination": {
            "TransitGatewayAttachmentArn": "arn:aws:ec2:us-west-1:555555555555:transit-gateway-attachment/tgw-attach-021345abcdef6789",
            "TransitGatewayArn": "arn:aws:ec2:us-west-1:111122223333:transit-gateway/tgw-09876543210fedcba0",
            "IpAddress": "11.0.0.0"
        },
        "IncludeReturnPath": true,
        "UseMiddleboxes": false
    }
}

Para obter mais informações, consulte o Route Analyzer no Guia do usuário de redes AWS globais para gateways de trânsito.

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

AWS CLI

Para aplicar tags a um recurso

O tag-resource exemplo a seguir aplica a tag Network=Northeast ao dispositivodevice-07f6fd08867abc123.

aws networkmanager tag-resource \
    --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \
    --tags Key=Network,Value=Northeast \
    --region us-west-2

Este comando não produz saída.

  • Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

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

AWS CLI

Como remover as tags de um recurso

O untag-resource exemplo a seguir remove a tag com a chave Network do dispositivodevice-07f6fd08867abc123.

aws networkmanager untag-resource \
    --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 ]
    --tag-keys Network \
    --region us-west-2

Este comando não produz saída.

  • Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-device.

AWS CLI

Para atualizar um dispositivo

O update-device exemplo a seguir atualiza o dispositivo device-07f6fd08867abc123 especificando uma ID do site para o dispositivo.

aws networkmanager update-device \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

Saída:

{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "NY office device",
        "Type": "Office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "SiteId": "site-444555aaabbb11223",
        "CreatedAt": 1575554005.0,
        "State": "UPDATING"
    }
}

Para obter mais informações, consulte Trabalhando com dispositivos no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte UpdateDevicena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-global-network.

AWS CLI

Para atualizar uma rede global

O update-global-network exemplo a seguir atualiza a descrição da rede globalglobal-network-01231231231231231.

aws networkmanager update-global-network \
    --global-network-id global-network-01231231231231231 \
    --description "Head offices" \
    --region us-west-2

Saída:

{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
        "Description": "Head offices",
        "CreatedAt": 1575553525.0,
        "State": "UPDATING"
    }
}

Para obter mais informações, consulte Redes globais no Guia do Gerenciador de Redes do Transit Gateway.

O código de exemplo a seguir mostra como usar update-link.

AWS CLI

Para atualizar um link

O update-link exemplo a seguir atualiza as informações de largura de banda do linklink-11112222aaaabbbb1.

aws networkmanager update-link \
    --global-network-id global-network-01231231231231231 \
    --link-id link-11112222aaaabbbb1 \
    --bandwidth  UploadSpeed=20,DownloadSpeed=20 \
    --region us-west-2

Saída:

{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 20,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "UPDATING"
    }
}

Para obter mais informações, consulte Trabalhando com links no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte UpdateLinkna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-site.

AWS CLI

Para atualizar um site

O update-site exemplo a seguir atualiza a descrição do site site-444555aaabbb11223 na rede global especificada.

aws networkmanager update-site \
    --global-network-id global-network-01231231231231231 \
    --site-id site-444555aaabbb11223 \
    --description "New York Office site" \
    --region us-west-2

Saída:

{
    "Site": {
        "SiteId": "site-444555aaabbb11223",
        "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York Office site",
        "Location": {
            "Latitude": "40.7128",
            "Longitude": "-74.0060"
        },
        "CreatedAt": 1575554528.0,
        "State": "UPDATING"
    }
}

Para obter mais informações, consulte Trabalhando com sites no Guia do Gerenciador de Rede do Transit Gateway.

  • Para API obter detalhes, consulte UpdateSitena Referência de AWS CLI Comandos.