Exemplos do Amazon RDS usando o AWS CLI - AWS Command Line Interface
Ações

Exemplos do Amazon RDS usando o 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 Amazon RDS.

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

O código de exemplo a seguir mostra como usar add-option-to-option-group.

AWS CLI

Para adicionar uma opção a um grupo de opções

O exemplo add-option-to-option-group a seguir adiciona uma opção ao grupo de opções especificado.

aws rds add-option-to-option-group \
    --option-group-name myoptiongroup \
    --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \
    --apply-immediately

Saída:

{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Test Option Group",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "12.1",
        "Options": [
            {
                "OptionName": "Timezone",
                "OptionDescription": "Change time zone",
                "Persistent": true,
                "Permanent": false,
                "OptionSettings": [
                    {
                        "Name": "TIME_ZONE",
                        "Value": "Australia/Sydney",
                        "DefaultValue": "UTC",
                        "Description": "Specifies the timezone the user wants to change the system time to",
                        "ApplyType": "DYNAMIC",
                        "DataType": "STRING",
                        "AllowedValues": "Africa/Cairo,Africa/Casablanca,Africa/Harare,Africa/Lagos,Africa/Luanda,Africa/Monrovia,Africa/Nairobi,Africa/Tripoli,Africa/Windhoek,America/Araguaina,America/Argentina/Buenos_Aires,America/Asuncion,America/Bogota,America/Caracas,America/Chicago,America/Chihuahua,America/Cuiaba,America/Denver,America/Detroit,America/Fortaleza,America/Godthab,America/Guatemala,America/Halifax,America/Lima,America/Los_Angeles,America/Manaus,America/Matamoros,America/Mexico_City,America/Monterrey,America/Montevideo,America/New_York,America/Phoenix,America/Santiago,America/Sao_Paulo,America/Tijuana,America/Toronto,Asia/Amman,Asia/Ashgabat,Asia/Baghdad,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Calcutta,Asia/Damascus,Asia/Dhaka,Asia/Hong_Kong,Asia/Irkutsk,Asia/Jakarta,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Magadan,Asia/Manila,Asia/Muscat,Asia/Novosibirsk,Asia/Rangoon,Asia/Riyadh,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tehran,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vladivostok,Asia/Yakutsk,Asia/Yerevan,Atlantic/Azores,Atlantic/Cape_Verde,Australia/Adelaide,Australia/Brisbane,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/Lord_Howe,Australia/Perth,Australia/Sydney,Brazil/DeNoronha,Brazil/East,Canada/Newfoundland,Canada/Saskatchewan,Etc/GMT-3,Europe/Amsterdam,Europe/Athens,Europe/Berlin,Europe/Dublin,Europe/Helsinki,Europe/Kaliningrad,Europe/London,Europe/Madrid,Europe/Moscow,Europe/Paris,Europe/Prague,Europe/Rome,Europe/Sarajevo,Pacific/Apia,Pacific/Auckland,Pacific/Chatham,Pacific/Fiji,Pacific/Guam,Pacific/Honolulu,Pacific/Kiritimati,Pacific/Marquesas,Pacific/Samoa,Pacific/Tongatapu,Pacific/Wake,US/Alaska,US/Central,US/East-Indiana,US/Eastern,US/Pacific,UTC",
                        "IsModifiable": true,
                        "IsCollection": false
                    }
                ],
                "DBSecurityGroupMemberships": [],
                "VpcSecurityGroupMemberships": []
            },
            {
                "OptionName": "OEM",
                "OptionDescription": "Oracle 12c EM Express",
                "Persistent": false,
                "Permanent": false,
                "Port": 5500,
                "OptionSettings": [],
                "DBSecurityGroupMemberships": [
                    {
                        "DBSecurityGroupName": "default",
                        "Status": "authorized"
                    }
                ],
                "VpcSecurityGroupMemberships": []
            }
        ],
        "AllowsVpcAndNonVpcInstanceMemberships": false,
        "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup"
    }
}

Para obter mais informações, consulte Adicionar uma opção a um grupo de opções no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar add-role-to-db-cluster.

AWS CLI

Associar um perfil do AWS Identity and Access Management (IAM) a um cluster de banco de dados.

O exemplo add-role-to-db-cluster a seguir associa um perfil a um cluster de banco de dados.

aws rds add-role-to-db-cluster \
    --db-cluster-identifier mydbcluster \
    --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3

Este comando não produz saída.

Para obter mais informações, consulte Associar um perfil do IAM a um cluster de banco de dados do Amazon Aurora MySQL no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte AddRoleToDbCluster em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar add-role-to-db-instance.

AWS CLI

Associar um perfil do AWS Identity and Access Management (IAM) a uma instância de banco de dados

O exemplo add-role-to-db-instance a seguir adiciona o perfil a uma instância de banco de dados Oracle denominada test-instance.

aws rds add-role-to-db-instance \
    --db-instance-identifier test-instance \
    --feature-name S3_INTEGRATION \
    --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role

Este comando não produz saída.

Para obter mais informações, consulte os Pré-requisitos para a integração do Amazon RDS Oracle com o Amazon S3 no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar add-source-identifier-to-subscription.

AWS CLI

Adicionar um identificador de origem a uma assinatura

O exemplo add-source-identifier a seguir adiciona outro identificador de origem a uma assinatura já existente.

aws rds add-source-identifier-to-subscription \
    --subscription-name my-instance-events \
    --source-identifier test-instance-repl

Saída:

{
    "EventSubscription": {
        "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
        "CustSubscriptionId": "my-instance-events",
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "Enabled": false,
        "Status": "modifying",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "CustomerAwsId": "123456789012",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "SourceType": "db-instance",
        "SourceIdsList": [
            "test-instance",
            "test-instance-repl"
        ]
    }
}

O código de exemplo a seguir mostra como usar add-tags-to-resource.

AWS CLI

Para adicionar tags a um recurso

O exemplo add-tags-to-resource a seguir adiciona tags a um banco de dados do RDS.

aws rds add-tags-to-resource \
    --resource-name arn:aws:rds:us-east-1:123456789012:db:database-mysql \
    --tags "[{\"Key\": \"Name\",\"Value\": \"MyDatabase\"},{\"Key\": \"Environment\",\"Value\": \"test\"}]"

Este comando não produz saída.

Para obter mais informações, consulte Marcar recursos do Amazon RDS no Guia do usuário do Amazon RDS.

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

O código de exemplo a seguir mostra como usar apply-pending-maintenance-action.

AWS CLI

Para aplicar ações de manutenção pendentes

O exemplo apply-pending-maintenance-action a seguir aplica as ações de manutenção pendentes em um cluster de banco de dados.

aws rds apply-pending-maintenance-action \
    --resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster \
    --apply-action system-update \
    --opt-in-type immediate

Saída:

{
    "ResourcePendingMaintenanceActions": {
        "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster",
        "PendingMaintenanceActionDetails": [
            {
                "Action": "system-update",
                "OptInStatus": "immediate",
                "CurrentApplyDate": "2021-01-23T01:07:36.100Z",
                "Description": "Upgrade to Aurora PostgreSQL 3.3.2"
            }
        ]
    }
}

Para obter mais informações, consulte Manutenção de uma instância de banco de dados em Guia do usuário do Amazon RDS e Manutenção de um cluster de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar authorize-db-security-group-ingress.

AWS CLI

Associar um perfil do AWS Identity and Access Management (IAM) a uma instância de banco de dados

O exemplo authorize-db-security-group-ingress a seguir configura o grupo de segurança padrão com uma regra de entrada para o intervalo de IP CIDR 192.0.2.0/24.

aws rds authorize-db-security-group-ingress \
    --db-security-group-name default \
    --cidrip 192.0.2.0/24

Saída:

{
    "DBSecurityGroup": {
        "OwnerId": "123456789012",
        "DBSecurityGroupName": "default",
        "DBSecurityGroupDescription": "default",
        "EC2SecurityGroups": [],
        "IPRanges": [
            {
                "Status": "authorizing",
                "CIDRIP": "192.0.2.0/24"
            }
        ],
        "DBSecurityGroupArn": "arn:aws:rds:us-east-1:111122223333:secgrp:default"
    }
}

Para obter mais informações, consulte Autorizar o acesso à rede a um grupo de segurança de banco de dados a partir de um intervalo de IP no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar backtrack-db-cluster.

AWS CLI

Retroceder um cluster do banco de dados do Aurora

O exemplo backtrack-db-cluster a seguir retrocede o cluster de banco de dados especificado a 19 de março de 2018, às 10h.

aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00

Esse comando gera um bloco JSON que reconhece a alteração no recurso RDS.

  • Para ver detalhes da API, consulte BacktrackDbCluster em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar cancel-export-task.

AWS CLI

Cancelar a exportação de um snapshot para o Amazon S3

O exemplo cancel-export-task a seguir cancela uma tarefa de exportação em andamento que está exportando um snapshot para o Amazon S3.

aws rds cancel-export-task \
    --export-task-identifier my-s3-export-1

Saída:

{
    "ExportTaskIdentifier": "my-s3-export-1",
    "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot",
    "SnapshotTime": "2019-03-24T20:01:09.815Z",
    "S3Bucket": "amzn-s3-demo-bucket",
    "S3Prefix": "",
    "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role",
    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff",
    "Status": "CANCELING",
    "PercentProgress": 0,
    "TotalExtractedDataInGB": 0
}

Para obter mais informações, consulte Cancelar uma tarefa de exportação de snapshot no Guia do usuário do Amazon RDS ou Cancelar uma tarefa de exportação de snapshot no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar copy-db-cluster-parameter-group.

AWS CLI

Copiar um grupo de parâmetros de cluster de banco de dados

O exemplo copy-db-cluster-parameter-group a seguir faz uma cópia de um grupo de parâmetros de cluster de banco de dados.

aws rds copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier mydbclusterpg \
    --target-db-cluster-parameter-group-identifier mydbclusterpgcopy \
    --target-db-cluster-parameter-group-description "Copy of mydbclusterpg parameter group"

Saída:

{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "mydbclusterpgcopy",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy",
        "DBParameterGroupFamily": "aurora-mysql5.7",
        "Description": "Copy of mydbclusterpg parameter group"
    }
}

Para obter mais informações, consulte Copiar um grupo de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar copy-db-cluster-snapshot.

AWS CLI

Para copiar um snapshot de cluster de banco de dados

O exemplo copy-db-cluster-snapshot a seguir cria uma cópia de um snapshot de cluster de banco de dados, incluindo suas tags.

aws rds copy-db-cluster-snapshot \
    --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16
    --target-db-cluster-snapshot-identifier myclustersnapshotcopy \
    --copy-tags

Saída:

{
    "DBClusterSnapshot": {
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1e"
        ],
        "DBClusterSnapshotIdentifier": "myclustersnapshotcopy",
        "DBClusterIdentifier": "myaurora",
        "SnapshotCreateTime": "2019-06-04T09:16:42.649Z",
        "Engine": "aurora-mysql",
        "AllocatedStorage": 0,
        "Status": "available",
        "Port": 0,
        "VpcId": "vpc-6594f31c",
        "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
        "MasterUsername": "myadmin",
        "EngineVersion": "5.7.mysql_aurora.2.04.2",
        "LicenseModel": "aurora-mysql",
        "SnapshotType": "manual",
        "PercentProgress": 100,
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy",
        "IAMDatabaseAuthenticationEnabled": false
    }
}

Para obter mais informações, consulte Copiar um snapshot no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar copy-db-parameter-group.

AWS CLI

Copiar um grupo de parâmetros de cluster de banco de dados

O exemplo copy-db-parameter-group a seguir faz uma cópia de um grupo de parâmetros de banco de dados.

aws rds copy-db-parameter-group \
    --source-db-parameter-group-identifier mydbpg \
    --target-db-parameter-group-identifier mydbpgcopy \
    --target-db-parameter-group-description "Copy of mydbpg parameter group"

Saída:

{
    "DBParameterGroup": {
        "DBParameterGroupName": "mydbpgcopy",
        "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy",
        "DBParameterGroupFamily": "mysql5.7",
        "Description": "Copy of mydbpg parameter group"
    }
}

Para obter mais informações, consulte Copiar um grupo de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar copy-db-snapshot.

AWS CLI

Para copiar um snapshot de banco de dados

O exemplo copy-db-snapshot a seguir cria uma cópia de um snapshot de banco de dados.

aws rds copy-db-snapshot \
    --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38
    --target-db-snapshot-identifier mydbsnapshotcopy

Saída:

{
    "DBSnapshot": {
        "VpcId": "vpc-6594f31c",
        "Status": "creating",
        "Encrypted": true,
        "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38",
        "MasterUsername": "admin",
        "Iops": 1000,
        "Port": 3306,
        "LicenseModel": "general-public-license",
        "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy",
        "EngineVersion": "5.6.40",
        "OptionGroupName": "default:mysql-5-6",
        "ProcessorFeatures": [],
        "Engine": "mysql",
        "StorageType": "io1",
        "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4",
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "SnapshotType": "manual",
        "IAMDatabaseAuthenticationEnabled": false,
        "SourceRegion": "us-east-1",
        "DBInstanceIdentifier": "database-mysql",
        "InstanceCreateTime": "2019-04-30T15:45:53.663Z",
        "AvailabilityZone": "us-east-1f",
        "PercentProgress": 0,
        "AllocatedStorage": 100,
        "DBSnapshotIdentifier": "mydbsnapshotcopy"
    }
}

Para obter mais informações, consulte Copiar um snapshot no Guia do usuário do Amazon RDS.

  • Para ver detalhes da API, consulte CopyDbSnapshot em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar copy-option-group.

AWS CLI

Copiar um grupo de opções

O exemplos de copy-option-group a seguir faz uma cópia de um grupo de opções.

aws rds copy-option-group \
    --source-option-group-identifier myoptiongroup \
    --target-option-group-identifier new-option-group \
    --target-option-group-description "My option group copy"

Saída:

{
    "OptionGroup": {
        "Options": [],
        "OptionGroupName": "new-option-group",
        "MajorEngineVersion": "11.2",
        "OptionGroupDescription": "My option group copy",
        "AllowsVpcAndNonVpcInstanceMemberships": true,
        "EngineName": "oracle-ee",
        "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group"
    }
}

Para obter mais informações, consulte Copiar um grupo de opções no Guia do usuário do Amazon RDS.

  • Para ver detalhes da API, consulte CopyOptionGroup em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-blue-green-deployment.

AWS CLI

Exemplo 1: Criar uma implantação azul/verde para uma instância de banco de dados do RDS para MySQL

O exemplo create-blue-green-deployment a seguir cria uma implantação azul/verde para uma instância de banco de dados MySQL.

aws rds create-blue-green-deployment \
    --blue-green-deployment-name bgd-cli-test-instance \
    --source arn:aws:rds:us-east-1:123456789012:db:my-db-instance \
    --target-engine-version 8.0 \
    --target-db-parameter-group-name mysql-80-group

Saída:

{
    "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
        "BlueGreenDeploymentName": "bgd-cli-test-instance",
        "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
        "SwitchoverDetails": [
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3"
            }
        ],
        "Tasks": [
            {
                "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                "Status": "PENDING"
            },
            {
                "Name": "DB_ENGINE_VERSION_UPGRADE",
                "Status": "PENDING"
            },
            {
                "Name": "CONFIGURE_BACKUPS",
                "Status": "PENDING"
            },
            {
                "Name": "CREATING_TOPOLOGY_OF_SOURCE",
                "Status": "PENDING"
            }
        ],
        "Status": "PROVISIONING",
        "CreateTime": "2022-02-25T21:18:51.183000+00:00"
    }
}

Para obter mais informações, consulte Criar uma implantação azul/verde no Guia do usuário do Amazon RDS.

Exemplo 2: Criar uma implantação azul/verde para um cluster de banco de dados do Aurora MySQL

O exemplo create-blue-green-deployment a seguir cria uma implantação azul/verde para um cluster de banco de dados do Aurora MySQL.

aws rds create-blue-green-deployment \
    --blue-green-deployment-name my-blue-green-deployment \
    --source arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster \
    --target-engine-version 8.0 \
    --target-db-cluster-parameter-group-name ams-80-binlog-enabled \
    --target-db-parameter-group-name mysql-80-cluster-group

Saída:

{
      "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
        "BlueGreenDeploymentName": "my-blue-green-deployment",
        "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
        "SwitchoverDetails": [
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
            "Status": "PROVISIONING"
          }
        ],
        "Tasks": [
          {
            "Name": "CREATING_READ_REPLICA_OF_SOURCE",
            "Status": "PENDING"
          },
          {
            "Name": "DB_ENGINE_VERSION_UPGRADE",
            "Status": "PENDING"
          },
          {
            "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
            "Status": "PENDING"
          },
          {
            "Name": "CREATE_CUSTOM_ENDPOINTS",
            "Status": "PENDING"
          }
        ],
        "Status": "PROVISIONING",
        "CreateTime": "2022-02-25T21:12:00.288000+00:00"
      }
}

Para obter mais informações, consulte Criar uma implantação azul/verde no do Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar create-db-cluster-endpoint.

AWS CLI

Criar um endpoint de cluster de banco de dados personalizado

O exemplo create-db-cluster-endpoint a seguir cria um endpoint de cluster de banco de dados personalizado e o associa ao cluster de banco de dados Aurora especificado.

aws rds create-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint \
    --endpoint-type reader \
    --db-cluster-identifier mydbcluster \
    --static-members dbinstance1 dbinstance2

Saída:

{
    "DBClusterEndpointIdentifier": "mycustomendpoint",
    "DBClusterIdentifier": "mydbcluster",
    "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
    "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
    "Status": "creating",
    "EndpointType": "CUSTOM",
    "CustomEndpointType": "READER",
    "StaticMembers": [
        "dbinstance1",
        "dbinstance2"
    ],
    "ExcludedMembers": [],
    "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint"
}

Para obter mais informações, consulte Gerenciamento de conexões do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar create-db-cluster-parameter-group.

AWS CLI

Criar um grupo de parâmetros de cluster de banco de dados

O exemplo create-db-cluster-parameter-group a seguir cria um grupo de parâmetros de banco de dados.

aws rds create-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterparametergroup \
    --db-parameter-group-family aurora5.6 \
    --description "My new cluster parameter group"

Saída:

{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "mydbclusterparametergroup",
        "DBParameterGroupFamily": "aurora5.6",
        "Description": "My new cluster parameter group",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup"
    }
}

Para obter mais informações, consulte Criar um grupo de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar create-db-cluster-snapshot.

AWS CLI

Para criar um snapshot de cluster de banco de dados

O exemplo create-db-cluster-snapshot a seguir cria um snapshot de banco de dados.

aws rds create-db-cluster-snapshot \
    --db-cluster-identifier mydbcluster \
    --db-cluster-snapshot-identifier mydbclustersnapshot

Saída:

{
    "DBClusterSnapshot": {
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1e"
        ],
        "DBClusterSnapshotIdentifier": "mydbclustersnapshot",
        "DBClusterIdentifier": "mydbcluster",
        "SnapshotCreateTime": "2019-06-18T21:21:00.469Z",
        "Engine": "aurora-mysql",
        "AllocatedStorage": 1,
        "Status": "creating",
        "Port": 0,
        "VpcId": "vpc-6594f31c",
        "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
        "MasterUsername": "myadmin",
        "EngineVersion": "5.7.mysql_aurora.2.04.2",
        "LicenseModel": "aurora-mysql",
        "SnapshotType": "manual",
        "PercentProgress": 0,
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot",
        "IAMDatabaseAuthenticationEnabled": false
    }
}

Para obter mais informações, consulte Criar um snapshot de cluster de banco de dados no Guia do usuário do Amazon Aurora.

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

AWS CLI

Exemplo 1: criar um cluster de banco de dados compatível com MySQL 5.7

O exemplo create-db-cluster a seguir cria um cluster de banco de dados compatível com o MySQL 5.7 usando a versão padrão do mecanismo. Substitua a senha de exemplo secret99 por uma senha segura. Quando você usa o console para criar um cluster de banco de dados, o Amazon RDS cria automaticamente a instância de banco de dados de gravador para o cluster de banco de dados. No entanto, ao usar a AWS CLI para criar um cluster de banco de dados, você deverá criar explicitamente a instância de banco de dados de gravador para o cluster de banco de dados usando o comando create-db-instance AWS da CLI.

aws rds create-db-cluster \
    --db-cluster-identifier sample-cluster \
    --engine aurora-mysql \
    --engine-version 5.7 \
    --master-username admin \
    --master-user-password secret99 \
    --db-subnet-group-name default \
    --vpc-security-group-ids sg-0b9130572daf3dc16

Saída:

{
    "DBCluster": {
        "DBSubnetGroup": "default",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-0b9130572daf3dc16",
                "Status": "active"
            }
        ],
        "AllocatedStorage": 1,
        "AssociatedRoles": [],
        "PreferredBackupWindow": "09:12-09:42",
        "ClusterCreateTime": "2023-02-27T23:21:33.048Z",
        "DeletionProtection": false,
        "IAMDatabaseAuthenticationEnabled": false,
        "ReadReplicaIdentifiers": [],
        "EngineMode": "provisioned",
        "Engine": "aurora-mysql",
        "StorageEncrypted": false,
        "MultiAZ": false,
        "PreferredMaintenanceWindow": "mon:04:31-mon:05:01",
        "HttpEndpointEnabled": false,
        "BackupRetentionPeriod": 1,
        "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1e"
        ],
        "MasterUsername": "master",
        "EngineVersion": "5.7.mysql_aurora.2.11.1",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
        "DBClusterMembers": [],
        "Port": 3306,
        "Status": "creating",
        "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterParameterGroup": "default.aurora-mysql5.7",
        "HostedZoneId": "Z2R2ITUGPM61AM",
        "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "CopyTagsToSnapshot": false
    }
}

Exemplo 2: criar um cluster de banco de dados compatível com PostgreSQL

O exemplo create-db-cluster a seguir cria um cluster de banco de dados compatível com PostgreSQL usando a versão padrão do mecanismo. Substitua a senha de exemplo secret99 por uma senha segura. Quando você usa o console para criar um cluster de banco de dados, o Amazon RDS cria automaticamente a instância de banco de dados de gravador para o cluster de banco de dados. No entanto, ao usar a AWS CLI para criar um cluster de banco de dados, você deverá criar explicitamente a instância de banco de dados de gravador para o cluster de banco de dados usando o comando create-db-instance AWS da CLI.

aws rds create-db-cluster \
    --db-cluster-identifier sample-pg-cluster \
    --engine aurora-postgresql \
    --master-username master \
    --master-user-password secret99 \
    --db-subnet-group-name default \
    --vpc-security-group-ids sg-0b9130572daf3dc16

Saída:

{
    "DBCluster": {
        "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "HttpEndpointEnabled": false,
        "DBClusterMembers": [],
        "EngineMode": "provisioned",
        "CopyTagsToSnapshot": false,
        "HostedZoneId": "Z2R2ITUGPM61AM",
        "IAMDatabaseAuthenticationEnabled": false,
        "AllocatedStorage": 1,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-0b9130572daf3dc16",
                "Status": "active"
            }
        ],
        "DeletionProtection": false,
        "StorageEncrypted": false,
        "BackupRetentionPeriod": 1,
        "PreferredBackupWindow": "09:56-10:26",
        "ClusterCreateTime": "2023-02-27T23:26:08.371Z",
        "DBClusterParameterGroup": "default.aurora-postgresql13",
        "EngineVersion": "13.7",
        "Engine": "aurora-postgresql",
        "Status": "creating",
        "DBClusterIdentifier": "sample-pg-cluster",
        "MultiAZ": false,
        "Port": 5432,
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster",
        "AssociatedRoles": [],
        "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
        "PreferredMaintenanceWindow": "wed:03:33-wed:04:03",
        "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "MasterUsername": "master",
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1c"
        ],
        "ReadReplicaIdentifiers": [],
        "DBSubnetGroup": "default"
    }
}

Para obter mais informações, consulte Criar um cluster do banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar create-db-instance-read-replica.

AWS CLI

Criar uma réplica de leitura de instância de banco de dados

Este exemplo cria uma réplica de leitura de uma instância de banco de dados existente denominada test-instance. A réplica de leitura foi denominada test-instance-repl.

aws rds create-db-instance-read-replica \
    --db-instance-identifier test-instance-repl \
    --source-db-instance-identifier test-instance

Saída:

{
    "DBInstance": {
        "IAMDatabaseAuthenticationEnabled": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
        "ReadReplicaSourceDBInstanceIdentifier": "test-instance",
        "DBInstanceIdentifier": "test-instance-repl",
        ...some output truncated...
    }
}

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

AWS CLI

Como criar uma instância de banco de dados

O exemplo de create-db-instance a seguir usa as opções necessárias para iniciar uma nova instância de banco de dados.

aws rds create-db-instance \
    --db-instance-identifier test-mysql-instance \
    --db-instance-class db.t3.micro \
    --engine mysql \
    --master-username admin \
    --master-user-password secret99 \
    --allocated-storage 20

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "test-mysql-instance",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "mysql",
        "DBInstanceStatus": "creating",
        "MasterUsername": "admin",
        "AllocatedStorage": 20,
        "PreferredBackupWindow": "12:55-13:25",
        "BackupRetentionPeriod": 1,
        "DBSecurityGroups": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-12345abc",
                "Status": "active"
            }
        ],
        "DBParameterGroups": [
            {
                "DBParameterGroupName": "default.mysql5.7",
                "ParameterApplyStatus": "in-sync"
            }
        ],
        "DBSubnetGroup": {
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-2ff2ff2f",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "sun:08:07-sun:08:37",
        "PendingModifiedValues": {
            "MasterUserPassword": "****"
        },
        "MultiAZ": false,
        "EngineVersion": "5.7.22",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "general-public-license",
        "OptionGroupMemberships": [
            {
                "OptionGroupName": "default:mysql-5-7",
                "Status": "in-sync"
            }
        ],
        "PubliclyAccessible": true,
        "StorageType": "gp2",
        "DbInstancePort": 0,
        "StorageEncrypted": false,
        "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE",
        "CACertificateIdentifier": "rds-ca-2019",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": []
    }
}

Para obter mais informações, consulte Criar uma instância de banco de dados do Amazon RDS no Guia do usuário do Amazon RDS.

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

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

AWS CLI

Como criar um grupo de parâmetros de banco de dados

O exemplo de create-db-parameter-group a seguir cria um grupo de parâmetros de banco de dados.

aws rds create-db-parameter-group \
    --db-parameter-group-name mydbparametergroup \
    --db-parameter-group-family MySQL5.6 \
    --description "My new parameter group"

Saída:

{
    "DBParameterGroup": {
        "DBParameterGroupName": "mydbparametergroup",
        "DBParameterGroupFamily": "mysql5.6",
        "Description": "My new parameter group",
        "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup"
    }
}

Para obter mais informações, consulte Criar um grupo de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar create-db-proxy-endpoint.

AWS CLI

Criar um endpoint de proxy de banco de dados para um banco de dados RDS

O exemplo create-db-proxy-endpoint a seguir cria um endpoint de proxy de banco de dados.

aws rds create-db-proxy-endpoint \
    --db-proxy-name proxyExample \
    --db-proxy-endpoint-name "proxyep1" \
    --vpc-subnet-ids subnetgroup1 subnetgroup2

Saída:

{
"DBProxyEndpoint": {
        "DBProxyEndpointName": "proxyep1",
        "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
        "DBProxyName": "proxyExample",
        "Status": "creating",
        "VpcId": "vpc-1234567",
        "VpcSecurityGroupIds": [
            "sg-1234",
            "sg-5678"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Endpoint": "proxyep1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "TargetRole": "READ_WRITE",
        "IsDefault": false
    }
}

Para obter mais informações, consulte Criar um endpoint proxy no Guia do usuário do Amazon RDS e Criar um endpoint proxy no Guia do usuário do Amazon Aurora.

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

AWS CLI

Criar um proxy de banco de dados para um banco de dados RDS

O exemplo create-db-proxy a seguir cria um proxy de banco de dados.

aws rds create-db-proxy \
    --db-proxy-name proxyExample \
    --engine-family MYSQL \
    --auth Description="proxydescription1",AuthScheme="SECRETS",SecretArn="arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",IAMAuth="DISABLED",ClientPasswordAuthType="MYSQL_NATIVE_PASSWORD" \
    --role-arn arn:aws:iam::123456789123:role/ProxyRole \
    --vpc-subnet-ids subnetgroup1 subnetgroup2

Saída:

{
"DBProxy": {
        "DBProxyName": "proxyExample",
        "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
        "EngineFamily": "MYSQL",
        "VpcId": "vpc-1234567",
        "VpcSecuritytGroupIds": [
            "sg-1234",
            "sg-5678",
            "sg-9101"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Auth": "[
            {
                "Description": "proxydescription1",
                "AuthScheme": "SECRETS",
                "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e",
                "IAMAuth": "DISABLED"
            }
        ]",
        "RoleArn": "arn:aws:iam::12345678912:role/ProxyRole",
        "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
        "RequireTLS": false,
        "IdleClientTimeout": 1800,
        "DebuggingLogging": false,
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
    }
}

Para obter mais informações, consulte Criar um proxy do RDS no Guia do usuário do Amazon RDS e Criar um proxy do RDS no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte CreateDbProxy em Referência de comandos da AWS CLI.

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

AWS CLI

Criar um grupo de segurança do banco de dados do Amazon RDS

O comando create-db-security-group a seguir cria um novo grupo de segurança do banco de dados do Amazon RDS:

aws rds create-db-security-group --db-security-group-name mysecgroup --db-security-group-description "My Test Security Group"

No exemplo, o novo grupo de segurança do banco de dados é denominado mysecgroup e tem uma descrição.

Saída:

{
    "DBSecurityGroup": {
        "OwnerId": "123456789012",
        "DBSecurityGroupName": "mysecgroup",
        "DBSecurityGroupDescription": "My Test Security Group",
        "VpcId": "vpc-a1b2c3d4",
        "EC2SecurityGroups": [],
        "IPRanges": [],
        "DBSecurityGroupArn": "arn:aws:rds:us-west-2:123456789012:secgrp:mysecgroup"
    }
}

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

AWS CLI

Exemplo 1: criar um cluster de banco de dados primário do Aurora PostgreSQL

O exemplo create-db-cluster a seguir cria um cluster de banco de dados primário do Aurora PostgreSQL compatível com o Aurora Serverless v2 e o Aurora Limitless Database.

aws rds create-db-cluster \
    --db-cluster-identifier my-sv2-cluster \
    --engine aurora-postgresql \
    --engine-version 15.2-limitless \
    --storage-type aurora-iopt1 \
    --serverless-v2-scaling-configuration MinCapacity=2,MaxCapacity=16 \
    --enable-limitless-database \
    --master-username myuser \
    --master-user-password mypassword \
    --enable-cloudwatch-logs-exports postgresql

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-2b",
            "us-east-2c",
            "us-east-2a"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "my-sv2-cluster",
        "DBClusterParameterGroup": "default.aurora-postgresql15",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "my-sv2-cluster.cluster-cekycexample.us-east-2.rds.amazonaws.com",
        "ReaderEndpoint": "my-sv2-cluster.cluster-ro-cekycexample.us-east-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-postgresql",
        "EngineVersion": "15.2-limitless",
        "Port": 5432,
        "MasterUsername": "myuser",
        "PreferredBackupWindow": "06:05-06:35",
        "PreferredMaintenanceWindow": "mon:08:25-mon:08:55",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z2XHWR1EXAMPLE",
        "StorageEncrypted": false,
        "DbClusterResourceId": "cluster-XYEDT6ML6FHIXH4Q2J1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-east-2:123456789012:cluster:my-sv2-cluster",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2024-02-19T16:24:07.771000+00:00",
        "EnabledCloudwatchLogsExports": [
            "postgresql"
        ],
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false,
        "DomainMemberships": [],
        "TagList": [],
        "StorageType": "aurora-iopt1",
        "AutoMinorVersionUpgrade": true,
        "ServerlessV2ScalingConfiguration": {
            "MinCapacity": 2.0,
            "MaxCapacity": 16.0
        },
        "NetworkType": "IPV4",
        "IOOptimizedNextAllowedModificationTime": "2024-03-21T16:24:07.781000+00:00",
        "LimitlessDatabase": {
            "Status": "not-in-use",
            "MinRequiredACU": 96.0
        }
    }
}

Exemplo 2: criar a instância de banco de dados primária (gravadora)

O exemplo create-db-instance a seguir cria uma instância de banco de dados primária (gravadora) do Aurora Serverless v2. Quando você usa o console para criar um cluster de banco de dados, o Amazon RDS cria automaticamente a instância de banco de dados de gravador para o cluster de banco de dados. No entanto, ao usar a AWS CLI para criar um cluster de banco de dados, você deverá criar explicitamente a instância de banco de dados de gravador para o cluster de banco de dados usando o comando create-db-instance AWS da CLI.

aws rds create-db-instance \
    --db-instance-identifier my-sv2-instance \
    --db-cluster-identifier my-sv2-cluster \
    --engine aurora-postgresql \
    --db-instance-class db.serverless

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "my-sv2-instance",
        "DBInstanceClass": "db.serverless",
        "Engine": "aurora-postgresql",
        "DBInstanceStatus": "creating",
        "MasterUsername": "myuser",
        "AllocatedStorage": 1,
        "PreferredBackupWindow": "06:05-06:35",
        "BackupRetentionPeriod": 1,
        "DBSecurityGroups": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "DBParameterGroups": [
            {
                "DBParameterGroupName": "default.aurora-postgresql15",
                "ParameterApplyStatus": "in-sync"
            }
        ],
        "DBSubnetGroup": {
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-########",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-2c"
                    },
                    "SubnetOutpost": {},
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-2a"
                    },
                    "SubnetOutpost": {},
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-2b"
                    },
                    "SubnetOutpost": {},
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "fri:09:01-fri:09:31",
        "PendingModifiedValues": {
            "PendingCloudwatchLogsExports": {
                "LogTypesToEnable": [
                    "postgresql"
                ]
            }
        },
        "MultiAZ": false,
        "EngineVersion": "15.2-limitless",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "postgresql-license",
        "OptionGroupMemberships": [
            {
                "OptionGroupName": "default:aurora-postgresql-15",
                "Status": "in-sync"
            }
        ],
        "PubliclyAccessible": false,
        "StorageType": "aurora-iopt1",
        "DbInstancePort": 0,
        "DBClusterIdentifier": "my-sv2-cluster",
        "StorageEncrypted": false,
        "DbiResourceId": "db-BIQTE3B3K3RM7M74SK5EXAMPLE",
        "CACertificateIdentifier": "rds-ca-rsa2048-g1",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "PromotionTier": 1,
        "DBInstanceArn": "arn:aws:rds:us-east-2:123456789012:db:my-sv2-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": [],
        "TagList": [],
        "CustomerOwnedIpEnabled": false,
        "BackupTarget": "region",
        "NetworkType": "IPV4",
        "StorageThroughput": 0,
        "CertificateDetails": {
            "CAIdentifier": "rds-ca-rsa2048-g1"
        },
        "DedicatedLogVolume": false
    }
}

Exemplo 3: criar o grupo de fragmentos de banco de dados

O exemplo create-db-shard-group a seguir cria um grupo de fragmentos de banco de dados no cluster de banco de dados primário do Aurora PostgreSQL.

aws rds create-db-shard-group \
    --db-shard-group-identifier my-db-shard-group \
    --db-cluster-identifier my-sv2-cluster \
    --max-acu 768

Saída:

{
    "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
    "DBShardGroupIdentifier": "my-db-shard-group",
    "DBClusterIdentifier": "my-sv2-cluster",
    "MaxACU": 768.0,
    "ComputeRedundancy": 0,
    "Status": "creating",
    "PubliclyAccessible": false,
    "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
}

Para obter mais informações, consulte Como usar o Amazon Aurora Serverless v2 no Guia do usuário do Amazon Aurora.

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

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

AWS CLI

Como criar um snapshot de banco de dados

O exemplo de create-db-snapshot a seguir cria um snapshot de banco de dados.

aws rds create-db-snapshot \
    --db-instance-identifier database-mysql \
    --db-snapshot-identifier mydbsnapshot

Saída:

{
    "DBSnapshot": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBInstanceIdentifier": "database-mysql",
        "Engine": "mysql",
        "AllocatedStorage": 100,
        "Status": "creating",
        "Port": 3306,
        "AvailabilityZone": "us-east-1b",
        "VpcId": "vpc-6594f31c",
        "InstanceCreateTime": "2019-04-30T15:45:53.663Z",
        "MasterUsername": "admin",
        "EngineVersion": "5.6.40",
        "LicenseModel": "general-public-license",
        "SnapshotType": "manual",
        "Iops": 1000,
        "OptionGroupName": "default:mysql-5-6",
        "PercentProgress": 0,
        "StorageType": "io1",
        "Encrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
        "IAMDatabaseAuthenticationEnabled": false,
        "ProcessorFeatures": [],
        "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE"
    }
}

Para obter mais informações, consulte Criar um snapshot de banco de dados no Guia do usuário do Amazon RDS.

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

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

AWS CLI

Para criar um grupo de sub-redes de banco de dados

O exemplo create-db-subnet-group a seguir cria um grupo de sub-redes de banco de dados chamado mysubnetgroup usando sub-redes existentes.

aws rds create-db-subnet-group \
    --db-subnet-group-name mysubnetgroup \
    --db-subnet-group-description "test DB subnet group" \
    --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef"]'

Saída:

{
    "DBSubnetGroup": {
        "DBSubnetGroupName": "mysubnetgroup",
        "DBSubnetGroupDescription": "test DB subnet group",
        "VpcId": "vpc-0f08e7610a1b2c3d4",
        "SubnetGroupStatus": "Complete",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2b"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-00f5b198bc0abcdef",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2d"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-0a1dc4e1a6f123456",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2b"
                },
                "SubnetStatus": "Active"
            }
        ],
        "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup"
    }
}

Para obter mais informações, consulte Criar uma instância de banco de dados em um VPC no Guia do usuário do Amazon RDS.

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

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

AWS CLI

Para criar uma assinatura de evento

O exemplo create-event-subscription a seguir cria uma assinatura para eventos de backup e recuperação para uma instância de banco de dados na conta atual da AWS. As notificações são enviadas para um tópico do Amazon Simple Notification Service, especificado por --sns-topic-arn.

aws rds create-event-subscription \
    --subscription-name my-instance-events \
    --source-type db-instance \
    --event-categories '["backup","recovery"]' \
    --sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events

Saída:

{
    "EventSubscription": {
        "Status": "creating",
        "CustSubscriptionId": "my-instance-events",
        "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "CustomerAwsId": "123456789012",
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "SourceType": "db-instance",
        "Enabled": true
    }
}

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

AWS CLI

Para criar um novo cluster de banco de dados global

O exemplo create-global-cluster a seguir cria um cluster de banco de dados global compatível com o Aurora MySQL.

aws rds create-global-cluster \
    --global-cluster-identifier myglobalcluster \
    --engine aurora-mysql

Saída:

{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
        "Status": "available",
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.mysql_aurora.2.07.2",
        "StorageEncrypted": false,
        "DeletionProtection": false,
        "GlobalClusterMembers": []
    }
}

Para obter mais informações, consulte Criar um banco de dados global no Aurora no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte CreateGlobalCluster em Referência de comandos da AWS CLI.

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

AWS CLI

Criar um grupo de opções personalizado do Amazon RDS

O comando create-option-group a seguir cria um novo grupo de opções do Amazon RDS para a versão Oracle Enterprise Edition 11.2`, is named ``MyOptionGroup e inclui uma descrição.

aws rds create-option-group \
    --option-group-name MyOptionGroup \
    --engine-name oracle-ee \
    --major-engine-version 11.2 \
    --option-group-description "Oracle Database Manager Database Control"

Saída:

{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Oracle Database Manager Database Control",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "11.2",
        "Options": [],
        "AllowsVpcAndNonVpcInstanceMemberships": true,
        "OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup"
    }
}

  • Para ver detalhes da API, consulte CreateOptionGroup em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-blue-green-deployment.

AWS CLI

Exemplo 1: excluir recursos em um ambiente verde para uma instância de banco de dados do RDS para MySQL

O exemplo delete-blue-green-deployment a seguir exclui os recursos em um ambiente verde de uma instância de banco de dados do RDS para MySQL.

aws rds delete-blue-green-deployment \
    --blue-green-deployment-identifier bgd-v53303651eexfake \
    --delete-target

Saída:

{
    "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
        "BlueGreenDeploymentName": "bgd-cli-test-instance",
        "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
        "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe",
        "SwitchoverDetails": [
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t",
                "Status": "AVAILABLE"
            }
        ],
        "Tasks": [
            {
                "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                "Status": "COMPLETED"
            },
            {
                "Name": "DB_ENGINE_VERSION_UPGRADE",
                "Status": "COMPLETED"
            },
            {
                "Name": "CONFIGURE_BACKUPS",
                "Status": "COMPLETED"
            },
            {
                "Name": "CREATING_TOPOLOGY_OF_SOURCE",
                "Status": "COMPLETED"
            }
        ],
        "Status": "DELETING",
        "CreateTime": "2022-02-25T21:18:51.183000+00:00",
        "DeleteTime": "2022-02-25T22:25:31.331000+00:00"
    }
}

Para obter mais informações, consulte Excluir uma implantação azul/verde no Guia do usuário do Amazon RDS.

Exemplo 2: excluir recursos em um ambiente verde para um cluster de banco de dados do Aurora MySQL

O exemplo delete-blue-green-deployment a seguir exclui os recursos em um ambiente verde de um cluster de banco de dados do Aurora MySQL.

aws rds delete-blue-green-deployment \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake \
    --delete-target

Saída:

{
    "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
        "BlueGreenDeploymentName": "my-blue-green-deployment",
        "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
        "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
        "SwitchoverDetails": [
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg",
                "Status": "AVAILABLE"
            }
        ],
        "Tasks": [
            {
                "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                "Status": "COMPLETED"
            },
            {
                "Name": "DB_ENGINE_VERSION_UPGRADE",
                "Status": "COMPLETED"
            },
            {
                "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
                "Status": "COMPLETED"
            },
            {
                "Name": "CREATE_CUSTOM_ENDPOINTS",
                "Status": "COMPLETED"
            }
        ],
        "Status": "DELETING",
        "CreateTime": "2022-02-25T21:12:00.288000+00:00",
        "DeleteTime": "2022-02-25T22:29:11.336000+00:00"
    }
}

Para obter mais informações, consulte Excluir uma implantação azul/verde no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar delete-db-cluster-endpoint.

AWS CLI

Excluir um endpoint de cluster de banco de dados personalizado

O exemplo delete-db-cluster-endpoint a seguir exclui o endpoint de cluster de banco de dados especificado.

aws rds delete-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint

Saída:

{
    "DBClusterEndpointIdentifier": "mycustomendpoint",
    "DBClusterIdentifier": "mydbcluster",
    "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
    "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
    "Status": "deleting",
    "EndpointType": "CUSTOM",
    "CustomEndpointType": "READER",
    "StaticMembers": [
        "dbinstance1",
        "dbinstance2",
        "dbinstance3"
    ],
    "ExcludedMembers": [],
    "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint"
}

Para obter mais informações, consulte Gerenciamento de conexões do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar delete-db-cluster-parameter-group.

AWS CLI

Para excluir um grupo de parâmetros de cluster

O exemplo delete-db-cluster-parameter-group a seguir exclui o grupo de parâmetros do cluster de banco de dados especificado.

aws rds delete-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterparametergroup

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar delete-db-cluster-snapshot.

AWS CLI

Para excluir um snapshot de cluster de banco de dados

O exemplo delete-db-cluster-snapshot a seguir exclui o snapshot de cluster de banco de dados especificado.

aws rds delete-db-cluster-snapshot \
    --db-cluster-snapshot-identifier mydbclustersnapshot

Saída:

{
    "DBClusterSnapshot": {
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1e"
        ],
        "DBClusterSnapshotIdentifier": "mydbclustersnapshot",
        "DBClusterIdentifier": "mydbcluster",
        "SnapshotCreateTime": "2019-06-18T21:21:00.469Z",
        "Engine": "aurora-mysql",
        "AllocatedStorage": 0,
        "Status": "available",
        "Port": 0,
        "VpcId": "vpc-6594f31c",
        "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
        "MasterUsername": "myadmin",
        "EngineVersion": "5.7.mysql_aurora.2.04.2",
        "LicenseModel": "aurora-mysql",
        "SnapshotType": "manual",
        "PercentProgress": 100,
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot",
        "IAMDatabaseAuthenticationEnabled": false
    }
}

Para obter mais informações, consulte Excluir um snapshot no Guia do usuário do Amazon Aurora.

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

AWS CLI

Exemplo 1: excluir uma instância de banco de dados em um cluster de banco de dados

O exemplo delete-db-instance a seguir exclui a instância de banco de dados final em um cluster de banco de dados. Você não pode excluir um cluster de banco de dados se ele contiver instâncias de banco de dados que não estejam no estado de exclusão. Não é possível tirar um snapshot final ao excluir uma instância de banco de dados em um cluster de banco de dados.

aws rds delete-db-instance \
    --db-instance-identifier database-3

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "database-3",
        "DBInstanceClass": "db.r4.large",
        "Engine": "aurora-postgresql",
        "DBInstanceStatus": "deleting",

    ...output omitted...

    }
}

Para obter mais informações, consulte Excluir uma instância de banco de dados em um cluster de banco de dados do Aurora no Guia do usuário do Amazon Aurora.

Exemplo 2: excluir um cluster de banco de dados

O exemplo delete-db-cluster a seguir exclui o cluster de banco de dados denominado mycluster e tira um snapshot final denominado mycluster-final-snapshot. O status do cluster de banco de dados fica disponível enquanto o snapshot está sendo obtido. Para acompanhar o progresso da exclusão, use o comando describe-db-clusters da CLI.

aws rds delete-db-cluster \
    --db-cluster-identifier mycluster \
    --no-skip-final-snapshot \
    --final-db-snapshot-identifier mycluster-final-snapshot

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 20,
        "AvailabilityZones": [
            "eu-central-1b",
            "eu-central-1c",
            "eu-central-1a"
        ],
        "BackupRetentionPeriod": 7,
        "DBClusterIdentifier": "mycluster",
        "DBClusterParameterGroup": "default.aurora-postgresql10",
        "DBSubnetGroup": "default-vpc-aa11bb22",
        "Status": "available",

    ...output omitted...

    }
}

Para obter mais informações, consulte Clusters do Aurora com Instância uma instância única de banco de dados no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar delete-db-instance-automated-backup.

AWS CLI

Excluir um backup automatizado replicado de uma região

O exemplo delete-db-instance-automated-backup a seguir exclui o backup automatizado com o nome do recurso da Amazon (ARN) especificado.

aws rds delete-db-instance-automated-backup \
    --db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"

Saída:

{
    "DBInstanceAutomatedBackup": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
        "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
        "Region": "us-east-1",
        "DBInstanceIdentifier": "new-orcl-db",
        "RestoreWindow": {},
        "AllocatedStorage": 20,
        "Status": "deleting",
        "Port": 1521,
        "AvailabilityZone": "us-east-1b",
        "VpcId": "vpc-########",
        "InstanceCreateTime": "2020-12-04T15:28:31Z",
        "MasterUsername": "admin",
        "Engine": "oracle-se2",
        "EngineVersion": "12.1.0.2.v21",
        "LicenseModel": "bring-your-own-license",
        "OptionGroupName": "default:oracle-se2-12-1",
        "Encrypted": false,
        "StorageType": "gp2",
        "IAMDatabaseAuthenticationEnabled": false,
        "BackupRetentionPeriod": 7,
        "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
    }
}

Para obter mais informações, consulte Excluir backups replicados no Guia do usuário do Amazon RDS.

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

AWS CLI

Como excluir uma instância de banco de dados

O exemplo de delete-db-instance a seguir exclui a instância de banco de dados especificada depois de criar um snapshot de banco de dados final chamado test-instance-final-snap.

aws rds delete-db-instance \
    --db-instance-identifier test-instance \
    --final-db-snapshot-identifier test-instance-final-snap

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "test-instance",
        "DBInstanceStatus": "deleting",
        ...some output truncated...
    }
}

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

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

AWS CLI

Como excluir um grupo de parâmetros de banco de dados

O exemplo de command a seguir exclui um grupo de parâmetros de banco de dados.

aws rds delete-db-parameter-group \
    --db-parameter-group-name mydbparametergroup

Este comando não produz saída.

Para obter mais informações, consulte Como trabalhar com grupos de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar delete-db-proxy-endpoint.

AWS CLI

Para excluir um endpoint de proxy de banco de dados para um banco de dados do RDS

O exemplo delete-db-proxy-endpoint a seguir exclui um endpoint de proxy de banco de dados para o banco de dados de destino.

aws rds delete-db-proxy-endpoint \
    --db-proxy-endpoint-name proxyEP1

Saída:

{
"DBProxyEndpoint":
    {
        "DBProxyEndpointName": "proxyEP1",
        "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
        "DBProxyName": "proxyExample",
        "Status": "deleting",
        "VpcId": "vpc-1234567",
        "VpcSecurityGroupIds": [
            "sg-1234",
            "sg-5678"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Endpoint": "proxyEP1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
        "CreatedDate": "2023-04-13T01:49:38.568000+00:00",
        "TargetRole": "READ_ONLY",
        "IsDefault": false
    }
}

Para obter mais informações, consulte Excluir um endpoint de proxy no Guia do usuário do Amazon RDS e Excluir um endpoint de proxy no Guia do usuário do Amazon Aurora.

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

AWS CLI

Para excluir um proxy de banco de dados de um banco de dados do RDS

O exemplo delete-db-proxy a seguir exclui um proxy de banco de dados.

aws rds delete-db-proxy \
    --db-proxy-name proxyExample

Saída:

{
        "DBProxy":
        {
            "DBProxyName": "proxyExample",
            "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
            "Status": "deleting",
            "EngineFamily": "PostgreSQL",
            "VpcId": "vpc-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234",
                "sg-5678"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Auth": "[
                {
                "Description": "proxydescription`"
                "AuthScheme": "SECRETS",
                "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e",
                "IAMAuth": "DISABLED"
                } ],
            "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole",
            "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "RequireTLS": false,
            "IdleClientTimeout": 1800,
            "DebuggingLogging": false,
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
    }
}

Para obter mais informações, consulte Excluir um proxy do RDS no Guia do usuário do Amazon RDS e Excluir um proxy do RDS no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte DeleteDbProxy em Referência de comandos da AWS CLI.

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

AWS CLI

Para excluir um grupo de segurança do banco de dados

O exemplo delete-db-security-group a seguir exclui um grupo de segurança denominado mysecuritygroup.

aws rds delete-db-security-group \
    --db-security-group-name mysecuritygroup

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com grupos de segurança de banco de dados (EC2-Classic platform) no Guia do usuário do Amazon RDS.

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

AWS CLI

Exemplo 1: excluir um grupo de fragmentos de banco de dados sem êxito

O exemplo delete-db-shard-group a seguir mostra o erro que ocorre quando você tenta excluir um grupo de fragmentos de banco de dados antes de excluir todos os bancos de dados e esquemas.

aws rds delete-db-shard-group \
    --db-shard-group-identifier limitless-test-shard-grp

Saída:

An error occurred (InvalidDBShardGroupState) when calling the DeleteDBShardGroup operation: Unable to delete the DB shard group limitless-test-db-shard-group.
Delete all of your Limitless Database databases and schemas, then try again.

Exemplo 2: excluir um grupo de fragmentos de banco de dados com êxito

O exemplo delete-db-shard-group a seguir exclui um grupo de fragmentos de banco de dados depois que você exclui todos os bancos de dados e esquemas, incluindo o esquema public.

aws rds delete-db-shard-group \
    --db-shard-group-identifier limitless-test-shard-grp

Saída:

{
    "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example",
    "DBShardGroupIdentifier": "limitless-test-shard-grp",
    "DBClusterIdentifier": "limitless-test-cluster",
    "MaxACU": 768.0,
    "ComputeRedundancy": 0,
    "Status": "deleting",
    "PubliclyAccessible": true,
    "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
}

Para obter mais informações, consulte Excluir clusters de banco de dados do Aurora e instâncias de banco de dados no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte DeleteDbShardGroup em Referência de comandos da AWS CLI.

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

AWS CLI

Para excluir um snapshot de banco de dados

O exemplo delete-db-snapshot a seguir exclui o snapshot de banco de dados especificado.

aws rds delete-db-snapshot \
    --db-snapshot-identifier mydbsnapshot

Saída:

{
    "DBSnapshot": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBInstanceIdentifier": "database-mysql",
        "SnapshotCreateTime": "2019-06-18T22:08:40.702Z",
        "Engine": "mysql",
        "AllocatedStorage": 100,
        "Status": "deleted",
        "Port": 3306,
        "AvailabilityZone": "us-east-1b",
        "VpcId": "vpc-6594f31c",
        "InstanceCreateTime": "2019-04-30T15:45:53.663Z",
        "MasterUsername": "admin",
        "EngineVersion": "5.6.40",
        "LicenseModel": "general-public-license",
        "SnapshotType": "manual",
        "Iops": 1000,
        "OptionGroupName": "default:mysql-5-6",
        "PercentProgress": 100,
        "StorageType": "io1",
        "Encrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
        "IAMDatabaseAuthenticationEnabled": false,
        "ProcessorFeatures": [],
        "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE"
    }
}

Para obter mais informações, consulte Excluir um snapshot no Guia do usuário do Amazon RDS.

  • Para ver detalhes da API, consulte DeleteDbSnapshot em Referência de comandos da AWS CLI.

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

AWS CLI

Excluir um grupo de sub-redes de banco de dados

O exemplo delete-db-subnet-group a seguir exclui o grupo de sub-redes de banco de dados denominado mysubnetgroup.

aws rds delete-db-subnet-group --db-subnet-group-name mysubnetgroup

Este comando não produz saída.

Para obter mais informações, consulte Trabalhar com uma instância de banco de dados em uma VPC no Guia do usuário do Amazon RDS.

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

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

AWS CLI

Para excluir uma assinatura de evento

O exemplo delete-event-subscription a seguir exclui a assinatura especificada de um evento.

aws rds delete-event-subscription --subscription-name my-instance-events

Saída:

{
    "EventSubscription": {
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "CustomerAwsId": "123456789012",
        "Enabled": false,
        "SourceIdsList": [
            "test-instance"
        ],
        "SourceType": "db-instance",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "SubscriptionCreationTime": "2018-07-31 23:22:01.893",
        "CustSubscriptionId": "my-instance-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "Status": "deleting"
    }
}

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

AWS CLI

Excluir um cluster de banco de dados global

O exemplo delete-global-cluster a seguir exclui um cluster de banco de dados global compatível com o Aurora MySQL. O resultado mostra o cluster que você está excluindo, mas os comandos de describe-global-clusters subsequentes não listam esse cluster de banco de dados.

aws rds delete-global-cluster \
    --global-cluster-identifier myglobalcluster

Saída:

{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
        "Status": "available",
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.mysql_aurora.2.07.2",
        "StorageEncrypted": false,
        "DeletionProtection": false,
        "GlobalClusterMembers": []
    }
}

Para obter mais informações, consulte Excluir um banco de dados global do Aurora no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte DeleteGlobalCluster em Referência de comandos da AWS CLI.

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

AWS CLI

Excluir um grupo de opções

O exemplo delete-option-group a seguir exclui o grupo de opções especificado.

aws rds delete-option-group \
    --option-group-name myoptiongroup

Este comando não produz saída.

Para obter mais informações, consulte Excluir um grupo de opções no Guia do usuário do Amazon RDS.

  • Para ver detalhes da API, consulte DeleteOptionGroup em Referência de comandos da AWS CLI.

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

AWS CLI

Cancelar o registro de um alvo de proxy de banco de dados do grupo de destino do banco de dados

O exemplo deregister-db-proxy-targets a seguir remove a associação entre o proxy proxyExample e seu destino.

aws rds deregister-db-proxy-targets \
    --db-proxy-name proxyExample \
    --db-instance-identifiers database-1

Este comando não produz saída.

Para obter mais informações, consulte Excluir um proxy do RDS no Guia do usuário do Amazon RDS e Excluir um proxy do RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-account-attributes.

AWS CLI

Como descrever os atributos da conta

O exemplo de describe-account-attributes a seguir recupera os atributos da conta da AWS atual.

aws rds describe-account-attributes

Saída:

{
    "AccountQuotas": [
        {
            "Max": 40,
            "Used": 4,
            "AccountQuotaName": "DBInstances"
        },
        {
            "Max": 40,
            "Used": 0,
            "AccountQuotaName": "ReservedDBInstances"
        },
        {
            "Max": 100000,
            "Used": 40,
            "AccountQuotaName": "AllocatedStorage"
        },
        {
            "Max": 25,
            "Used": 0,
            "AccountQuotaName": "DBSecurityGroups"
        },
        {
            "Max": 20,
            "Used": 0,
            "AccountQuotaName": "AuthorizationsPerDBSecurityGroup"
        },
        {
            "Max": 50,
            "Used": 1,
            "AccountQuotaName": "DBParameterGroups"
        },
        {
            "Max": 100,
            "Used": 3,
            "AccountQuotaName": "ManualSnapshots"
        },
        {
            "Max": 20,
            "Used": 0,
            "AccountQuotaName": "EventSubscriptions"
        },
        {
            "Max": 50,
            "Used": 1,
            "AccountQuotaName": "DBSubnetGroups"
        },
        {
            "Max": 20,
            "Used": 1,
            "AccountQuotaName": "OptionGroups"
        },
        {
            "Max": 20,
            "Used": 6,
            "AccountQuotaName": "SubnetsPerDBSubnetGroup"
        },
        {
            "Max": 5,
            "Used": 0,
            "AccountQuotaName": "ReadReplicasPerMaster"
        },
        {
            "Max": 40,
            "Used": 1,
            "AccountQuotaName": "DBClusters"
        },
        {
            "Max": 50,
            "Used": 0,
            "AccountQuotaName": "DBClusterParameterGroups"
        },
        {
            "Max": 5,
            "Used": 0,
            "AccountQuotaName": "DBClusterRoles"
        }
    ]
}

O código de exemplo a seguir mostra como usar describe-blue-green-deployments.

AWS CLI

Exemplo 1: descrever uma implantação azul/verde de uma instância de banco de dados do RDS após a conclusão da criação

O exemplo describe-blue-green-deployment a seguir recupera os detalhes de uma implantação azul/verde após a conclusão da criação.

aws rds describe-blue-green-deployments \
    --blue-green-deployment-identifier bgd-v53303651eexfake

Saída:

{
    "BlueGreenDeployments": [
        {
            "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
            "BlueGreenDeploymentName": "bgd-cli-test-instance",
            "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
            "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe",
            "SwitchoverDetails": [
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t",
                    "Status": "AVAILABLE"
                }
            ],
            "Tasks": [
                {
                    "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "DB_ENGINE_VERSION_UPGRADE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CONFIGURE_BACKUPS",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATING_TOPOLOGY_OF_SOURCE",
                    "Status": "COMPLETED"
                }
            ],
            "Status": "AVAILABLE",
            "CreateTime": "2022-02-25T21:18:51.183000+00:00"
        }
    ]
}

Para obter mais informações, consulte Visualizar uma implantação azul/verde no Guia do usuário do Amazon RDS.

Exemplo 2: descrever uma implantação azul/verde para um cluster de banco de dados do Aurora MySQL

O exemplo describe-blue-green-deployment a seguir recupera os detalhes de uma implantação azul/verde.

aws rds describe-blue-green-deployments \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake

Saída:

{
    "BlueGreenDeployments": [
        {
            "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
            "BlueGreenDeploymentName": "my-blue-green-deployment",
            "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
            "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
            "SwitchoverDetails": [
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg",
                    "Status": "AVAILABLE"
                }
            ],
            "Tasks": [
                {
                    "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "DB_ENGINE_VERSION_UPGRADE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATE_CUSTOM_ENDPOINTS",
                    "Status": "COMPLETED"
                }
            ],
            "Status": "AVAILABLE",
            "CreateTime": "2022-02-25T21:12:00.288000+00:00"
        }
    ]
}

Para obter mais informações, consulte Visualizar uma implantação azul/verde no Guia do usuário do Amazon Aurora.

Exemplo 3: descrever uma implantação azul/verde para um cluster do Aurora MySQL após a transição

O exemplo describe-blue-green-deployment a seguir recupera os detalhes sobre uma implantação azul/verde depois que o ambiente verde é promovido para ser o ambiente de produção.

aws rds describe-blue-green-deployments \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake

Saída:

{
    "BlueGreenDeployments": [
        {
            "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
            "BlueGreenDeploymentName": "my-blue-green-deployment",
            "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1",
            "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
            "SwitchoverDetails": [
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
                    "Status": "SWITCHOVER_COMPLETED"
                }
            ],
            "Tasks": [
                {
                    "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "DB_ENGINE_VERSION_UPGRADE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATE_CUSTOM_ENDPOINTS",
                    "Status": "COMPLETED"
                }
            ],
            "Status": "SWITCHOVER_COMPLETED",
            "CreateTime": "2022-02-25T22:38:49.522000+00:00"
        }
    ]
}

Para obter mais informações, consulte Visualizar uma implantação azul/verde no Guia do usuário do Amazon Aurora.

Exemplo 4: descrever uma implantação azul/verde combinada

O exemplo describe-blue-green-deployment a seguir recupera os detalhes de uma implantação azul/verde combinada.

aws rds describe-blue-green-deployments

Saída:

{
    "BlueGreenDeployments": [
        {
            "BlueGreenDeploymentIdentifier": "bgd-wi89nwzgfakelccs",
            "BlueGreenDeploymentName": "my-blue-green-deployment",
            "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
            "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
            "SwitchoverDetails": [
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq",
                    "Status": "AVAILABLE"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg",
                    "Status": "AVAILABLE"
                }
            ],
            "Tasks": [
                {
                    "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "DB_ENGINE_VERSION_UPGRADE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATE_CUSTOM_ENDPOINTS",
                    "Status": "COMPLETED"
                }
            ],
            "Status": "AVAILABLE",
            "CreateTime": "2022-02-25T21:12:00.288000+00:00"
        },
        {
            "BlueGreenDeploymentIdentifier": "bgd-v5330365fake1eex",
            "BlueGreenDeploymentName": "bgd-cli-test-instance",
            "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1",
            "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
            "SwitchoverDetails": [
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
                    "Status": "SWITCHOVER_COMPLETED"
                },
                {
                    "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-old1",
                    "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
                    "Status": "SWITCHOVER_COMPLETED"
                }
            ],
            "Tasks": [
                {
                    "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "DB_ENGINE_VERSION_UPGRADE",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CONFIGURE_BACKUPS",
                    "Status": "COMPLETED"
                },
                {
                    "Name": "CREATING_TOPOLOGY_OF_SOURCE",
                    "Status": "COMPLETED"
                }
            ],
            "Status": "SWITCHOVER_COMPLETED",
            "CreateTime": "2022-02-25T22:33:22.225000+00:00"
        }
    ]
}

Para obter mais informações, consulte Visualizar uma implantação azul/verde no Guia do usuário do Amazon RDS e Visualizar uma implantação azul/verde em Guia do usuário do Amazon Aurora.

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

AWS CLI

descrever certificados

O exemplo describe-certificates a seguir recupera os detalhes do certificado associado à região padrão do usuário.

aws rds describe-certificates

Saída:

{
    "Certificates": [
        {
            "CertificateIdentifier": "rds-ca-ecc384-g1",
            "CertificateType": "CA",
            "Thumbprint": "2ee3dcc06e50192559b13929e73484354f23387d",
            "ValidFrom": "2021-05-24T22:06:59+00:00",
            "ValidTill": "2121-05-24T23:06:59+00:00",
            "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-ecc384-g1",
            "CustomerOverride": false
        },
        {
            "CertificateIdentifier": "rds-ca-rsa4096-g1",
            "CertificateType": "CA",
            "Thumbprint": "19da4f2af579a8ae1f6a0fa77aa5befd874b4cab",
            "ValidFrom": "2021-05-24T22:03:20+00:00",
            "ValidTill": "2121-05-24T23:03:20+00:00",
            "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-rsa4096-g1",
            "CustomerOverride": false
        },
        {
            "CertificateIdentifier": "rds-ca-rsa2048-g1",
            "CertificateType": "CA",
            "Thumbprint": "7c40cb42714b6fdb2b296f9bbd0e8bb364436a76",
            "ValidFrom": "2021-05-24T21:59:00+00:00",
            "ValidTill": "2061-05-24T22:59:00+00:00",
            "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-rsa2048-g1",
            "CustomerOverride": true,
            "CustomerOverrideValidTill": "2061-05-24T22:59:00+00:00"
        },
        {
            "CertificateIdentifier": "rds-ca-2019",
            "CertificateType": "CA",
            "Thumbprint": "d40ddb29e3750dffa671c3140bbf5f478d1c8096",
            "ValidFrom": "2019-08-22T17:08:50+00:00",
            "ValidTill": "2024-08-22T17:08:50+00:00",
            "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-2019",
            "CustomerOverride": false
        }
    ],
    "DefaultCertificateForNewLaunches": "rds-ca-rsa2048-g1"
}

Para obter mais informações, consulte Usar SSL/TLS para criptografar uma conexão com uma instância de banco de dados no Guia do usuário do Amazon RDS e Usar SSL/TLS para criptografar uma conexão com um cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-cluster-backtracks.

AWS CLI

Descrever os retrocessos para um cluster de banco de dados

O exemplo describe-db-cluster-backtracks a seguir recupera detalhes do cluster especificado.

aws rds describe-db-cluster-backtracks \
    --db-cluster-identifier mydbcluster

Saída:

{
    "DBClusterBacktracks": [
        {
            "DBClusterIdentifier": "mydbcluster",
            "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE",
            "BacktrackTo": "2021-02-12T04:59:22Z",
            "BacktrackedFrom": "2021-02-12T14:37:31.640Z",
            "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z",
            "Status": "COMPLETED"
        },
        {
            "DBClusterIdentifier": "mydbcluster",
            "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE",
            "BacktrackTo": "2021-02-11T22:53:46Z",
            "BacktrackedFrom": "2021-02-12T00:09:27.006Z",
            "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z",
            "Status": "COMPLETED"
        }
    ]
}

Para obter mais informações, consulte Retroceder um cluster de banco de dados do Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-cluster-endpoints.

AWS CLI

Exemplo 1: descrever endpoints de um cluster de banco de dados

O exemplo describe-db-cluster-endpoints a seguir recupera detalhes dos endpoints do cluster de banco de dados. Os tipos mais comuns de clusters do Aurora têm dois endpoints. Um endpoint é do tipoWRITER. Você pode usar esse endpoint para todas as instruções de SQL. O outro endpoint é do tipoREADER. Você pode usar esse endpoint somente para SELECT e outras instruções de SQL somente leitura.

aws rds describe-db-cluster-endpoints

Saída:

{
    "DBClusterEndpoints": [
        {
            "DBClusterIdentifier": "my-database-1",
            "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com",
            "Status": "creating",
            "EndpointType": "WRITER"
        },
        {
            "DBClusterIdentifier": "my-database-1",
            "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
            "Status": "creating",
            "EndpointType": "READER"
        },
        {
            "DBClusterIdentifier": "mydbcluster",
            "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com",
            "Status": "available",
            "EndpointType": "WRITER"
        },
        {
            "DBClusterIdentifier": "mydbcluster",
            "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
            "Status": "available",
            "EndpointType": "READER"
        }
    ]
}

Exemplo 2: descrever os endpoints do cluster de banco de dados de um único cluster de banco de dados

O exemplo describe-db-cluster-endpoints a seguir recupera detalhes dos endpoints do cluster de banco de dados de um único cluster de banco de dados especificado. Os clusters de tecnologia sem servidor do Aurora têm apenas um único endpoint do tipo WRITER.

aws rds describe-db-cluster-endpoints \
    --db-cluster-identifier serverless-cluster

Saída:

{
    "DBClusterEndpoints": [
        {
            "Status": "available",
            "Endpoint": "serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
            "DBClusterIdentifier": "serverless-cluster",
            "EndpointType": "WRITER"
        }
    ]
}

Para obter mais informações, consulte Gerenciamento de conexões do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-cluster-parameter-groups.

AWS CLI

Descrever os grupos de parâmetros de cluster de banco de dados

O exemplo describe-db-cluster-parameter-groups a seguir recupera detalhes dos grupos de parâmetros de banco de dados.

aws rds describe-db-cluster-parameter-groups

Saída:

{
    "DBClusterParameterGroups": [
        {
            "DBClusterParameterGroupName": "default.aurora-mysql5.7",
            "DBParameterGroupFamily": "aurora-mysql5.7",
            "Description": "Default cluster parameter group for aurora-mysql5.7",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7"
        },
        {
            "DBClusterParameterGroupName": "default.aurora-postgresql9.6",
            "DBParameterGroupFamily": "aurora-postgresql9.6",
            "Description": "Default cluster parameter group for aurora-postgresql9.6",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6"
        },
        {
            "DBClusterParameterGroupName": "default.aurora5.6",
            "DBParameterGroupFamily": "aurora5.6",
            "Description": "Default cluster parameter group for aurora5.6",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6"
        },
        {
            "DBClusterParameterGroupName": "mydbclusterpg",
            "DBParameterGroupFamily": "aurora-mysql5.7",
            "Description": "My DB cluster parameter group",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg"
        },
        {
            "DBClusterParameterGroupName": "mydbclusterpgcopy",
            "DBParameterGroupFamily": "aurora-mysql5.7",
            "Description": "Copy of mydbclusterpg parameter group",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy"
        }
    ]
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-cluster-parameters.

AWS CLI

Exemplo 1: descrever os parâmetros em um grupo de parâmetros de cluster de banco de dados

O exemplo describe-db-cluster-parameters a seguir recupera detalhes sobre os parâmetros em um grupo de parâmetros de banco de dados.

aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name mydbclusterpg

Saída:

{
    "Parameters": [
        {
            "ParameterName": "allow-suspicious-udfs",
            "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
            "Source": "engine-default",
            "ApplyType": "static",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": false,
            "ApplyMethod": "pending-reboot",
            "SupportedEngineModes": [
                "provisioned"
            ]
        },
        {
            "ParameterName": "aurora_lab_mode",
            "ParameterValue": "0",
            "Description": "Enables new features in the Aurora engine.",
            "Source": "engine-default",
            "ApplyType": "static",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot",
            "SupportedEngineModes": [
                "provisioned"
            ]
        },
        ...some output truncated...
    ]
}

Exemplo 2: listar somente os nomes dos parâmetros em um grupo de parâmetros do cluster de banco de dados

O exemplo describe-db-cluster-parameters a seguir recupera somente os nomes dos parâmetros em um grupo de parâmetros do cluster de banco de dados.

aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name default.aurora-mysql5.7 \
    --query 'Parameters[].{ParameterName:ParameterName}'

Saída:

[
    {
        "ParameterName": "allow-suspicious-udfs"
    },
    {
        "ParameterName": "aurora_binlog_read_buffer_size"
    },
    {
        "ParameterName": "aurora_binlog_replication_max_yield_seconds"
    },
    {
        "ParameterName": "aurora_binlog_use_large_read_buffer"
    },
    {
        "ParameterName": "aurora_lab_mode"
    },

    ...some output truncated...
    }
]

Exemplo 3: descrever somente os parâmetros modificáveis em um grupo de parâmetros de cluster de banco de dados

O exemplo describe-db-cluster-parameters a seguir recupera os nomes somente dos parâmetros que você pode modificar em um grupo de parâmetros do cluster de banco de dados.

aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name default.aurora-mysql5.7 \
    --query 'Parameters[].{ParameterName:ParameterName,IsModifiable:IsModifiable} | [?IsModifiable == `true`]'

Saída:

[
    {
        "ParameterName": "aurora_binlog_read_buffer_size",
        "IsModifiable": true
    },
    {
        "ParameterName": "aurora_binlog_replication_max_yield_seconds",
        "IsModifiable": true
    },
    {
        "ParameterName": "aurora_binlog_use_large_read_buffer",
        "IsModifiable": true
    },
    {
        "ParameterName": "aurora_lab_mode",
        "IsModifiable": true
    },

    ...some output truncated...
    }
]

Exemplo 4: descrever somente os parâmetros booleanos modificáveis em um grupo de parâmetros do cluster de banco de dados

O exemplo describe-db-cluster-parameters a seguir recupera somente os nomes dos parâmetros que você pode modificar em um grupo de parâmetros de cluster de banco de dados e que têm um tipo de dados booleano.

aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name default.aurora-mysql5.7 \
    --query 'Parameters[].{ParameterName:ParameterName,DataType:DataType,IsModifiable:IsModifiable} | [?DataType == `boolean`] | [?IsModifiable == `true`]'

Saída:

[
    {
        "DataType": "boolean",
        "ParameterName": "aurora_binlog_use_large_read_buffer",
        "IsModifiable": true
    },
    {
        "DataType": "boolean",
        "ParameterName": "aurora_lab_mode",
        "IsModifiable": true
    },
    {
        "DataType": "boolean",
        "ParameterName": "autocommit",
        "IsModifiable": true
    },
    {
        "DataType": "boolean",
        "ParameterName": "automatic_sp_privileges",
        "IsModifiable": true
    },
    ...some output truncated...
    }
]

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-cluster-snapshot-attributes.

AWS CLI

Descrever os nomes e valores de atributos de um snapshot de cluster de banco de dados

O exemplo describe-db-cluster-snapshot-attributes a seguir recupera os detalhes dos nomes e valores dos atributos do snapshot do cluster do banco de dados especificado.

aws rds describe-db-cluster-snapshot-attributes \
    --db-cluster-snapshot-identifier myclustersnapshot

Saída:

{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotIdentifier": "myclustersnapshot",
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789012"
                ]
            }
        ]
    }
}

Para obter mais informações, consulte Compartilhar um snapshot de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-cluster-snapshots.

AWS CLI

Descrever um snapshot de cluster de banco de dados de um cluster de banco de dados

O exemplo describe-db-cluster-snapshots a seguir recupera os detalhes dos snapshots do cluster de banco de dados para o cluster de banco de dados especificado.

aws rds describe-db-cluster-snapshots \
    --db-cluster-identifier mydbcluster

Saída:

{
    "DBClusterSnapshots": [
        {
            "AvailabilityZones": [
                "us-east-1a",
                "us-east-1b",
                "us-east-1e"
            ],
            "DBClusterSnapshotIdentifier": "myclustersnapshotcopy",
            "DBClusterIdentifier": "mydbcluster",
            "SnapshotCreateTime": "2019-06-04T09:16:42.649Z",
            "Engine": "aurora-mysql",
            "AllocatedStorage": 0,
            "Status": "available",
            "Port": 0,
            "VpcId": "vpc-6594f31c",
            "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
            "MasterUsername": "myadmin",
            "EngineVersion": "5.7.mysql_aurora.2.04.2",
            "LicenseModel": "aurora-mysql",
            "SnapshotType": "manual",
            "PercentProgress": 100,
            "StorageEncrypted": true,
            "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
            "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy",
            "IAMDatabaseAuthenticationEnabled": false
        },
        {
            "AvailabilityZones": [
                "us-east-1a",
                "us-east-1b",
                "us-east-1e"
            ],
            "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16",
            "DBClusterIdentifier": "mydbcluster",
            "SnapshotCreateTime": "2019-06-20T09:16:26.569Z",
            "Engine": "aurora-mysql",
            "AllocatedStorage": 0,
            "Status": "available",
            "Port": 0,
            "VpcId": "vpc-6594f31c",
            "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
            "MasterUsername": "myadmin",
            "EngineVersion": "5.7.mysql_aurora.2.04.2",
            "LicenseModel": "aurora-mysql",
            "SnapshotType": "automated",
            "PercentProgress": 100,
            "StorageEncrypted": true,
            "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE",
            "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16",
            "IAMDatabaseAuthenticationEnabled": false
        }
    ]
}

Para obter mais informações, consulte Criar um snapshot de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-clusters.

AWS CLI

Exemplo 1: descrever um cluster

O exemplo describe-db-clusters a seguir recupera detalhes do cluster de banco de dados especificado.

aws rds describe-db-clusters \
    --db-cluster-identifier mydbcluster

Saída:

{
    "DBClusters": [
        {
            "AllocatedStorage": 1,
            "AvailabilityZones": [
                "us-east-1a",
                "us-east-1b",
                "us-east-1e"
            ],
            "BackupRetentionPeriod": 1,
            "DatabaseName": "mydbcluster",
            "DBClusterIdentifier": "mydbcluster",
            "DBClusterParameterGroup": "default.aurora-mysql5.7",
            "DBSubnetGroup": "default",
            "Status": "available",
            "EarliestRestorableTime": "2019-06-19T09:16:28.210Z",
            "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
            "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
            "MultiAZ": true,
            "Engine": "aurora-mysql",
            "EngineVersion": "5.7.mysql_aurora.2.04.2",
            "LatestRestorableTime": "2019-06-20T22:38:14.908Z",
            "Port": 3306,
            "MasterUsername": "myadmin",
            "PreferredBackupWindow": "09:09-09:39",
            "PreferredMaintenanceWindow": "sat:04:09-sat:04:39",
            "ReadReplicaIdentifiers": [],
            "DBClusterMembers": [
                {
                    "DBInstanceIdentifier": "dbinstance3",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "dbinstance1",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "dbinstance2",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "mydbcluster",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "mydbcluster-us-east-1b",
                    "IsClusterWriter": false,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "mydbcluster",
                    "IsClusterWriter": true,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                }
            ],
            "VpcSecurityGroups": [
                {
                    "VpcSecurityGroupId": "sg-0b9130572daf3dc16",
                    "Status": "active"
                }
            ],
            "HostedZoneId": "Z2R2ITUGPM61AM",
            "StorageEncrypted": true,
            "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE",
            "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE",
            "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster",
            "AssociatedRoles": [],
            "IAMDatabaseAuthenticationEnabled": false,
            "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
            "EngineMode": "provisioned",
            "DeletionProtection": false,
            "HttpEndpointEnabled": false
        }
    ]
}

Exemplo 2: listar determinados atributos de todos os clusters de banco de dados

O exemplo describe-db-clusters a seguir recupera somente os atributos DBClusterIdentifier, Endpoint e ReaderEndpoint, e atributos de todos os clusters de banco de dados na região da AWS atual.

aws rds describe-db-clusters \
    --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Endpoint:Endpoint,ReaderEndpoint:ReaderEndpoint}'

Saída:

[
    {
        "Endpoint": "cluster-57-2020-05-01-2270.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-57-2020-05-01-2270.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterIdentifier": "cluster-57-2020-05-01-2270"
    },
    {
        "Endpoint": "cluster-57-2020-05-01-4615.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-57-2020-05-01-4615.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterIdentifier": "cluster-57-2020-05-01-4615"
    },
    {
        "Endpoint": "pg2-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
        "ReaderEndpoint": "pg2-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
        "DBClusterIdentifier": "pg2-cluster"
    },
    ...output omitted...
    }
]

Exemplo 3: listar clusters de banco de dados com um atributo específico

O exemplo describe-db-clusters a seguir recupera somente os atributos DBClusterIdentifier e Engine dos clusters de banco de dados que usam o mecanismo de banco de dados aurora-postgresql.

aws rds describe-db-clusters \
    --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Engine:Engine} | [?Engine == `aurora-postgresql`]'

Saída:

[
    {
        "Engine": "aurora-postgresql",
        "DBClusterIdentifier": "pg2-cluster"
    }
]

Para obter mais informações, consulte Clusters de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar describe-db-engine-versions.

AWS CLI

Como descrever as versões do mecanismo de banco de dados do mecanismo de banco de dados do MySQL

O exemplo de describe-db-engine-versions a seguir exibe os detalhes de cada uma das versões do mecanismo de banco de dados para o mecanismo de banco de dados especificado.

aws rds describe-db-engine-versions \
    --engine mysql

Saída:

{
    "DBEngineVersions": [
        {
            "Engine": "mysql",
            "EngineVersion": "5.5.46",
            "DBParameterGroupFamily": "mysql5.5",
            "DBEngineDescription": "MySQL Community Edition",
            "DBEngineVersionDescription": "MySQL 5.5.46",
            "ValidUpgradeTarget": [
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.53",
                    "Description": "MySQL 5.5.53",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.54",
                    "Description": "MySQL 5.5.54",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.57",
                    "Description": "MySQL 5.5.57",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                ...some output truncated...
            ]
        }

Para obter mais informações sobre o Amazon RDS, consulte O que é o Amazon Relational Database Service (Amazon RDS)? no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-db-instance-automated-backups.

AWS CLI

Descrever backups automatizados para uma instância de banco de dados

O exemplo describe-db-instance-automated-backups a seguir exibe os detalhes dos backups automatizados para a instância de banco de dados especificada. Os detalhes incluem backups automatizados replicados em outras regiões da AWS.

aws rds describe-db-instance-automated-backups \
    --db-instance-identifier new-orcl-db

Saída:

{
    "DBInstanceAutomatedBackups": [
        {
            "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
            "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
            "Region": "us-east-1",
            "DBInstanceIdentifier": "new-orcl-db",
            "RestoreWindow": {
                "EarliestTime": "2020-12-07T21:05:20.939Z",
                "LatestTime": "2020-12-07T21:05:20.939Z"
            },
            "AllocatedStorage": 20,
            "Status": "replicating",
            "Port": 1521,
            "InstanceCreateTime": "2020-12-04T15:28:31Z",
            "MasterUsername": "admin",
            "Engine": "oracle-se2",
            "EngineVersion": "12.1.0.2.v21",
            "LicenseModel": "bring-your-own-license",
            "OptionGroupName": "default:oracle-se2-12-1",
            "Encrypted": false,
            "StorageType": "gp2",
            "IAMDatabaseAuthenticationEnabled": false,
            "BackupRetentionPeriod": 14,
            "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
        }
    ]
}

Para obter mais informações, consulte Descobrir informações sobre backups replicados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-db-instances.

AWS CLI

Como descrever uma instância de banco de dados

O exemplo de describe-db-instances a seguir recupera detalhes sobre a instância de banco de dados especificada.

aws rds describe-db-instances \
    --db-instance-identifier mydbinstancecf

Saída:

{
    "DBInstances": [
        {
            "DBInstanceIdentifier": "mydbinstancecf",
            "DBInstanceClass": "db.t3.small",
            "Engine": "mysql",
            "DBInstanceStatus": "available",
            "MasterUsername": "masterawsuser",
            "Endpoint": {
                "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com",
                "Port": 3306,
                "HostedZoneId": "Z2R2ITUGPM61AM"
            },
            ...some output truncated...
        }
    ]
}

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

O código de exemplo a seguir mostra como usar describe-db-log-files.

AWS CLI

Descrever os arquivos de log de uma instância de banco de dados

O exemplo describe-db-log-files a seguir recupera detalhes dos arquivos de log da instância de banco de dados especificada.

aws rds describe-db-log-files -\
    -db-instance-identifier test-instance

Saída:

{
    "DescribeDBLogFiles": [
        {
            "Size": 0,
            "LastWritten": 1533060000000,
            "LogFileName": "error/mysql-error-running.log"
        },
        {
            "Size": 2683,
            "LastWritten": 1532994300000,
            "LogFileName": "error/mysql-error-running.log.0"
        },
        {
            "Size": 107,
            "LastWritten": 1533057300000,
            "LogFileName": "error/mysql-error-running.log.18"
        },
        {
            "Size": 13105,
            "LastWritten": 1532991000000,
            "LogFileName": "error/mysql-error-running.log.23"
        },
        {
            "Size": 0,
            "LastWritten": 1533061200000,
            "LogFileName": "error/mysql-error.log"
        },
        {
            "Size": 3519,
            "LastWritten": 1532989252000,
            "LogFileName": "mysqlUpgrade"
        }
    ]
}

  • Para ver detalhes da API, consulte DescribeDbLogFiles em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-db-parameter-groups.

AWS CLI

Como descrever um grupo de parâmetros de banco de dados

O exemplo de describe-db-parameter-groups a seguir recupera detalhes sobre os grupos de parâmetros de banco de dados.

aws rds describe-db-parameter-groups

Saída:

{
    "DBParameterGroups": [
        {
            "DBParameterGroupName": "default.aurora-mysql5.7",
            "DBParameterGroupFamily": "aurora-mysql5.7",
            "Description": "Default parameter group for aurora-mysql5.7",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7"
        },
        {
            "DBParameterGroupName": "default.aurora-postgresql9.6",
            "DBParameterGroupFamily": "aurora-postgresql9.6",
            "Description": "Default parameter group for aurora-postgresql9.6",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6"
        },
        {
            "DBParameterGroupName": "default.aurora5.6",
            "DBParameterGroupFamily": "aurora5.6",
            "Description": "Default parameter group for aurora5.6",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6"
        },
        {
            "DBParameterGroupName": "default.mariadb10.1",
            "DBParameterGroupFamily": "mariadb10.1",
            "Description": "Default parameter group for mariadb10.1",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1"
        },
        ...some output truncated...
    ]
}

Para obter mais informações, consulte Como trabalhar com grupos de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-db-parameters.

AWS CLI

Como descrever os parâmetros de um grupo de parâmetros de banco de dados

O exemplo de describe-db-parameters a seguir recupera detalhes sobre o grupo de parâmetros de banco de dados especificado.

aws rds describe-db-parameters \
    --db-parameter-group-name mydbpg

Saída:

{
    "Parameters": [
        {
            "ParameterName": "allow-suspicious-udfs",
            "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
            "Source": "engine-default",
            "ApplyType": "static",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": false,
            "ApplyMethod": "pending-reboot"
        },
        {
            "ParameterName": "auto_generate_certs",
            "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.",
            "Source": "engine-default",
            "ApplyType": "static",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": false,
            "ApplyMethod": "pending-reboot"
        },
        ...some output truncated...
    ]
}

Para obter mais informações, consulte Como trabalhar com grupos de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-db-proxies.

AWS CLI

Descrever um proxy de banco de dados para um banco de dados do RDS

O exemplo describe-db-proxies a seguir retorna informações sobre proxy de banco de dados.

aws rds describe-db-proxies

Saída:

{
    "DBProxies": [
        {
            "DBProxyName": "proxyExample1",
            "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
            "Status": "available",
            "EngineFamily": "PostgreSQL",
            "VpcId": "vpc-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Auth": "[
                {
                    "Description": "proxydescription1"
                    "AuthScheme": "SECRETS",
                    "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",
                    "IAMAuth": "DISABLED"
                }
            ]",
            "RoleArn": "arn:aws:iam::12345678912??:role/ProxyPostgreSQLRole",
            "Endpoint": "proxyExample1.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "RequireTLS": false,
            "IdleClientTimeout": 1800,
            "DebuggingLogging": false,
            "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
            "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
        },
        {
            "DBProxyName": "proxyExample2",
            "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-1234a12b23456c1ab",
            "Status": "available",
            "EngineFamily": "PostgreSQL",
            "VpcId": "sg-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Auth": "[
                {
                    "Description": "proxydescription2"
                    "AuthScheme": "SECRETS",
                    "SecretArn": "aarn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",
                    "IAMAuth": "DISABLED"
                }
            ]",
            "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole",
            "Endpoint": "proxyExample2.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "RequireTLS": false,
            "IdleClientTimeout": 1800,
            "DebuggingLogging": false,
            "CreatedDate": "2022-01-05T16:19:33.452000+00:00",
            "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
        }
    ]
}

Para obter mais informações, consulte Visualizar um proxy do RDS no Guia do usuário do Amazon RDS e Visualizar um proxy do RDS no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte DescribeDbProxies em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-db-proxy-endpoints.

AWS CLI

Descrever os endpoints de um proxy de banco de dados

O exemplo describe-db-proxy-endpoints a seguir retorna informações sobre endpoints de proxy de banco de dados.

aws rds describe-db-proxy-endpoints

Saída:

{
    "DBProxyEndpoints": [
        {
            "DBProxyEndpointName": "proxyEndpoint1",
            "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
            "DBProxyName": "proxyExample",
            "Status": "available",
            "VpcId": "vpc-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Endpoint": "proxyEndpoint1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
            "TargetRole": "READ_WRITE",
            "IsDefault": false
        },
        {
            "DBProxyEndpointName": "proxyEndpoint2",
            "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-4567a01b12345c0ab",
            "DBProxyName": "proxyExample2",
            "Status": "available",
            "VpcId": "vpc1234567",
            "VpcSecurityGroupIds": [
                "sg-5678"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Endpoint": "proxyEndpoint2.endpoint.proxy-cd1ef2klmnop.us-east-1.rds.amazonaws.com",
            "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
            "TargetRole": "READ_WRITE",
            "IsDefault": false
        }
    ]
}

Para obter mais informações, consulte Visualizar um endpoint de proxy no Guia do usuário do Amazon RDS e Criar um endpoint de proxy no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-proxy-target-groups.

AWS CLI

Descrever os endpoints de um proxy de banco de dados

O exemplo describe-db-proxy-target-groups a seguir retorna informações sobre grupos de destino de proxy de banco de dados.

aws rds describe-db-proxy-target-groups \
    --db-proxy-name proxyExample

Saída:

{
"TargetGroups":
    {
        "DBProxyName": "proxyExample",
        "TargetGroupName": "default",
        "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab",
        "IsDefault": true,
        "Status": "available",
        "ConnectionPoolConfig": {
            "MaxConnectionsPercent": 100,
            "MaxIdleConnectionsPercent": 50,
            "ConnectionBorrowTimeout": 120,
            "SessionPinningFilters": []
        },
        "CreatedDate": "2023-05-02T18:41:19.495000+00:00",
        "UpdatedDate": "2023-05-02T18:41:21.762000+00:00"
    }
}

Para obter mais informações, consulte Visualizar um proxy do RDS no Guia do usuário do Amazon RDS e Visualizar um proxy do RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-proxy-targets.

AWS CLI

Descrever os alvos do proxy do banco de dados

O exemplo describe-db-proxy-targets a seguir retorna informações sobre destinos do proxy do banco de dados.

aws rds describe-db-proxy-targets \
    --db-proxy-name proxyExample

Saída:

{
    "Targets": [
        {
            "Endpoint": "database1.ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "TrackedClusterId": "database1",
            "RdsResourceId": "database1-instance-1",
            "Port": 3306,
            "Type": "RDS_INSTANCE",
            "Role": "READ_WRITE",
            "TargetHealth": {
                "State": "UNAVAILABLE",
                "Reason": "PENDING_PROXY_CAPACITY",
                "Description": "DBProxy Target is waiting for proxy to scale to desired capacity"
            }
        }
    ]
}

Para obter mais informações, consulte Visualizar um proxy do RDS no Guia do usuário do Amazon RDS e Visualizar um proxy do RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-recommendations.

AWS CLI

Exemplo 1: listar todas as recomendações de banco de dados

O exemplo describe-db-recommendations a seguir lista todas as recomendações de banco de dados em sua conta da AWS.

aws rds describe-db-recommendations

Saída:

{
    "DBRecommendations": [
        {
            "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm",
            "TypeId": "config_recommendation::old_minor_version",
            "Severity": "informational",
            "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1",
            "Status": "active",
            "CreatedTime": "2024-02-21T23:14:19.292000+00:00",
            "UpdatedTime": "2024-02-21T23:14:19+00:00",
            "Detection": "**[resource-name]** is not running the latest minor DB engine version",
            "Recommendation": "Upgrade to latest engine version",
            "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.",
            "RecommendedActions": [
                {
                    "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678",
                    "Operation": "modifyDbInstance",
                    "Parameters": [
                        {
                            "Key": "EngineVersion",
                            "Value": "5.7.44"
                        },
                        {
                            "Key": "DBInstanceIdentifier",
                            "Value": "database-1"
                        }
                    ],
                    "ApplyModes": [
                        "immediately",
                        "next-maintenance-window"
                    ],
                    "Status": "ready",
                    "ContextAttributes": [
                        {
                            "Key": "Recommended value",
                            "Value": "5.7.44"
                        },
                        {
                            "Key": "Current engine version",
                            "Value": "5.7.42"
                        }
                    ]
                }
            ],
            "Category": "security",
            "Source": "RDS",
            "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version",
            "TypeRecommendation": "Upgrade to latest engine version",
            "Impact": "Reduced database performance and data security at risk",
            "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.",
            "Links": [
                {
                    "Text": "Upgrading an RDS DB instance engine version",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html"
                },
                {
                    "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html"
                },
                {
                    "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon RDS e Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon Aurora.

Exemplo 2: listar recomendações de banco de dados de alta severidade

O exemplo describe-db-recommendations a seguir lista recomendações de banco de dados de alta severidade em sua conta da AWS.

aws rds describe-db-recommendations \
    --filters Name=severity,Values=high

Saída:

{
    "DBRecommendations": [
        {
            "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm",
            "TypeId": "config_recommendation::rds_extended_support",
            "Severity": "high",
            "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1",
            "Status": "active",
            "CreatedTime": "2024-02-21T23:14:19.392000+00:00",
            "UpdatedTime": "2024-02-21T23:14:19+00:00",
            "Detection": "Your databases will be auto-enrolled to RDS Extended Support on February 29",
            "Recommendation": "Upgrade your major version before February 29, 2024 to avoid additional charges",
            "Description": "Your PostgreSQL 11 and MySQL 5.7 databases will be automatically enrolled into RDS Extended Support on February 29, 2024. To avoid the increase in charges due to RDS Extended Support, we recommend upgrading your databases to a newer major engine version before February 29, 2024.\nTo learn more about the RDS Extended Support pricing, refer to the pricing page.",
            "RecommendedActions": [
                {
                    "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678",
                    "Parameters": [],
                    "ApplyModes": [
                        "manual"
                    ],
                    "Status": "ready",
                    "ContextAttributes": []
                }
            ],
            "Category": "cost optimization",
            "Source": "RDS",
            "TypeDetection": "Your database will be auto-enrolled to RDS Extended Support on February 29",
            "TypeRecommendation": "Upgrade your major version before February 29, 2024 to avoid additional charges",
            "Impact": "Increase in charges due to RDS Extended Support",
            "AdditionalInfo": "With Amazon RDS Extended Support, you can continue running your database on a major engine version past the RDS end of standard support date for an additional cost. This paid feature gives you more time to upgrade to a supported major engine version.\nDuring Extended Support, Amazon RDS will supply critical CVE patches and bug fixes.",
            "Links": [
                {
                    "Text": "Amazon RDS Extended Support pricing for RDS for MySQL",
                    "Url": "https://aws.amazon.com/rds/mysql/pricing/"
                },
                {
                    "Text": "Amazon RDS Extended Support for RDS for MySQL and PostgreSQL databases",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html"
                },
                {
                    "Text": "Amazon RDS Extended Support pricing for Amazon Aurora PostgreSQL",
                    "Url": "https://aws.amazon.com/rds/aurora/pricing/"
                },
                {
                    "Text": "Amazon RDS Extended Support for Aurora PostgreSQL databases",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html"
                },
                {
                    "Text": "Amazon RDS Extended Support pricing for RDS for PostgreSQL",
                    "Url": "https://aws.amazon.com/rds/postgresql/pricing/"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon RDS e Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon Aurora.

Exemplo 3: listar recomendações de banco de dados para uma instância de banco de dados especificada

O exemplo describe-db-recommendations a seguir lista todas as recomendações de banco de dados para uma instância de banco de dados especificada.

aws rds describe-db-recommendations \
    --filters Name=dbi-resource-id,Values=database-1

Saída:

{
    "DBRecommendations": [
        {
            "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm",
            "TypeId": "config_recommendation::old_minor_version",
            "Severity": "informational",
            "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1",
            "Status": "active",
            "CreatedTime": "2024-02-21T23:14:19.292000+00:00",
            "UpdatedTime": "2024-02-21T23:14:19+00:00",
            "Detection": "**[resource-name]** is not running the latest minor DB engine version",
            "Recommendation": "Upgrade to latest engine version",
            "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.",
            "RecommendedActions": [
                {
                    "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678",
                    "Operation": "modifyDbInstance",
                    "Parameters": [
                        {
                            "Key": "EngineVersion",
                            "Value": "5.7.44"
                        },
                        {
                            "Key": "DBInstanceIdentifier",
                            "Value": "database-1"
                        }
                    ],
                    "ApplyModes": [
                        "immediately",
                        "next-maintenance-window"
                    ],
                    "Status": "ready",
                    "ContextAttributes": [
                        {
                            "Key": "Recommended value",
                            "Value": "5.7.44"
                        },
                        {
                            "Key": "Current engine version",
                            "Value": "5.7.42"
                        }
                    ]
                }
            ],
            "Category": "security",
            "Source": "RDS",
            "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version",
            "TypeRecommendation": "Upgrade to latest engine version",
            "Impact": "Reduced database performance and data security at risk",
            "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.",
            "Links": [
                {
                    "Text": "Upgrading an RDS DB instance engine version",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html"
                },
                {
                    "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html"
                },
                {
                    "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon RDS e Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon Aurora.

Exemplo 4: listar todas as recomendações ativas do banco de dados

O exemplo describe-db-recommendations a seguir lista todas as recomendações ativas de banco de dados em sua conta da AWS.

aws rds describe-db-recommendations \
    --filters Name=status,Values=active

Saída:

{
    "DBRecommendations": [
        {
            "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm",
            "TypeId": "config_recommendation::old_minor_version",
            "Severity": "informational",
            "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1",
            "Status": "active",
            "CreatedTime": "2024-02-21T23:14:19.292000+00:00",
            "UpdatedTime": "2024-02-21T23:14:19+00:00",
            "Detection": "**[resource-name]** is not running the latest minor DB engine version",
            "Recommendation": "Upgrade to latest engine version",
            "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.",
            "RecommendedActions": [
                {
                    "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678",
                    "Operation": "modifyDbInstance",
                    "Parameters": [
                        {
                            "Key": "EngineVersion",
                            "Value": "5.7.44"
                        },
                        {
                            "Key": "DBInstanceIdentifier",
                            "Value": "database-1"
                        }
                    ],
                    "ApplyModes": [
                        "immediately",
                        "next-maintenance-window"
                    ],
                    "Status": "ready",
                    "ContextAttributes": [
                        {
                            "Key": "Recommended value",
                            "Value": "5.7.44"
                        },
                        {
                            "Key": "Current engine version",
                            "Value": "5.7.42"
                        }
                    ]
                }
            ],
            "Category": "security",
            "Source": "RDS",
            "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version",
            "TypeRecommendation": "Upgrade to latest engine version",
            "Impact": "Reduced database performance and data security at risk",
            "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.",
            "Links": [
                {
                    "Text": "Upgrading an RDS DB instance engine version",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html"
                },
                {
                    "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html"
                },
                {
                    "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS",
                    "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon RDS e Visualizar e responder às recomendações do Amazon RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-security-groups.

AWS CLI

Listar grupos de segurança de banco de dados

O exemplo describe-db-security-groups a seguir lista os grupos de segurança do banco de dados.

aws rds describe-db-security-groups

Saída:

{
    "DBSecurityGroups": [
        {
            "OwnerId": "123456789012",
            "DBSecurityGroupName": "default",
            "DBSecurityGroupDescription": "default",
            "EC2SecurityGroups": [],
            "IPRanges": [],
            "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:default"
        },
        {
            "OwnerId": "123456789012",
            "DBSecurityGroupName": "mysecgroup",
            "DBSecurityGroupDescription": "My Test Security Group",
            "VpcId": "vpc-1234567f",
            "EC2SecurityGroups": [],
            "IPRanges": [],
            "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:mysecgroup"
        }
    ]
}

Para obter mais informações, consulte Listar grupos de segurança disponíveis do banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-db-shard-groups.

AWS CLI

Exemplo 1: descrever grupos de fragmentos de banco de dados

O exemplo describe-db-shard-groups a seguir recupera detalhes dos grupos de fragmentos de banco de dados.

aws rds describe-db-shard-groups

Saída:

{
    "DBShardGroups": [
        {
            "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example",
            "DBShardGroupIdentifier": "limitless-test-shard-grp",
            "DBClusterIdentifier": "limitless-test-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": true,
            "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        },
        {
            "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
            "DBShardGroupIdentifier": "my-db-shard-group",
            "DBClusterIdentifier": "my-sv2-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": false,
            "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        }
    ]
}

Para obter mais informações, consulte Clusters de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-db-snapshot-attributes.

AWS CLI

Descrever os nomes e valores dos atributos de um snapshot de banco de dados

O exemplo describe-db-snapshot-attributes a seguir descreve os nomes e valores de atributos de m snapshot de banco de dados.

aws rds describe-db-snapshot-attributes \
    --db-snapshot-identifier mydbsnapshot

Saída:

{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789012",
                    "210987654321"
                ]
            }
        ]
    }
}

Para obter mais informações, consulte Compartilhar um snapshot de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-db-snapshots.

AWS CLI

Exemplo 1: como descrever um snapshot de banco de dados de uma instância de banco de dados

O exemplo de describe-db-snapshots a seguir recupera os detalhes de um snapshot de banco de dados para uma instância de banco de dados.

aws rds describe-db-snapshots \
    --db-snapshot-identifier mydbsnapshot

Saída:

{
    "DBSnapshots": [
        {
            "DBSnapshotIdentifier": "mydbsnapshot",
            "DBInstanceIdentifier": "mysqldb",
            "SnapshotCreateTime": "2018-02-08T22:28:08.598Z",
            "Engine": "mysql",
            "AllocatedStorage": 20,
            "Status": "available",
            "Port": 3306,
            "AvailabilityZone": "us-east-1f",
            "VpcId": "vpc-6594f31c",
            "InstanceCreateTime": "2018-02-08T22:24:55.973Z",
            "MasterUsername": "mysqladmin",
            "EngineVersion": "5.6.37",
            "LicenseModel": "general-public-license",
            "SnapshotType": "manual",
            "OptionGroupName": "default:mysql-5-6",
            "PercentProgress": 100,
            "StorageType": "gp2",
            "Encrypted": false,
            "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
            "IAMDatabaseAuthenticationEnabled": false,
            "ProcessorFeatures": [],
            "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE"
        }
    ]
}

Para obter mais informações, consulte Criar um snapshot de banco de dados no Guia do usuário do Amazon RDS.

Exemplo 2: como encontrar o número de snapshots manuais criados

O exemplo de describe-db-snapshots a seguir usa o operador length na opção --query para retornar o número de snapshots manuais que foram criados em uma determinada região da AWS.

aws rds describe-db-snapshots \
    --snapshot-type manual \
    --query "length(*[].{DBSnapshots:SnapshotType})" \
    --region eu-central-1

Saída:

35

Para obter mais informações, consulte Criar um snapshot de banco de dados no Guia do usuário do Amazon RDS.

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

O código de exemplo a seguir mostra como usar describe-db-subnet-groups.

AWS CLI

Descrever um grupo de sub-redes de banco de dados

O exemplo describe-db-subnet-groups a seguir recupera detalhes do grupo de sub-redes de banco de dados especificado.

aws rds describe-db-subnet-groups

Saída:

{
    "DBSubnetGroups": [
        {
            "DBSubnetGroupName": "mydbsubnetgroup",
            "DBSubnetGroupDescription": "My DB Subnet Group",
            "VpcId": "vpc-971c12ee",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-d8c8e7f4",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-718fdc7d",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1f"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-cbc8e7e7",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-0ccde220",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                }
            ],
            "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup"
        }
    ]
}

Para obter mais informações, consulte Nuvem privada virtual (VPC) da Amazon e Amazon RDS no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-engine-default-cluster-parameters.

AWS CLI

Descrever informações sobre o mecanismo padrão e parâmetros do sistema do mecanismo de banco de dados do Aurora

O exemplo describe-engine-default-cluster-parameters a seguir recupera os detalhes do mecanismo padrão e as informações dos parâmetros do sistema para clusters de banco de dados do Aurora compatíveis com o MySQL 5.7.

aws rds describe-engine-default-cluster-parameters \
    --db-parameter-group-family aurora-mysql5.7

Saída:

{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "aurora_load_from_s3_role",
                "Description": "IAM role ARN used to load data from AWS S3",
                "Source": "engine-default",
                "ApplyType": "dynamic",
                "DataType": "string",
                "IsModifiable": true,
                "SupportedEngineModes": [
                    "provisioned"
                ]
            },
            ...some output truncated...
        ]
    }
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-engine-default-parameters.

AWS CLI

Para descrever informações sobre o mecanismo padrão e parâmetros do sistema para o mecanismo de banco de dados

O exemplo describe-engine-default-parameters a seguir recupera os detalhes do mecanismo padrão e informações sobre parâmetros do sistema para instâncias de banco de dados MySQL 5.7.

aws rds describe-engine-default-parameters \
    --db-parameter-group-family mysql5.7

Saída:

{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "allow-suspicious-udfs",
                "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
                "Source": "engine-default",
                "ApplyType": "static",
                "DataType": "boolean",
                "AllowedValues": "0,1",
                "IsModifiable": false
            },
            ...some output truncated...
        ]
    }
}

Para obter mais informações, consulte Como trabalhar com grupos de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-event-categories.

AWS CLI

Para descrever categorias de eventos

O exemplo describe-event-categories a seguir recupera detalhes sobre as categorias de eventos para todas as fontes de eventos disponíveis.

aws rds describe-event-categories

Saída:

{
    "EventCategoriesMapList": [
        {
            "SourceType": "db-instance",
            "EventCategories": [
                "deletion",
                "read replica",
                "failover",
                "restoration",
                "maintenance",
                "low storage",
                "configuration change",
                "backup",
                "creation",
                "availability",
                "recovery",
                "failure",
                "backtrack",
                "notification"
            ]
        },
        {
            "SourceType": "db-security-group",
            "EventCategories": [
                "configuration change",
                "failure"
            ]
        },
        {
            "SourceType": "db-parameter-group",
            "EventCategories": [
                "configuration change"
            ]
        },
        {
            "SourceType": "db-snapshot",
            "EventCategories": [
                "deletion",
                "creation",
                "restoration",
                "notification"
            ]
        },
        {
            "SourceType": "db-cluster",
            "EventCategories": [
                "failover",
                "failure",
                "notification"
            ]
        },
        {
            "SourceType": "db-cluster-snapshot",
            "EventCategories": [
                "backup"
            ]
        }
    ]
}

O código de exemplo a seguir mostra como usar describe-event-subscriptions.

AWS CLI

Para descrever assinaturas de eventos

Este exemplo descreve todas as assinaturas de eventos do Amazon RDS para a conta da AWS atual.

aws rds describe-event-subscriptions

Saída:

{
    "EventSubscriptionsList": [
        {
            "EventCategoriesList": [
                "backup",
                "recovery"
            ],
            "Enabled": true,
            "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
            "Status": "creating",
            "SourceType": "db-instance",
            "CustomerAwsId": "123456789012",
            "SubscriptionCreationTime": "2018-07-31 23:22:01.893",
            "CustSubscriptionId": "my-instance-events",
            "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events"
        },
        ...some output truncated...
    ]
}

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

AWS CLI

Para descrever eventos

O exemplo describe-events a seguir recupera detalhes dos eventos que ocorreram para a instância de banco de dados especificada.

aws rds describe-events \
    --source-identifier test-instance \
    --source-type db-instance

Saída:

{
    "Events": [
        {
            "SourceType": "db-instance",
            "SourceIdentifier": "test-instance",
            "EventCategories": [
                "backup"
            ],
            "Message": "Backing up DB instance",
            "Date": "2018-07-31T23:09:23.983Z",
            "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance"
        },
        {
            "SourceType": "db-instance",
            "SourceIdentifier": "test-instance",
            "EventCategories": [
                "backup"
            ],
            "Message": "Finished DB Instance backup",
            "Date": "2018-07-31T23:15:13.049Z",
            "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance"
        }
    ]
}

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

O código de exemplo a seguir mostra como usar describe-export-tasks.

AWS CLI

Descrever tarefas de exportação de snapshots

O exemplo describe-export-tasks a seguir retorna informações sobre exportações de snapshots para o Amazon S3.

aws rds describe-export-tasks

Saída:

{
    "ExportTasks": [
        {
            "ExportTaskIdentifier": "test-snapshot-export",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot",
            "SnapshotTime": "2020-03-02T18:26:28.163Z",
            "TaskStartTime": "2020-03-02T18:57:56.896Z",
            "TaskEndTime": "2020-03-02T19:10:31.985Z",
            "S3Bucket": "amzn-s3-demo-bucket",
            "S3Prefix": "",
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
            "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
            "Status": "COMPLETE",
            "PercentProgress": 100,
            "TotalExtractedDataInGB": 0
        },
        {
            "ExportTaskIdentifier": "my-s3-export",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
            "SnapshotTime": "2020-03-27T20:48:42.023Z",
            "S3Bucket": "amzn-s3-demo-bucket",
            "S3Prefix": "",
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
            "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
            "Status": "STARTING",
            "PercentProgress": 0,
            "TotalExtractedDataInGB": 0
        }
    ]
}

Para obter mais informações, consulte Monitorar exportações de snapshots no Guia do usuário do Amazon RDS.

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

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

AWS CLI

Descrever clusters de banco de dados globais

O exemplo describe-global-clusters a seguir lista os clusters de banco de dados globais do Aurora na região da AWS atual.

aws rds describe-global-clusters

Saída:

{
    "GlobalClusters": [
        {
            "GlobalClusterIdentifier": "myglobalcluster",
            "GlobalClusterResourceId": "cluster-f5982077e3b5aabb",
            "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
            "Status": "available",
            "Engine": "aurora-mysql",
            "EngineVersion": "5.7.mysql_aurora.2.07.2",
            "StorageEncrypted": false,
            "DeletionProtection": false,
            "GlobalClusterMembers": []
        }
    ]
}

Para obter mais informações, consulte Gerenciar um banco de dados global do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar describe-option-group-options.

AWS CLI

Descrever todas as opções disponíveis

O exemplo describe-option-group-options a seguir lista duas opções para uma instância do Oracle Database 19c.

aws rds describe-option-group-options \
    --engine-name oracle-ee \
    --major-engine-version 19 \
    --max-items 2

Saída:

{
    "OptionGroupOptions": [
        {
            "Name": "APEX",
            "Description": "Oracle Application Express Runtime Environment",
            "EngineName": "oracle-ee",
            "MajorEngineVersion": "19",
            "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1",
            "PortRequired": false,
            "OptionsDependedOn": [],
            "OptionsConflictsWith": [],
            "Persistent": false,
            "Permanent": false,
            "RequiresAutoMinorEngineVersionUpgrade": false,
            "VpcOnly": false,
            "SupportsOptionVersionDowngrade": false,
            "OptionGroupOptionSettings": [],
            "OptionGroupOptionVersions": [
                {
                    "Version": "19.1.v1",
                    "IsDefault": true
                },
                {
                    "Version": "19.2.v1",
                    "IsDefault": false
                }
            ]
        },
        {
            "Name": "APEX-DEV",
            "Description": "Oracle Application Express Development Environment",
            "EngineName": "oracle-ee",
            "MajorEngineVersion": "19",
            "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1",
            "PortRequired": false,
            "OptionsDependedOn": [
                "APEX"
            ],
            "OptionsConflictsWith": [],
            "Persistent": false,
            "Permanent": false,
            "RequiresAutoMinorEngineVersionUpgrade": false,
            "VpcOnly": false,
            "OptionGroupOptionSettings": []
        }
    ],
    "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

Para obter mais informações, consulte Listar opções e configurações de opção para um grupo de opções no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-option-groups.

AWS CLI

Descrever os grupos de opções disponíveis

O exemplo describe-option-groups a seguir lista os grupos de opções para uma instância do Oracle Database 19c.

aws rds describe-option-groups \
    --engine-name oracle-ee \
    --major-engine-version 19

Saída:

{
    "OptionGroupsList": [
        {
            "OptionGroupName": "default:oracle-ee-19",
            "OptionGroupDescription": "Default option group for oracle-ee 19",
            "EngineName": "oracle-ee",
            "MajorEngineVersion": "19",
            "Options": [],
            "AllowsVpcAndNonVpcInstanceMemberships": true,
            "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19"
        }
    ]
}

Para obter mais informações, consulte Listar opções e configurações de opção para um grupo de opções no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-orderable-db-instance-options.

AWS CLI

Como descrever as opções de instância solicitável do banco de dados

O exemplo de describe-orderable-db-instance-options a seguir recupera detalhes sobre as opções que podem ser solicitadas em uma instância de banco de dados que executa o mecanismo de banco de dados do MySQL.

aws rds describe-orderable-db-instance-options \
    --engine mysql

Saída:

{
    "OrderableDBInstanceOptions": [
        {
            "MinStorageSize": 5,
            "ReadReplicaCapable": true,
            "MaxStorageSize": 6144,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
            ],
            "SupportsIops": false,
            "AvailableProcessorFeatures": [],
            "MultiAZCapable": true,
            "DBInstanceClass": "db.m1.large",
            "Vpc": true,
            "StorageType": "gp2",
            "LicenseModel": "general-public-license",
            "EngineVersion": "5.5.46",
            "SupportsStorageEncryption": false,
            "SupportsEnhancedMonitoring": true,
            "Engine": "mysql",
            "SupportsIAMDatabaseAuthentication": false,
            "SupportsPerformanceInsights": false
        }
    ]
    ...some output truncated...
}

O código de exemplo a seguir mostra como usar describe-pending-maintenance-actions.

AWS CLI

Para listar recursos com pelo menos uma ação de manutenção pendente

O exemplo describe-pending-maintenance-actions a seguir lista a ação de manutenção pendente para uma instância de banco de dados.

aws rds describe-pending-maintenance-actions

Saída:

{
    "PendingMaintenanceActions": [
        {
            "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1",
            "PendingMaintenanceActionDetails": [
                {
                    "Action": "system-update",
                    "Description": "Upgrade to Aurora PostgreSQL 2.4.2"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte Gerenciar uma instância de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-reserved-db-instances-offerings.

AWS CLI

Descrever ofertas de instâncias de banco de dados reservadas

O exemplo describe-reserved-db-instances-offerings a seguir recupera detalhes sobre as opções de instância de banco de dados reservada paraoracle.

aws rds describe-reserved-db-instances-offerings \
    --product-description oracle

Saída:

{
    "ReservedDBInstancesOfferings": [
        {
            "CurrencyCode": "USD",
            "UsagePrice": 0.0,
            "ProductDescription": "oracle-se2(li)",
            "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8",
            "MultiAZ": true,
            "DBInstanceClass": "db.m4.xlarge",
            "OfferingType": "Partial Upfront",
            "RecurringCharges": [
                {
                    "RecurringChargeAmount": 0.594,
                    "RecurringChargeFrequency": "Hourly"
                }
            ],
            "FixedPrice": 4089.0,
            "Duration": 31536000
        },
    ...some output truncated...
}

O código de exemplo a seguir mostra como usar describe-reserved-db-instances.

AWS CLI

Descrever instâncias de banco de dados reservadas

O exemplo describe-reserved-db-instances a seguir recupera detalhes sobre todas as instâncias de banco de dados reservadas na conta da AWS atual.

aws rds describe-reserved-db-instances

Saída:

{
    "ReservedDBInstances": [
        {
            "ReservedDBInstanceId": "myreservedinstance",
            "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456",
            "DBInstanceClass": "db.t3.micro",
            "StartTime": "2020-06-01T13:44:21.436Z",
            "Duration": 31536000,
            "FixedPrice": 0.0,
            "UsagePrice": 0.0,
            "CurrencyCode": "USD",
            "DBInstanceCount": 1,
            "ProductDescription": "sqlserver-ex(li)",
            "OfferingType": "No Upfront",
            "MultiAZ": false,
            "State": "payment-pending",
            "RecurringCharges": [
                {
                    "RecurringChargeAmount": 0.014,
                    "RecurringChargeFrequency": "Hourly"
                }
            ],
            "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance",
            "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666"
        }
    ]
}

Para obter mais informações, consulte Instâncias de banco de dados reservadas do Amazon RDS no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-source-regions.

AWS CLI

Descrever as regiões de origem

O exemplo describe-source-regions a seguir recupera detalhes sobre todas as regiões de origem da AWS. Também mostra que os backups automatizados podem ser replicados somente do Oeste dos EUA (Oregon) para a região da AWS de destino, Leste dos EUA (N. da Virgínia).

aws rds describe-source-regions \
    --region us-east-1

Saída:

{
    "SourceRegions": [
        {
            "RegionName": "af-south-1",
            "Endpoint": "https://rds.af-south-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "ap-east-1",
            "Endpoint": "https://rds.ap-east-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "ap-northeast-1",
            "Endpoint": "https://rds.ap-northeast-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "ap-northeast-2",
            "Endpoint": "https://rds.ap-northeast-2.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "ap-northeast-3",
            "Endpoint": "https://rds.ap-northeast-3.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "ap-south-1",
            "Endpoint": "https://rds.ap-south-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "ap-southeast-1",
            "Endpoint": "https://rds.ap-southeast-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "ap-southeast-2",
            "Endpoint": "https://rds.ap-southeast-2.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "ap-southeast-3",
            "Endpoint": "https://rds.ap-southeast-3.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "ca-central-1",
            "Endpoint": "https://rds.ca-central-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "eu-north-1",
            "Endpoint": "https://rds.eu-north-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "eu-south-1",
            "Endpoint": "https://rds.eu-south-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "eu-west-1",
            "Endpoint": "https://rds.eu-west-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "eu-west-2",
            "Endpoint": "https://rds.eu-west-2.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "eu-west-3",
            "Endpoint": "https://rds.eu-west-3.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "me-central-1",
             "Endpoint": "https://rds.me-central-1.amazonaws.com",
             "Status": "available",
             "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "me-south-1",
            "Endpoint": "https://rds.me-south-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": false
        },
        {
            "RegionName": "sa-east-1",
            "Endpoint": "https://rds.sa-east-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "us-east-2",
            "Endpoint": "https://rds.us-east-2.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "us-west-1",
            "Endpoint": "https://rds.us-west-1.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        },
        {
            "RegionName": "us-west-2",
           "Endpoint": "https://rds.us-west-2.amazonaws.com",
            "Status": "available",
            "SupportsDBInstanceAutomatedBackupsReplication": true
        }
    ]
}

Para obter mais informações, consulte Descobrir informações sobre backups replicados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar describe-valid-db-instance-modifications.

AWS CLI

Descrever modificações válidas para uma instância de banco de dados

O exemplo describe-valid-db-instance-modifications a seguir recupera detalhes das modificações válidas para a instância de banco de dados especificada.

aws rds describe-valid-db-instance-modifications \
    --db-instance-identifier test-instance

Saída:

{
    "ValidDBInstanceModificationsMessage": {
        "ValidProcessorFeatures": [],
        "Storage": [
            {
                "StorageSize": [
                    {
                        "Step": 1,
                        "To": 20,
                        "From": 20
                    },
                    {
                        "Step": 1,
                        "To": 6144,
                        "From": 22
                    }
                ],
                "ProvisionedIops": [
                    {
                        "Step": 1,
                        "To": 0,
                        "From": 0
                    }
                ],
                "IopsToStorageRatio": [
                    {
                        "To": 0.0,
                        "From": 0.0
                    }
                ],
                "StorageType": "gp2"
            },
            {
                "StorageSize": [
                    {
                        "Step": 1,
                        "To": 6144,
                        "From": 100
                    }
                ],
                "ProvisionedIops": [
                    {
                        "Step": 1,
                        "To": 40000,
                        "From": 1000
                    }
                ],
                "IopsToStorageRatio": [
                    {
                        "To": 50.0,
                        "From": 1.0
                    }
                ],
                "StorageType": "io1"
            },
            {
                "StorageSize": [
                    {
                        "Step": 1,
                        "To": 20,
                        "From": 20
                    },
                    {
                        "Step": 1,
                        "To": 3072,
                        "From": 22
                    }
                ],
                "ProvisionedIops": [
                    {
                        "Step": 1,
                        "To": 0,
                        "From": 0
                    }
                ],
                "IopsToStorageRatio": [
                    {
                        "To": 0.0,
                        "From": 0.0
                    }
                ],
                "StorageType": "magnetic"
            }
        ]
    }
}

O código de exemplo a seguir mostra como usar download-db-log-file-portion.

AWS CLI

Exemplo 1: como baixar a parte mais recente de um arquivo de log do banco de dados

O exemplo download-db-log-file-portion a seguir baixa somente a parte mais recente do arquivo de log, salvando-a em um arquivo local denominado tail.txt.

aws rds download-db-log-file-portion \
    --db-instance-identifier test-instance \
    --log-file-name log.txt \
    --output text > tail.txt

O arquivo salvo pode conter linhas em branco. Eles aparecem no final de cada parte do arquivo de log durante o download.

Exemplo 2: como baixar um arquivo de log de banco de dados completo

O exemplo de download-db-log-file-portion a seguir baixa o arquivo de log completo, usando o parâmetro --starting-token 0, e salva a saída em um arquivo local chamado full.txt.

aws rds download-db-log-file-portion \
    --db-instance-identifier test-instance \
    --log-file-name log.txt \
    --starting-token 0 \
    --output text > full.txt

O arquivo salvo pode conter linhas em branco. Eles aparecem no final de cada parte do arquivo de log durante o download.

O código de exemplo a seguir mostra como usar generate-auth-token.

AWS CLI

Gerar token de autenticação

O exemplo generate-db-auth-token a seguir gera um token de autenticação para uso com a autenticação do banco de dados do IAM.

aws rds generate-db-auth-token \
    --hostname aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com \
    --port 3306 \
    --region us-east-1 \
    --username jane_doe

Saída:

aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com:3306/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIESZCNJ3OEXAMPLE%2F20180731%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20180731T235209Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=5a8753ebEXAMPLEa2c724e5667797EXAMPLE9d6ec6e3f427191fa41aeEXAMPLE

  • Para ver detalhes da API, consulte GenerateAuthToken em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar generate-db-auth-token.

AWS CLI

Gerar um token de autenticação do IAM

O exemplo generate-db-auth-token a seguir gera um token de autenticação do IAM para se conectar a um banco de dados.

aws rds generate-db-auth-token \
    --hostname mydb.123456789012.us-east-1.rds.amazonaws.com \
    --port 3306 \
    --region us-east-1 \
    --username db_user

Saída:

mydb.123456789012.us-east-1.rds.amazonaws.com:3306/?Action=connect&DBUser=db_user&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIEXAMPLE%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20210123T011543Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=88987EXAMPLE1EXAMPLE2EXAMPLE3EXAMPLE4EXAMPLE5EXAMPLE6

Para obter mais informações, consulte Conectar-se à instância de banco de dados usando a autenticação do IAM no Guia do usuário do Amazon RDS e Conectar-se ao cluster de banco de dados usando a autenticação do IAM no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte GenerateDbAuthToken em Referência de comandos da AWS CLI.

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

AWS CLI

Listar todas as tags em um recurso do Amazon RDS

O exemplo list-tags-for-resource a seguir lista todas as tags em uma instância de banco de dados.

aws rds list-tags-for-resource \
    --resource-name arn:aws:rds:us-east-1:123456789012:db:orcl1

Saída:

{
    "TagList": [
        {
            "Key": "Environment",
            "Value": "test"
        },
        {
            "Key": "Name",
            "Value": "MyDatabase"
        }
    ]
}

Para obter mais informações, consulte Marcar recursos do Amazon RDS no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar modify-certificates.

AWS CLI

Substituir temporariamente o certificado SSL/TLS padrão do sistema para novas instâncias de banco de dados

O exemplo modify-certificates a seguir substitui temporariamente o certificado SSL/TLS padrão do sistema para novas instâncias de banco de dados.

aws rds modify-certificates \
    --certificate-identifier rds-ca-2019

Saída:

{
    "Certificate": {
        "CertificateIdentifier": "rds-ca-2019",
        "CertificateType": "CA",
        "Thumbprint": "EXAMPLE123456789012",
        "ValidFrom": "2019-09-19T18:16:53Z",
        "ValidTill": "2024-08-22T17:08:50Z",
        "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019",
        "CustomerOverride": true,
        "CustomerOverrideValidTill": "2024-08-22T17:08:50Z"
    }
}

Para obter mais informações, consulte Rotacionar o certificado SSL/TLS no Guia do usuário do Amazon RDS e Rotacionar o certificado SSL/TLS no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte ModifyCertificates em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar modify-current-db-cluster-capacity.

AWS CLI

Escalar a capacidade de um cluster de banco de dados do Aurora Serverless

O exemplo modify-current-db-cluster-capacity a seguir escalona para 8 a capacidade de um cluster de banco de dados do Aurora Serverless.

aws rds modify-current-db-cluster-capacity \
    --db-cluster-identifier mydbcluster \
    --capacity 8

Saída:

{
    "DBClusterIdentifier": "mydbcluster",
    "PendingCapacity": 8,
    "CurrentCapacity": 1,
    "SecondsBeforeTimeout": 300,
    "TimeoutAction": "ForceApplyCapacityChange"
}

Para obter mais informações, consulte Escalar manualmente a capacidade do cluster de banco de dados do Aurora Serverless v1 no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar modify-db-cluster-endpoint.

AWS CLI

Modificar um endpoint de cluster de banco de dados personalizado

O exemplo modify-db-cluster-endpoint a seguir modifica o endpoint do cluster de banco de dados personalizado especificado.

aws rds modify-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint \
    --static-members dbinstance1 dbinstance2 dbinstance3

Saída:

{
    "DBClusterEndpointIdentifier": "mycustomendpoint",
    "DBClusterIdentifier": "mydbcluster",
    "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
    "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
    "Status": "modifying",
    "EndpointType": "CUSTOM",
    "CustomEndpointType": "READER",
    "StaticMembers": [
        "dbinstance1",
        "dbinstance2",
        "dbinstance3"
    ],
    "ExcludedMembers": [],
    "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint"
}

Para obter mais informações, consulte Gerenciamento de conexões do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar modify-db-cluster-parameter-group.

AWS CLI

Modificar parâmetros em um grupo de parâmetros do cluster de banco de dados

O exemplo modify-db-cluster-parameter-group a seguir altera os valores dos parâmetros em um grupo de parâmetros de cluster de banco de dados.

aws rds modify-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterpg \
    --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" \
                 "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate"

Saída:

{
    "DBClusterParameterGroupName": "mydbclusterpg"
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar modify-db-cluster-snapshot-attribute.

AWS CLI

Modificar um atributo do snapshot do cluster de banco de dados

O exemplo modify-db-cluster-snapshot-attribute a seguir faz alterações no atributo de snapshot do cluster de banco de dados especificado.

aws rds modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier myclustersnapshot \
    --attribute-name restore \
    --values-to-add 123456789012

Saída:

{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotIdentifier": "myclustersnapshot",
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789012"
                ]
            }
        ]
    }
}

Para obter mais informações, consulte Restaurar a partir de um snapshot de um cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar modify-db-cluster.

AWS CLI

Exemplo 1: modificar um cluster de banco de dados

O exemplo modify-db-cluster a seguir altera a senha do usuário mestre do cluster de banco de dados denominado cluster-2 e define o período de retenção de backup para 14 dias. O parâmetro de --apply-immediately faz com que a alterações sejam imediatas em vez de ter que esperar a próxima janela de manutenção.

aws rds modify-db-cluster \
    --db-cluster-identifier cluster-2 \
    --backup-retention-period 14 \
    --master-user-password newpassword99 \
    --apply-immediately

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "eu-central-1b",
            "eu-central-1c",
            "eu-central-1a"
        ],
        "BackupRetentionPeriod": 14,
        "DatabaseName": "",
        "DBClusterIdentifier": "cluster-2",
        "DBClusterParameterGroup": "default.aurora5.6",
        "DBSubnetGroup": "default-vpc-2305ca49",
        "Status": "available",
        "EarliestRestorableTime": "2020-06-03T02:07:29.637Z",
        "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora",
        "EngineVersion": "5.6.10a",
        "LatestRestorableTime": "2020-06-04T15:11:25.748Z",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "01:55-02:25",
        "PreferredMaintenanceWindow": "thu:21:14-thu:21:44",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "cluster-2-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-20a5c047",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1RLNU0EXAMPLE",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6",
        "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2020-04-03T14:44:02.764Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": true,
        "CrossAccountClone": false,
        "DomainMemberships": []
    }
}

Para obter mais informações, consulte Modificar um cluster de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

Exemplo 2: associar um grupo de segurança VPC a um cluster de banco de dados

O exemplo modify-db-instance a seguir associa um grupo de segurança VPC específico e remove grupos de segurança de banco de dados de um cluster de banco de dados:

aws rds modify-db-cluster \
    --db-cluster-identifier dbName \
    --vpc-security-group-ids sg-ID

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "dbName",
        "DBClusterParameterGroup": "default.aurora-mysql8.0",
        "DBSubnetGroup": "default",
        "Status": "available",
        "EarliestRestorableTime": "2024-02-15T01:12:13.966000+00:00",
        "Endpoint": "dbName.cluster-abcdefghji.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "dbName.cluster-ro-abcdefghji.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-mysql",
        "EngineVersion": "8.0.mysql_aurora.3.04.1",
        "LatestRestorableTime": "2024-02-15T02:25:33.696000+00:00",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "10:59-11:29",
        "PreferredMaintenanceWindow": "thu:08:54-thu:09:24",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "dbName-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-ID",
                "Status": "active"
            }
        ],
        ...output omitted...
    }
}

Para ter mais informações, consulte Controlar acesso com grupos de segurança no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar modify-db-instance.

AWS CLI

Exemplo 1: Como modificar uma instância de banco de dados

O exemplo de modify-db-instance a seguir associa um grupo de opção e um grupo de parâmetros a uma instância de banco de dados do Microsoft SQL Server compatível. O parâmetro --apply-immediately faz com que os grupos de opção e parâmetro sejam associados imediatamente em vez de ter que esperar a próxima janela de manutenção.

aws rds modify-db-instance \
    --db-instance-identifier database-2 \
    --option-group-name test-se-2017 \
    --db-parameter-group-name test-sqlserver-se-2017 \
    --apply-immediately

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "database-2",
        "DBInstanceClass": "db.r4.large",
        "Engine": "sqlserver-se",
        "DBInstanceStatus": "available",

        ...output omitted...

        "DBParameterGroups": [
            {
                "DBParameterGroupName": "test-sqlserver-se-2017",
                "ParameterApplyStatus": "applying"
            }
        ],
        "AvailabilityZone": "us-west-2d",

        ...output omitted...

        "MultiAZ": true,
        "EngineVersion": "14.00.3281.6.v1",
        "AutoMinorVersionUpgrade": false,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "license-included",
        "OptionGroupMemberships": [
            {
                "OptionGroupName": "test-se-2017",
                "Status": "pending-apply"
            }
        ],
        "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS",
        "SecondaryAvailabilityZone": "us-west-2c",
        "PubliclyAccessible": true,
        "StorageType": "gp2",

        ...output omitted...

        "DeletionProtection": false,
        "AssociatedRoles": [],
        "MaxAllocatedStorage": 1000
    }
}

Para obter mais informações, consulte Modificar uma instância de banco de dados do Amazon RDS no Guia do usuário do Amazon RDS.

Exemplo 2: Como associar um grupo de segurança a uma instância de banco de dados

O seguinte exemplo de modify-db-instance associa um grupo de segurança da VPC específico e remove grupos de segurança de banco de dados da instância de banco de dados:

aws rds modify-db-instance \
    --db-instance-identifier dbName \
    --vpc-security-group-ids sg-ID

Saída:

{
"DBInstance": {
    "DBInstanceIdentifier": "dbName",
    "DBInstanceClass": "db.t3.micro",
    "Engine": "mysql",
    "DBInstanceStatus": "available",
    "MasterUsername": "admin",
    "Endpoint": {
        "Address": "dbName.abcdefghijk.us-west-2.rds.amazonaws.com",
        "Port": 3306,
        "HostedZoneId": "ABCDEFGHIJK1234"
    },
    "AllocatedStorage": 20,
    "InstanceCreateTime": "2024-02-15T00:37:58.793000+00:00",
    "PreferredBackupWindow": "11:57-12:27",
    "BackupRetentionPeriod": 7,
    "DBSecurityGroups": [],
    "VpcSecurityGroups": [
        {
            "VpcSecurityGroupId": "sg-ID",
            "Status": "active"
        }
    ],
    ... output omitted ...
    "MultiAZ": false,
    "EngineVersion": "8.0.35",
    "AutoMinorVersionUpgrade": true,
    "ReadReplicaDBInstanceIdentifiers": [],
    "LicenseModel": "general-public-license",

    ... output ommited ...
    }
}

Para ter mais informações, consulte Controlar acesso com grupos de segurança no Guia do usuário do Amazon RDS.

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

O código de exemplo a seguir mostra como usar modify-db-parameter-group.

AWS CLI

Como modificar um grupo de parâmetros de banco de dados

O exemplo de modify-db-parameter-group a seguir altera o valor do parâmetro clr enabled em um grupo de parâmetros de banco de dados. O parâmetro --apply-immediately faz com que o grupo de parâmetros de banco de dados seja modificado imediatamente em vez de ter que esperar a próxima janela de manutenção.

aws rds modify-db-parameter-group \
    --db-parameter-group-name test-sqlserver-se-2017 \
    --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate"

Saída:

{
    "DBParameterGroupName": "test-sqlserver-se-2017"
}

Para obter mais informações, consulte Modificar parâmetros em um grupo de parâmetros de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar modify-db-proxy-endpoint.

AWS CLI

Modificar um endpoint de proxy de banco de dados para um banco de dados do RDS

O exemplo modify-db-proxy-endpoint a seguir modifica um endpoint de proxy de banco de dados proxyEndpoint para definir o tempo limite de leitura em 65 segundos.

aws rds modify-db-proxy-endpoint \
    --db-proxy-endpoint-name proxyEndpoint \
    --cli-read-timeout 65

Saída:

{
"DBProxyEndpoint":
    {
        "DBProxyEndpointName": "proxyEndpoint",
        "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
        "DBProxyName": "proxyExample",
        "Status": "available",
        "VpcId": "vpc-1234567",
        "VpcSecurityGroupIds": [
            "sg-1234"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Endpoint": "proxyEndpoint.endpoint.proxyExample-ab0cd1efghij.us-east-1.rds.amazonaws.com",
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "TargetRole": "READ_WRITE",
        "IsDefault": "false"
    }
}

Para obter mais informações, consulte Modificar um endpoint de proxy no Guia do usuário do Amazon RDS e Modificar um endpoint de proxy no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar modify-db-proxy-target-group.

AWS CLI

Modificar os endpoints de um proxy de banco de dados

O exemplo modify-db-proxy-target-group a seguir modifica um grupo-alvo de proxy de banco de dados para definir o máximo de conexões em 80% e o máximo de conexões ociosas em 10%.

aws rds modify-db-proxy-target-group \
    --target-group-name default \
    --db-proxy-name proxyExample \
    --connection-pool-config MaxConnectionsPercent=80,MaxIdleConnectionsPercent=10

Saída:

{
"DBProxyTargetGroup":
    {
        "DBProxyName": "proxyExample",
        "TargetGroupName": "default",
        "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab",
        "IsDefault": true,
        "Status": "available",
        "ConnectionPoolConfig": {
            "MaxConnectionsPercent": 80,
            "MaxIdleConnectionsPercent": 10,
            "ConnectionBorrowTimeout": 120,
            "SessionPinningFilters": []
        },
        "CreatedDate": "2023-05-02T18:41:19.495000+00:00",
        "UpdatedDate": "2023-05-02T18:41:21.762000+00:00"
    }
}

Para obter mais informações, consulte Modificar um proxy do RDS no Guia do usuário do Amazon RDS e Modificar um proxy do RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar modify-db-proxy.

AWS CLI

Modificar um proxy de banco de dados para um banco de dados do RDS

O exemplo modify-db-proxy a seguir modifica um proxy de banco de dados denominado proxyExample para exigir SSL em suas conexões.

aws rds modify-db-proxy \
    --db-proxy-name proxyExample \
    --require-tls

Saída:

{
"DBProxy":
    {
        "DBProxyName": "proxyExample",
        "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
        "Status": "modifying"
        "EngineFamily": "PostgreSQL",
        "VpcId": "sg-1234567",
        "VpcSecurityGroupIds": [
            "sg-1234"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Auth": "[
            {
                "Description": "proxydescription1",
                "AuthScheme": "SECRETS",
                "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e",
                "IAMAuth": "DISABLED"
            }
        ]",
        "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole",
        "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
        "RequireTLS": true,
        "IdleClientTimeout": 1800,
        "DebuggingLogging": false,
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
    }
}

Para obter mais informações, consulte Modificar um proxy do RDS no Guia do usuário do Amazon RDS e Criar um proxy do RDS no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte ModifyDbProxy em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar modify-db-shard-group.

AWS CLI

Exemplo 1: modificar um grupo de fragmentos de banco de dados

O exemplo modify-db-shard-group a seguir altera a capacidade máxima de um grupo de fragmentos de banco de dados.

aws rds modify-db-shard-group \
    --db-shard-group-identifier my-db-shard-group \
    --max-acu 1000

Saída:

{
    "DBShardGroups": [
        {
            "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
            "DBShardGroupIdentifier": "my-db-shard-group",
            "DBClusterIdentifier": "my-sv2-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": false,
            "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        }
    ]
}

Para obter mais informações, consulte Clusters de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

Exemplo 2: descrever seus grupos de fragmentos de banco de dados

O exemplo describe-db-shard-groups a seguir recupera os detalhes dos seus grupos de fragmentos de banco de dados depois que você executa o comando modify-db-shard-group. Atualmente, a capacidade máxima do grupo de fragmentos de banco de dados my-db-shard-group é de 1000 unidades de capacidade do Aurora (ACUs).

aws rds describe-db-shard-groups

Saída:

{
    "DBShardGroups": [
        {
            "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example",
            "DBShardGroupIdentifier": "limitless-test-shard-grp",
            "DBClusterIdentifier": "limitless-test-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": true,
            "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        },
        {
            "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
            "DBShardGroupIdentifier": "my-db-shard-group",
            "DBClusterIdentifier": "my-sv2-cluster",
            "MaxACU": 1000.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": false,
            "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        }
    ]
}

Para obter mais informações, consulte Clusters de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte ModifyDbShardGroup em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar modify-db-snapshot-attribute.

AWS CLI

Exemplo 1: habilitar duas contas da AWS para restaurar um snapshot do banco de dados

O exemplo modify-db-snapshot-attribute a seguir concede permissão a duas contas da AWS, com os identificadores 111122223333 e 444455556666, para restaurar o snapshot denominado mydbsnapshot.

aws rds modify-db-snapshot-attribute \
    --db-snapshot-identifier mydbsnapshot \
    --attribute-name restore \
    --values-to-add {"111122223333","444455556666"}

Saída:

{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "111122223333",
                    "444455556666"
                ]
            }
        ]
    }
}

Para obter mais informações, consulte Compartilhar um snapshot no Guia do usuário do Amazon RDS.

Exemplo 2: evitar que uma conta da AWS restaure um snapshot do banco de dados

O exemplo modify-db-snapshot-attribute a seguir remove a permissão de uma conta da AWS específica para restaurar o snapshot do banco de dados denominado mydbsnapshot. Ao especificar uma única conta, o identificador da conta não pode ser delimitado por aspas ou chaves.

aws rds modify-db-snapshot-attribute \
    --db-snapshot-identifier mydbsnapshot \
    --attribute-name restore \
    --values-to-remove 444455556666

Saída:

{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "111122223333"
                ]
            }
        ]
    }
}

Para obter mais informações, consulte Compartilhar um snapshot no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar modify-db-snapshot-attributes.

AWS CLI

Para modificar um atributo de snapshot do banco de dados

O exemplo modify-db-snapshot-attribute a seguir permite que dois identificadores de contas da AWS, 111122223333 e 444455556666, restaurem o snapshot do banco de dados denominado mydbsnapshot.

aws rds modify-db-snapshot-attribute \
    --db-snapshot-identifier mydbsnapshot \
    --attribute-name restore \
    --values-to-add '["111122223333","444455556666"]'

Saída:

{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "111122223333",
                    "444455556666"
                ]
            }
        ]
    }
}

Para obter mais informações, consulte Compartilhar um snapshot no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar modify-db-snapshot.

AWS CLI

Para modificar um snapshot do banco de dados

O exemplo modify-db-snapshot a seguir atualiza um snapshot do PostgreSQL 10.6 denominado db5-snapshot-upg-test para PostgreSQL 11.7. A nova versão do mecanismo de banco de dados é exibida após a conclusão da atualização do snapshot e seu status estiver como disponível.

aws rds modify-db-snapshot \
    --db-snapshot-identifier db5-snapshot-upg-test \
    --engine-version 11.7

Saída:

{
    "DBSnapshot": {
        "DBSnapshotIdentifier": "db5-snapshot-upg-test",
        "DBInstanceIdentifier": "database-5",
        "SnapshotCreateTime": "2020-03-27T20:49:17.092Z",
        "Engine": "postgres",
        "AllocatedStorage": 20,
        "Status": "upgrading",
        "Port": 5432,
        "AvailabilityZone": "us-west-2a",
        "VpcId": "vpc-2ff27557",
        "InstanceCreateTime": "2020-03-27T19:59:04.735Z",
        "MasterUsername": "postgres",
        "EngineVersion": "10.6",
        "LicenseModel": "postgresql-license",
        "SnapshotType": "manual",
        "OptionGroupName": "default:postgres-11",
        "PercentProgress": 100,
        "StorageType": "gp2",
        "Encrypted": false,
        "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test",
        "IAMDatabaseAuthenticationEnabled": false,
        "ProcessorFeatures": [],
        "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4"
    }
}

Para obter mais informações, consulte Atualizar um snapshot de banco de dados do PostgreSQL no Guia do usuário do Amazon RDS.

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

O código de exemplo a seguir mostra como usar modify-db-subnet-group.

AWS CLI

Modificar um grupo de sub-redes do banco de dados

O exemplo modify-db-subnet-group a seguir adiciona uma sub-rede com o ID subnet-08e41f9e230222222 ao grupo de sub-redes do banco de dados denominado mysubnetgroup. Para manter as sub-redes existentes no grupo de sub-redes, inclua os IDs como valores na opção --subnet-ids. Certifique-se de ter sub-redes com pelo menos duas zonas de disponibilidade diferentes no grupo de sub-redes do banco de dados.

aws rds modify-db-subnet-group \
    --db-subnet-group-name mysubnetgroup \
    --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef","subnet-08e41f9e230222222"]'

Saída:

{
    "DBSubnetGroup": {
        "DBSubnetGroupName": "mysubnetgroup",
        "DBSubnetGroupDescription": "test DB subnet group",
        "VpcId": "vpc-0f08e7610a1b2c3d4",
        "SubnetGroupStatus": "Complete",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-08e41f9e230222222",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2a"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2b"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-00f5b198bc0abcdef",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2d"
                },
                "SubnetStatus": "Active"
            },
            {
                "SubnetIdentifier": "subnet-0a1dc4e1a6f123456",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2b"
                },
                "SubnetStatus": "Active"
            }
        ],
        "DBSubnetGroupArn": "arn:aws:rds:us-west-2:534026745191:subgrp:mysubnetgroup"
    }
}

Para obter mais informações, consulte Etapa 3: criar um grupo de sub-redes do banco de dados no Guia do usuário do Amazon RDS.

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

O código de exemplo a seguir mostra como usar modify-event-subscription.

AWS CLI

Para modificar a assinatura de um evento

O exemplo modify-event-subscription a seguir desativa a assinatura do evento especificado, de forma que não publique mais notificações para o tópico especificado do Amazon Simple Notification Service.

aws rds modify-event-subscription \
    --subscription-name my-instance-events \
    --no-enabled

Saída:

{
    "EventSubscription": {
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "CustomerAwsId": "123456789012",
        "SourceType": "db-instance",
        "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "CustSubscriptionId": "my-instance-events",
        "Status": "modifying",
        "Enabled": false
    }
}

O código de exemplo a seguir mostra como usar modify-global-cluster.

AWS CLI

Modificar um cluster de banco de dados global

O exemplo modify-global-cluster a seguir ativa a proteção contra exclusão de um cluster de banco de dados global compatível com o Aurora MySQL.

aws rds modify-global-cluster \
    --global-cluster-identifier myglobalcluster \
    --deletion-protection

Saída:

{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
        "Status": "available",
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.mysql_aurora.2.07.2",
        "StorageEncrypted": false,
        "DeletionProtection": true,
        "GlobalClusterMembers": []
    }
}

Para obter mais informações, consulte Gerenciar um banco de dados global do Amazon Aurora no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte ModifyGlobalCluster em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar promote-read-replica-db-cluster.

AWS CLI

Promover uma réplica de leitura de um cluster de banco de dados

O exemplo promote-read-replica-db-cluster a seguir promove a réplica de leitura especificada para um cluster de banco de dados autônomo.

aws rds promote-read-replica-db-cluster \
    --db-cluster-identifier mydbcluster-1

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1c"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "",
        "DBClusterIdentifier": "mydbcluster-1",
        ...some output truncated...
    }
}

Para obter mais informações, consulte Promover uma réplica de leitura para um cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar promote-read-replica.

AWS CLI

Promover uma réplica de leitura

O exemplo promote-read-replica a seguir promove a réplica de leitura especificada para uma instância de banco de dados autônoma.

aws rds promote-read-replica \
    --db-instance-identifier test-instance-repl

Saída:

{
    "DBInstance": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
        "StorageType": "standard",
        "ReadReplicaSourceDBInstanceIdentifier": "test-instance",
        "DBInstanceStatus": "modifying",
        ...some output truncated...
    }
}

  • Para ver detalhes da API, consulte PromoteReadReplica em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar purchase-reserved-db-instance.

AWS CLI

Comprar uma oferta de instância de banco de dados reservada

O exemplo purchase-reserved-db-instances-offering seguir compra uma oferta de instância de banco de dados reservada. O reserved-db-instances-offering-id deve ser um ID de oferta válido, conforme retornado pelo comando describe-reserved-db-instances-offering.

aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706

O código de exemplo a seguir mostra como usar purchase-reserved-db-instances-offerings.

AWS CLI

Exemplo 1: encontrar uma instância de banco de dados reservada para comprar

O exemplo describe-reserved-db-instances-offerings a seguir lista as instâncias de banco de dados MySQL reservadas disponíveis com a classe de instância db.t2.micro e duração de um ano. É necessário o ID da oferta para comprar uma instância de banco de dados reservada.

aws rds describe-reserved-db-instances-offerings \
    --product-description mysql \
    --db-instance-class db.t2.micro \
    --duration 1

Saída:

{
    "ReservedDBInstancesOfferings": [
        {
            "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4",
            "DBInstanceClass": "db.t2.micro",
            "Duration": 31536000,
            "FixedPrice": 51.0,
            "UsagePrice": 0.0,
            "CurrencyCode": "USD",
            "ProductDescription": "mysql",
            "OfferingType": "Partial Upfront",
            "MultiAZ": false,
            "RecurringCharges": [
                {
                    "RecurringChargeAmount": 0.006,
                    "RecurringChargeFrequency": "Hourly"
                }
            ]
        },
    ... some output truncated ...
    ]
}

Para obter mais informações, consulte Instâncias de banco de dados reservadas do Amazon RDS no Guia do usuário do Amazon RDS.

Exemplo 2: comprar uma instância de banco de dados reservada

O exemplo purchase-reserved-db-instances-offering a seguir mostra como comprar a oferta de instância de banco de dados reservada do exemplo anterior.

aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 8ba30be1-b9ec-447f-8f23-6114e3f4c7b4

Saída:

{
    "ReservedDBInstance": {
        "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670",
        "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4",
        "DBInstanceClass": "db.t2.micro",
        "StartTime": "2020-06-29T16:54:57.670Z",
        "Duration": 31536000,
        "FixedPrice": 51.0,
        "UsagePrice": 0.0,
        "CurrencyCode": "USD",
        "DBInstanceCount": 1,
        "ProductDescription": "mysql",
        "OfferingType": "Partial Upfront",
        "MultiAZ": false,
        "State": "payment-pending",
        "RecurringCharges": [
            {
                "RecurringChargeAmount": 0.006,
                "RecurringChargeFrequency": "Hourly"
            }
        ],
        "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670"
    }
}

Para obter mais informações, consulte Instâncias de banco de dados reservadas do Amazon RDS no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar reboot-db-instance.

AWS CLI

Como reinicializar uma instância de banco de dados

O exemplo de reboot-db-instance a seguir inicia uma reinicialização da instância de banco de dados especificada.

aws rds reboot-db-instance \
    --db-instance-identifier test-mysql-instance

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "test-mysql-instance",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "mysql",
        "DBInstanceStatus": "rebooting",
        "MasterUsername": "admin",
        "Endpoint": {
            "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com",
            "Port": 3306,
            "HostedZoneId": "Z1PVIF0EXAMPLE"
        },

    ... output omitted...

    }
}

Para obter mais informações, consulte Reinicializar uma instância de banco de dados no Guia do usuário do Amazon RDS.

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

O código de exemplo a seguir mostra como usar reboot-db-shard-group.

AWS CLI

Exemplo 1: reinicializar um grupo de fragmentos de banco de dados

O exemplo reboot-db-shard-group a seguir reinicializa um grupo de fragmentos de banco de dados.

aws rds reboot-db-shard-group \
    --db-shard-group-identifier my-db-shard-group

Saída:

{
    "DBShardGroups": [
        {
            "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
            "DBShardGroupIdentifier": "my-db-shard-group",
            "DBClusterIdentifier": "my-sv2-cluster",
            "MaxACU": 1000.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": false,
            "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        }
    ]
}

Para obter mais informações, consulte Reinicializar uma instância, cluster ou banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

Exemplo 2: descrever seus grupos de fragmentos de banco de dados

O exemplo describe-db-shard-groups a seguir recupera os detalhes dos seus grupos de fragmentos de banco de dados depois que você executa o comando reboot-db-shard-group. O grupo de fragmentos de banco de dados my-db-shard-group está sendo reinicializado.

aws rds describe-db-shard-groups

Saída:

{
    "DBShardGroups": [
        {
            "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example",
            "DBShardGroupIdentifier": "limitless-test-shard-grp",
            "DBClusterIdentifier": "limitless-test-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": true,
            "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        },
        {
            "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
            "DBShardGroupIdentifier": "my-db-shard-group",
            "DBClusterIdentifier": "my-sv2-cluster",
            "MaxACU": 1000.0,
            "ComputeRedundancy": 0,
            "Status": "rebooting",
            "PubliclyAccessible": false,
            "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        }
    ]
}

Para obter mais informações, consulte Reinicializar uma instância, cluster ou banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte RebootDbShardGroup em Referência de Comandos da AWS CLI.

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

AWS CLI

Registrar um proxy de banco de dados com um banco de dados

O exemplo register-db-proxy-targets a seguir cria a associação entre um banco de dados e um proxy.

aws rds register-db-proxy-targets \
    --db-proxy-name proxyExample \
    --db-cluster-identifiers database-5

Saída:

{
    "DBProxyTargets": [
        {
            "RdsResourceId": "database-5",
            "Port": 3306,
            "Type": "TRACKED_CLUSTER",
            "TargetHealth": {
                "State": "REGISTERING"
            }
        },
        {
            "Endpoint": "database-5instance-1.ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "RdsResourceId": "database-5",
            "Port": 3306,
            "Type": "RDS_INSTANCE",
            "TargetHealth": {
                "State": "REGISTERING"
            }
        }
    ]
}

Para obter mais informações, consulte Criar um proxy do RDS no Guia do usuário do Amazon RDS e Criar um proxy do RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar remove-from-global-cluster.

AWS CLI

Separar um cluster secundário do Aurora de um cluster de banco de dados global do Aurora

O exemplo remove-from-global-cluster separa um cluster secundário do Aurora de um cluster de banco de dados global do Aurora. O cluster deixa de ser somente para leitura para ser um cluster autônomo com capacidade de leitura e gravação.

aws rds remove-from-global-cluster \
    --region us-west-2 \
    --global-cluster-identifier myglobalcluster \
    --db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:DB-1

Saída:

{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-abc123def456gh",
        "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
        "Status": "available",
        "Engine": "aurora-postgresql",
        "EngineVersion": "10.11",
        "StorageEncrypted": true,
        "DeletionProtection": false,
        "GlobalClusterMembers": [
            {
                "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster",
                "Readers": [
                    "arn:aws:rds:us-west-2:123456789012:cluster:DB-1"
                ],
                "IsWriter": true
            },
            {
                "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1",
                "Readers": [],
                "IsWriter": false,
                "GlobalWriteForwardingStatus": "disabled"
            }
        ]
    }
}

Para obter mais informações, consulte Remover um cluster de um banco de dados global do Amazon Aurora no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar remove-option-from-option-group.

AWS CLI

Excluir uma opção de um grupo de opções

O exemplo remove-option-from-option-group a seguir remove a opção OEM de myoptiongroup.

aws rds remove-option-from-option-group \
    --option-group-name myoptiongroup \
    --options OEM \
    --apply-immediately

Saída:

{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Test",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "19",
        "Options": [],
        "AllowsVpcAndNonVpcInstanceMemberships": true,
        "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup"
    }
}

Para obter mais informações, consulte Remover uma opção de um grupo de opções no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar remove-role-from-db-cluster.

AWS CLI

Desassociar um perfil do Identity and Access Management (IAM) da AWS de um cluster de banco de dados

O exemplo remove-role-from-db-cluster a seguir remove um perfil de um cluster de banco de dados.

aws rds remove-role-from-db-cluster \
    --db-cluster-identifier mydbcluster \
    --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3

Este comando não produz saída.

Para obter mais informações, consulte Associar um perfil do IAM a um cluster de banco de dados do Amazon Aurora MySQL no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar remove-role-from-db-instance.

AWS CLI

Desassociar um perfil do Identity and Access Management (IAM) da AWS de uma instância de banco de dados.

O exemplo remove-role-from-db-instance a seguir remove o perfil denominado rds-s3-integration-role de uma instância de banco de dados do Oracle denominadatest-instance.

aws rds remove-role-from-db-instance \
    --db-instance-identifier test-instance \
    --feature-name S3_INTEGRATION \
    --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role

Este comando não produz saída.

Para obter mais informações, consulte Desabilitar a integração do RDS SQL Server com o S3 no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar remove-source-identifier-from-subscription.

AWS CLI

Remover um identificador de origem de uma assinatura

O exemplo remove-source-identifier a seguir remove o identificador de origem de uma assinatura existente.

aws rds remove-source-identifier-from-subscription \
    --subscription-name my-instance-events \
    --source-identifier test-instance-repl

Saída:

{
    "EventSubscription": {
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "Status": "modifying",
        "CustSubscriptionId": "my-instance-events",
        "CustomerAwsId": "123456789012",
        "SourceIdsList": [
            "test-instance"
        ],
        "SourceType": "db-instance",
        "Enabled": false
    }
}

O código de exemplo a seguir mostra como usar remove-tags-from-resource.

AWS CLI

Como remover as tags de um recurso

O exemplo remove-tags-from-resource a seguir remove as tags de um recurso.

aws rds remove-tags-from-resource \
    --resource-name arn:aws:rds:us-east-1:123456789012:db:mydbinstance \
    --tag-keys Name Environment

Este comando não produz saída.

Para obter mais informações, consulte Marcar recursos do Amazon RDS no Guia do usuário do Amazon RDS e Marcar recursos do Amazon RDS no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar reset-db-cluster-parameter-group.

AWS CLI

Exemplo 1: redefinir todos os parâmetros para os valores padrão

O exemplo reset-db-cluster-parameter-group a seguir redefine todos os valores de parâmetro em um grupo de parâmetros de banco de dados do cliente para os valores padrão.

aws rds reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclpg \
    --reset-all-parameters

Saída:

{
    "DBClusterParameterGroupName": "mydbclpg"
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

Exemplo 2: redefinir os parâmetros especificados para os valores padrão

O exemplo reset-db-cluster-parameter-group a seguir redefine os valores de parâmetro de parâmetros específicos para os valores padrão em um grupo de parâmetros de cluster de banco de dados do cliente.

aws rds reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclpgy \
    --parameters "ParameterName=max_connections,ApplyMethod=immediate" \
                 "ParameterName=max_allowed_packet,ApplyMethod=immediate"

Saída:

{
    "DBClusterParameterGroupName": "mydbclpg"
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar reset-db-parameter-group.

AWS CLI

Exemplo 1: redefinir todos os parâmetros para os valores padrão

O exemplo reset-db-parameter-group a seguir, redefine todos os valores de parâmetro em um grupo de parâmetros de banco de dados do cliente para os valores padrão.

aws rds reset-db-parameter-group \
    --db-parameter-group-name mypg \
    --reset-all-parameters

Saída:

{
    "DBParameterGroupName": "mypg"
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados no Guia do usuário do Amazon RDS e Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

Exemplo 2: redefinir os parâmetros especificados para os valores padrão

O exemplo reset-db-parameter-group a seguir redefine os valores de parâmetro de parâmetros específicos para os valores padrão em um grupo de parâmetros de banco de dados do cliente.

aws rds reset-db-parameter-group \
    --db-parameter-group-name mypg \
    --parameters "ParameterName=max_connections,ApplyMethod=immediate" \
                 "ParameterName=max_allowed_packet,ApplyMethod=immediate"

Saída:

{
    "DBParameterGroupName": "mypg"
}

Para obter mais informações, consulte Trabalhar com grupos de parâmetros de banco de dados no Guia do usuário do Amazon RDS e Trabalhar com grupos de parâmetros de banco de dados e grupos de parâmetros de cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar restore-db-cluster-from-s3.

AWS CLI

Restaurar um cluster de banco de dados do Amazon Aurora a partir do Amazon S3

O exemplo restore-db-cluster-from-s3 a seguir restaura um cluster de banco de dados compatível com Amazon Aurora MySQL versão 5.7 a partir de um arquivo de backup de banco de dados MySQL 5.7 no Amazon S3.

aws rds restore-db-cluster-from-s3 \
    --db-cluster-identifier cluster-s3-restore \
    --engine aurora-mysql \
    --master-username admin \
    --master-user-password mypassword \
    --s3-bucket-name amzn-s3-demo-bucket \
    --s3-prefix test-backup \
    --s3-ingestion-role-arn arn:aws:iam::123456789012:role/service-role/TestBackup \
    --source-engine mysql \
    --source-engine-version 5.7.28

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2a",
            "us-west-2b"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "cluster-s3-restore",
        "DBClusterParameterGroup": "default.aurora-mysql5.7",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.12",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "11:15-11:45",
        "PreferredMaintenanceWindow": "thu:12:19-thu:12:49",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1PVIF0EXAMPLE",
        "StorageEncrypted": false,
        "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2020-07-27T14:22:08.095Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false,
        "DomainMemberships": []
    }
}

Para obter mais informações, consulte Migrar dados do MySQL usando m bucket do Amazon S3 no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar restore-db-cluster-from-snapshot.

AWS CLI

Restaurar um cluster a partir de um snapshot

O exemplo restore-db-cluster-from-snapshot a seguir restaura um cluster de banco de dados do Aurora PostgreSQL compatível com o PostgreSQL versão 10.7 a partir de um snapshot de cluster de banco de dados denominado test-instance-snapshot.

aws rds restore-db-cluster-from-snapshot \
    --db-cluster-identifier newdbcluster \
    --snapshot-identifier test-instance-snapshot \
    --engine aurora-postgresql \
    --engine-version 10.7

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2a",
            "us-west-2b"
        ],
        "BackupRetentionPeriod": 7,
        "DatabaseName": "",
        "DBClusterIdentifier": "newdbcluster",
        "DBClusterParameterGroup": "default.aurora-postgresql10",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-postgresql",
        "EngineVersion": "10.7",
        "Port": 5432,
        "MasterUsername": "postgres",
        "PreferredBackupWindow": "09:33-10:03",
        "PreferredMaintenanceWindow": "sun:12:22-sun:12:52",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1PVIF0EXAMPLE",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
        "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2020-06-05T15:06:58.634Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false,
        "DomainMemberships": []
    }
}

Para obter mais informações, consulte Restaurar a partir de um snapshot de um cluster de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar restore-db-cluster-to-point-in-time.

AWS CLI

Restaurar um cluster de banco de dados para um horário específico

O exemplo restore-db-cluster-to-point-in-time a seguir restaura o cluster de banco de dados denominado database-4 para a hora mais recente possível. Usar copy-on-write como tipo de restauração restaura o novo cluster de banco de dados como um clone do cluster de banco de dados de origem.

aws rds restore-db-cluster-to-point-in-time \
    --source-db-cluster-identifier database-4 \
    --db-cluster-identifier sample-cluster-clone \
    --restore-type copy-on-write \
    --use-latest-restorable-time

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2a",
            "us-west-2b"
        ],
        "BackupRetentionPeriod": 7,
        "DatabaseName": "",
        "DBClusterIdentifier": "sample-cluster-clone",
        "DBClusterParameterGroup": "default.aurora-postgresql10",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-postgresql",
        "EngineVersion": "10.7",
        "Port": 5432,
        "MasterUsername": "postgres",
        "PreferredBackupWindow": "09:33-10:03",
        "PreferredMaintenanceWindow": "sun:12:22-sun:12:52",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1PVIF0EXAMPLE",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
        "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd",
        "ClusterCreateTime": "2020-03-10T19:57:38.967Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false
    }
}

Para obter mais informações, consulte Restaurar um cluster de banco de dados em um horário específico no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar restore-db-instance-from-db-snapshot.

AWS CLI

Para restaurar uma instância de banco de dados a partir de um snapshot de banco de dados

O exemplo restore-db-instance-from-db-snapshot a seguir cria uma nova instância de banco de dados denominada db7-new-instance com a classe de instância de banco de dados db.t3.small a partir do snapshot de banco de dados especificado. A instância de banco de dados de origem da qual o snapshot foi obtido usa uma classe de instância de banco de dados obsoleta, então não é possível atualizá-la.

aws rds restore-db-instance-from-db-snapshot \
    --db-instance-identifier db7-new-instance \
    --db-snapshot-identifier db7-test-snapshot \
    --db-instance-class db.t3.small

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "db7-new-instance",
        "DBInstanceClass": "db.t3.small",
        "Engine": "mysql",
        "DBInstanceStatus": "creating",

        ...output omitted...

        "PreferredMaintenanceWindow": "mon:07:37-mon:08:07",
        "PendingModifiedValues": {},
        "MultiAZ": false,
        "EngineVersion": "5.7.22",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "general-public-license",

        ...output omitted...

        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": []
    }
}

Para obter mais informações, consulte Restaurar a partir de um snapshot de banco de dados no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar restore-db-instance-from-s3.

AWS CLI

Restaurar uma instância de banco de dados a partir de um backup no Amazon S3

O exemplo restore-db-instance-from-s3 a seguir cria uma nova instância de banco de dados denominada restored-test-instance a partir de um backup existente no bucket my-backups do S3.

aws rds restore-db-instance-from-s3 \
    --db-instance-identifier restored-test-instance \
    --allocated-storage 250 --db-instance-class db.m4.large --engine mysql \
    --master-username master --master-user-password secret99 \
    --s3-bucket-name my-backups --s3-ingestion-role-arn arn:aws:iam::123456789012:role/my-role \
    --source-engine mysql --source-engine-version 5.6.27

O código de exemplo a seguir mostra como usar restore-db-instance-to-point-in-time.

AWS CLI

Exemplo 1: restaurar uma instância de banco de dados para um momento específico

O exemplo restore-db-instance-to-point-in-time a seguir restaura test-instance para uma nova instância de banco de dados denominada restored-test-instance, a partir do momento especificado.

aws rds restore-db-instance-to-point-in-time \
    --source-db-instance-identifier test-instance \
    --target-db-instance restored-test-instance \
    --restore-time 2018-07-30T23:45:00.000Z

Saída:

{
    "DBInstance": {
        "AllocatedStorage": 20,
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance",
        "DBInstanceStatus": "creating",
        "DBInstanceIdentifier": "restored-test-instance",
        ...some output omitted...
    }
}

Para obter instruções, consulte Restaurar uma instância de banco de dados para um horário especificado no Guia do usuário do Amazon RDS.

Exemplo 2: restaurar uma instância de banco de dados para um horário específico a partir de um backup replicado

O exemplo restore-db-instance-to-point-in-time a seguir restaura uma instância de banco de dados do Oracle para o horário especificado usando um backup automatizado replicado.

aws rds restore-db-instance-to-point-in-time \
    --source-db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" \
    --target-db-instance-identifier myorclinstance-from-replicated-backup \
    --restore-time 2020-12-08T18:45:00.000Z

Saída:

{
    "DBInstance": {
        "DBInstanceIdentifier": "myorclinstance-from-replicated-backup",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "oracle-se2",
        "DBInstanceStatus": "creating",
        "MasterUsername": "admin",
        "DBName": "ORCL",
        "AllocatedStorage": 20,
        "PreferredBackupWindow": "07:45-08:15",
        "BackupRetentionPeriod": 14,
        ... some output omitted ...
        "DbiResourceId": "db-KGLXG75BGVIWKQT7NQ4EXAMPLE",
        "CACertificateIdentifier": "rds-ca-2019",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:myorclinstance-from-replicated-backup",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": [],
        "TagList": []
    }
}

Para obter mais informações, consulte Restaurar para um horário específico a partir de um backup replicado no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar start-activity-stream.

AWS CLI

Iniciar um fluxo de atividade de banco de dados

O exemplo start-activity-stream a seguir inicia um fluxo de atividades assíncrono para monitorar um cluster do Aurora denominado my-pg-cluster.

aws rds start-activity-stream \
    --region us-east-1 \
    --mode async \
    --kms-key-id arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1 \
    --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \
    --apply-immediately

Saída:

{
    "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
    "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
    "Status": "starting",
    "Mode": "async",
    "ApplyImmediately": true
}

Para obter mais informações, consulte Iniciar um fluxo de atividades de banco de dados no Guia do usuário do Amazon Aurora.

O código de exemplo a seguir mostra como usar start-db-cluster.

AWS CLI

Iniciar um cluster de banco de dados

O exemplo start-db-cluster a seguir inicia um cluster de banco de dados e as instâncias de banco de dados.

aws rds start-db-cluster \
    --db-cluster-identifier mydbcluster

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1e",
            "us-east-1b"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "mydb",
        "DBClusterIdentifier": "mydbcluster",
        ...some output truncated...
    }
}

Para obter mais informações, consulte Interromper e iniciar um cluster de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar start-db-instance-automated-backups-replication.

AWS CLI

Habilitar backups automatizados entre regiões

O exemplo start-db-instance-automated-backups-replication a seguir replica backups automatizados de uma instância de banco de dados na região Leste dos EUA (N. da Virgínia) para Oeste dos EUA (Oregon). O período de retenção de backup é de 14 dias.

aws rds start-db-instance-automated-backups-replication \
    --region us-west-2 \
    --source-db-instance-arn "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" \
    --backup-retention-period 14

Saída:

{
    "DBInstanceAutomatedBackup": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
        "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
        "Region": "us-east-1",
        "DBInstanceIdentifier": "new-orcl-db",
        "RestoreWindow": {},
        "AllocatedStorage": 20,
        "Status": "pending",
        "Port": 1521,
        "InstanceCreateTime": "2020-12-04T15:28:31Z",
        "MasterUsername": "admin",
        "Engine": "oracle-se2",
        "EngineVersion": "12.1.0.2.v21",
        "LicenseModel": "bring-your-own-license",
        "OptionGroupName": "default:oracle-se2-12-1",
        "Encrypted": false,
        "StorageType": "gp2",
        "IAMDatabaseAuthenticationEnabled": false,
        "BackupRetentionPeriod": 14,
        "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
    }
}

Para obter mais informações, consulte Habilitar backups automáticos entre regiões no Guia do usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar start-db-instance.

AWS CLI

Iniciar uma instância de banco de dados

O exemplo start-db-instance a seguir inicia uma instância de banco de dados especificada.

aws rds start-db-instance \
    --db-instance-identifier test-instance

Saída:

{
    "DBInstance": {
        "DBInstanceStatus": "starting",
        ...some output truncated...
    }
}

  • Para ver detalhes da API, consulte StartDbInstance em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar start-export-task.

AWS CLI

Exportar um snapshot para o Amazon S3

O exemplo start-export-task a seguir exporta um snapshot de banco de dados denominado db5-snapshot-test para o bucket do Amazon S3 denominado amzn-s3-demo-bucket.

aws rds start-export-task \
    --export-task-identifier my-s3-export \
    --source-arn arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test \
    --s3-bucket-name amzn-s3-demo-bucket \
    --iam-role-arn arn:aws:iam::123456789012:role/service-role/ExportRole \
    --kms-key-id arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff

Saída:

{
    "ExportTaskIdentifier": "my-s3-export",
    "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
    "SnapshotTime": "2020-03-27T20:48:42.023Z",
    "S3Bucket": "amzn-s3-demo-bucket",
    "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
    "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
    "Status": "STARTING",
    "PercentProgress": 0,
    "TotalExtractedDataInGB": 0
}

Para obter mais informações, consulte Exportar um snapshot para um bucket do Amazon S3 no Guia do usuário do Amazon RDS.

  • Para ver detalhes da API, consulte StartExportTask em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar stop-activity-stream.

AWS CLI

Interromper um fluxo de atividade de banco de dados

O exemplo stop-activity-stream a seguir interrompe um fluxo de atividades em um cluster do Aurora denominado my-pg-cluster.

aws rds stop-activity-stream \
    --region us-east-1 \
    --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \
    --apply-immediately

Saída:

{
    "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
    "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
    "Status": "stopping"
}

Para obter mais informações, consulte Interromper um fluxo de atividade no Guia do usuário do Amazon Aurora.

  • Para ver detalhes da API, consulte StopActivityStream em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar stop-db-cluster.

AWS CLI

Interromper um cluster de banco de dados

O exemplo stop-db-cluster a seguir interrompe um cluster de banco de dados e as instâncias de banco de dados.

aws rds stop-db-cluster \
    --db-cluster-identifier mydbcluster

Saída:

{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1e",
            "us-east-1b"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "mydb",
        "DBClusterIdentifier": "mydbcluster",
        ...some output truncated...
    }
}

Para obter mais informações, consulte Interromper e iniciar um cluster de banco de dados do Amazon Aurora no Guia do usuário do Amazon Aurora.

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

O código de exemplo a seguir mostra como usar stop-db-instance-automated-backups-replication.

AWS CLI

Parar de replicar backups automatizados

O exemplo stop-db-instance-automated-backups-replication a seguir encerra a replicação de backups automatizados para a região Oeste dos EUA (Oregon). Os backups replicados são retidos de acordo com o período de retenção de backup definido.

aws rds stop-db-instance-automated-backups-replication \
    --region us-west-2 \
    --source-db-instance-arn "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db"

Saída:

{
    "DBInstanceAutomatedBackup": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
        "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
        "Region": "us-east-1",
        "DBInstanceIdentifier": "new-orcl-db",
        "RestoreWindow": {
            "EarliestTime": "2020-12-04T23:13:21.030Z",
            "LatestTime": "2020-12-07T19:59:57Z"
        },
        "AllocatedStorage": 20,
        "Status": "replicating",
        "Port": 1521,
        "InstanceCreateTime": "2020-12-04T15:28:31Z",
        "MasterUsername": "admin",
        "Engine": "oracle-se2",
        "EngineVersion": "12.1.0.2.v21",
        "LicenseModel": "bring-your-own-license",
        "OptionGroupName": "default:oracle-se2-12-1",
        "Encrypted": false,
        "StorageType": "gp2",
        "IAMDatabaseAuthenticationEnabled": false,
        "BackupRetentionPeriod": 7,
        "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
    }
}

Para obter mais informações, consulte Interromper a replicação automatizada de backup no Guia do Usuário do Amazon RDS.

O código de exemplo a seguir mostra como usar stop-db-instance.

AWS CLI

Encerrar uma instância de banco de dados

O exemplo stop-db-instance a seguir interrompe a instância de banco de dados especificada.

aws rds stop-db-instance \
    --db-instance-identifier test-instance

Saída:

{
    "DBInstance": {
        "DBInstanceStatus": "stopping",
        ...some output truncated...
    }
}

  • Para ver detalhes da API, consulte StopDbInstance em Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar switchover-blue-green-deployment.

AWS CLI

Exemplo 1: alternar uma implantação azul/verde para uma instância de banco de dados do RDS

O exemplo switchover-blue-green-deployment a seguir promove o ambiente verde especificado como o novo ambiente de produção.

aws rds switchover-blue-green-deployment \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake \
    --switchover-timeout 300

Saída:

{
    "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
        "BlueGreenDeploymentName": "bgd-cli-test-instance",
        "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
        "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e",
        "SwitchoverDetails": [
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-k5fv7u",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ggsh8m",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-o2vwm0",
                "Status": "AVAILABLE"
            }
        ],
        "Tasks": [
            {
                "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                "Status": "COMPLETED"
            },
            {
                "Name": "DB_ENGINE_VERSION_UPGRADE",
                "Status": "COMPLETED"
            },
            {
                "Name": "CONFIGURE_BACKUPS",
                "Status": "COMPLETED"
            },
            {
                "Name": "CREATING_TOPOLOGY_OF_SOURCE",
                "Status": "COMPLETED"
            }
        ],
        "Status": "SWITCHOVER_IN_PROGRESS",
        "CreateTime": "2022-02-25T22:33:22.225000+00:00"
    }
}

Para obter mais informações, consulte Alternar uma implantação azul/verde no Guia do usuário do Amazon RDS.

Exemplo 2: promover uma implantação azul/verde de um cluster de banco de dados do Aurora MySQL

O exemplo switchover-blue-green-deployment a seguir promove o ambiente verde especificado como o novo ambiente de produção.

aws rds switchover-blue-green-deployment \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake \
    --switchover-timeout 300

Saída:

{
    "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
        "BlueGreenDeploymentName": "my-blue-green-deployment",
        "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
        "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6",
        "SwitchoverDetails": [
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-bvxc73",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-7wc4ie",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-p4xxkz",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-np1ikl",
                "Status": "AVAILABLE"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
                "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-miszlf",
                "Status": "AVAILABLE"
            }
        ],
        "Tasks": [
            {
                "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                "Status": "COMPLETED"
            },
            {
                "Name": "DB_ENGINE_VERSION_UPGRADE",
                "Status": "COMPLETED"
            },
            {
                "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
                "Status": "COMPLETED"
            },
            {
                "Name": "CREATE_CUSTOM_ENDPOINTS",
                "Status": "COMPLETED"
            }
        ],
        "Status": "SWITCHOVER_IN_PROGRESS",
        "CreateTime": "2022-02-25T22:38:49.522000+00:00"
    }
}

Para obter mais informações, consulte Alternar uma implantação azul/verde no Guia do usuário do Amazon Aurora.