As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Tipos de dados Os seguintes tipos de dados são compatíveis com Amazon DocumentDB (with MongoDB compatibility): + [AvailabilityZone](API_AvailabilityZone.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) + [DBCluster](API_DBCluster.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [UpgradeTarget](API_UpgradeTarget.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) Os seguintes tipos de dados são compatíveis com os cluster elásticos do Amazon DocumentDB: + [Cluster](API_elastic_Cluster.md) + [ClusterInList](API_elastic_ClusterInList.md) + [ClusterSnapshot](API_elastic_ClusterSnapshot.md) + [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) + [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) + [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) + [Shard](API_elastic_Shard.md) + [ValidationExceptionField](API_elastic_ValidationExceptionField.md) # Amazon DocumentDB (with MongoDB compatibility) Os seguintes tipos de dados são compatíveis com Amazon DocumentDB (with MongoDB compatibility): + [AvailabilityZone](API_AvailabilityZone.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) + [DBCluster](API_DBCluster.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [UpgradeTarget](API_UpgradeTarget.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) # AvailabilityZone Informações sobre uma Zona de Disponibilidade. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** Name ** O nome da Zona de Disponibilidade. Tipo: string Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) # Certificate Certificado de autoridade de certificado (CA) para um Conta da AWS. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** CertificateArn ** O Nome do recurso da Amazon (ARN) para o certificado. Exemplo: `arn:aws:rds:us-east-1::cert:rds-ca-2019` Tipo: string Obrigatório: Não ** CertificateIdentifier ** A chave exclusiva que identifica um certificado. Exemplo: `rds-ca-2019` Tipo: string Obrigatório: Não ** CertificateType ** O tipo de certificado. Exemplo: `CA` Tipo: string Obrigatório: Não ** Thumbprint ** A impressão digital do certificado. Tipo: String Obrigatório: Não ** ValidFrom ** A data e hora de início a partir das quais o certificado passa a ser válido. Exemplo: `2019-07-31T17:57:09Z` Tipo: carimbo de hora Obrigatório: Não ** ValidTill ** Data e hora a partir das quais o certificado deixa de ser válido. Exemplo: `2024-07-31T17:57:09Z` Tipo: carimbo de hora Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) # CertificateDetails Retorna os detalhes do certificado de servidor de instância DB. Para obter mais informações, consulte [Atualizando seus Certificados TLS do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) e [Criptografando Dados em Trânsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) no *Guia do Desenvolvedor do Amazon DocumentDB*. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** CAIdentifier ** O identificador CA do certificado CA usado para o certificado do servidor da instância DB. Tipo: String Obrigatório: Não ** ValidTill ** A data de vencimento do certificado de servidor da instância DB. Tipo: Timestamp Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) # CloudwatchLogsExportConfiguration A definição de configuração para os tipos de log a serem habilitados para exportação para o Amazon CloudWatch Logs para um determinado cluster ou instância. As matrizes `EnableLogTypes` e `DisableLogTypes` determinam os logs que serão exportados (ou não) para o CloudWatch Logs. Os valores dentro dessas matrizes dependem do mecanismo que está sendo usado. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** DisableLogTypes.member.N ** A lista de tipos de logs a serem desabilitados. Tipo: matriz de strings Obrigatório: Não ** EnableLogTypes.member.N ** A lista de tipos de logs a serem habilitados. Tipo: matriz de strings Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) # ClusterMasterUserSecret Contém o segredo gerenciado pelo Amazon DocumentDB no AWS Secrets Manager para a senha do usuário principal. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** KmsKeyId ** O identificador de chave do AWS KMS que é usado para criptografar o segredo. Tipo: String Obrigatório: Não ** SecretArn ** O nome do recurso da Amazon (ARN) do segredo. Tipo: String Obrigatório: Não ** SecretStatus ** O status do segredo. Os valores de status possíveis são os seguintes: + em criação: o segredo está sendo criado. + ativo: o segredo está disponível para uso e alternância normais. + em alternância: o segredo está sendo alternado. + prejudicado: o segredo pode ser usado para acessar as credenciais do banco de dados, mas não pode ser alternado. Um segredo pode ter esse status se, por exemplo, as permissões forem alteradas para que o Amazon DocumentDB não possa mais acessar o segredo ou a chave do KMS do segredo. Quando um segredo tem esse status, você pode corrigir a condição que o causou. Como alternativa, modifique a instância para desativar o gerenciamento automático das credenciais do banco de dados e, depois, modifique a instância novamente para ativar o gerenciamento automático das credenciais do banco de dados. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) # DBCluster Informações detalhadas sobre um cluster. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AssociatedRoles.DBClusterRole.N ** Fornece uma lista dos perfis (IAM) do AWS Identity and Access Management que estão associadas ao cluster. Os perfis (IAM) associados a uma permissão de concessão do cluster para acessar outros serviços da AWS em seu nome. Tipo: matriz de objetos [DBClusterRole](API_DBClusterRole.md) Obrigatório: Não ** AvailabilityZones.AvailabilityZone.N ** Fornece a lista de zonas de disponibilidade do Amazon EC2 nas quais as instâncias no cluster podem ser criadas. Tipo: matriz de strings Obrigatório: Não ** BackupRetentionPeriod ** Especifica o número de dias durante os quais os snapshots automáticos são retidos. Tipo: inteiro Obrigatório: Não ** CloneGroupId ** Identifica o grupo de clones ao qual o cluster do banco de dados está associado. Tipo: String Obrigatório: Não ** ClusterCreateTime ** Especifica a hora em que o cluster foi criado, no Tempo Universal Coordenado (UTC). Tipo: carimbo de hora Obrigatório: Não ** DBClusterArn ** O nome de recurso da Amazon (ARN) para o cluster. Tipo: String Obrigatório: Não ** DBClusterIdentifier ** Contém um identificador de cluster fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um cluster. Tipo: String Obrigatório: Não ** DBClusterMembers.DBClusterMember.N ** Fornece a lista de instâncias que compõem o cluster. Tipo: matriz de objetos [DBClusterMember](API_DBClusterMember.md) Obrigatório: Não ** DBClusterParameterGroup ** Especifica o nome do grupo de parâmetros do cluster para o cluster. Tipo: String Obrigatório: Não ** DbClusterResourceId ** O identificador imutável e exclusivo da Região da AWS para o cluster. Esse identificador é encontrado nas entradas de log do AWS CloudTrail sempre que a chave do AWS KMS para o cluster é acessada. Tipo: String Obrigatório: Não ** DBSubnetGroup ** Especifica informações sobre o grupo de sub-redes associado ao cluster, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes. Tipo: String Obrigatório: Não ** DeletionProtection ** Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental. Tipo: booliano Obrigatório: Não ** EarliestRestorableTime ** Especifica a data mais antiga para a qual um banco de dados pode ser restaurado com restauração ponto no tempo. Tipo: Timestamp Obrigatório: Não ** EnabledCloudwatchLogsExports.member.N ** Uma lista de tipos de logs que esse cluster está configurado para exportar para o Amazon CloudWatch Logs. Tipo: matriz de strings Obrigatório: Não ** Endpoint ** Especifica o endpoint de conexão para a instância principal do cluster. Tipo: string Obrigatório: Não ** Engine ** Fornece o nome do mecanismo de banco de dados a ser usado para esse cluster. Tipo: String Obrigatório: Não ** EngineVersion ** Indica a versão do mecanismo do banco de dados. Tipo: String Obrigatório: Não ** HostedZoneId ** Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada. Tipo: String Obrigatório: Não ** IOOptimizedNextAllowedModificationTime ** Na próxima vez será possível modificar o cluster do Amazon DocumentDB para usar o tipo de armazenamento iopt1. Tipo: Timestamp Obrigatório: Não ** KmsKeyId ** Se `StorageEncrypted` for `true`, o identificador da chave AWS KMS para o cluster criptografado. Tipo: String Obrigatório: Não ** LatestRestorableTime ** Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual. Tipo: carimbo de hora Obrigatório: Não ** MasterUsername ** Contém o nome de usuário principal para o cluster. Tipo: String Obrigatório: Não ** MasterUserSecret ** O segredo gerenciado pelo Amazon DocumentDB no AWS Secrets Manager para a senha do usuário principal. Tipo: objeto [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) Obrigatório: Não ** MultiAZ ** Especifica se o cluster tem instâncias em várias zonas de disponibilidade. Tipo: booliano Obrigatório: Não ** NetworkType ** O tipo de rede do cluster. O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. Um `DBSubnetGroup` pode oferecer suporte somente para o protocolo IPv4 ou para os protocolos IPv4 e IPv6 (`DUAL`). Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB. Valores válidos: `IPV4` \$1 `DUAL` Tipo: String Obrigatório: Não ** PercentProgress ** Especifica o andamento da operação como um percentual. Tipo: String Obrigatório: Não ** Port ** Especifica a porta onde o mecanismo de banco de dados está realizando a recepção. Tipo: inteiro Obrigatório: Não ** PreferredBackupWindow ** Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `BackupRetentionPeriod`. Tipo: String Obrigatório: Não ** PreferredMaintenanceWindow ** Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC). Tipo: String Obrigatório: Não ** ReaderEndpoint ** O endpoint do leitor do cluster. O endpoint do leitor para balanceadores de carga do cluster das conexões entre réplicas do Amazon DocumentDB que estão disponíveis em um cluster. À medida em que os clientes solicitam novas conexões ao endpoint do leitor, o Amazon DocumentDB distribui as solicitações de conexão entre as réplicas de Amazon DocumentDB no cluster. Essa funcionalidade pode ajudar a equilibrar sua workload de leitura entre várias réplicas do Amazon DocumentDB em seu cluster. Se ocorrer um failover e a réplica do Amazon DocumentDB à qual você estiver conectado for promovida à instância principal, a sua conexão será interrompida. Para continuar a enviar sua workload de leitura para outras réplicas do Amazon DocumentDB no cluster, reconecte-se ao endpoint do leitor. Tipo: String Obrigatório: Não ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N ** Contém um ou mais identificadores dos clusters secundários associados a esse cluster. Tipo: matriz de strings Obrigatório: Não ** ReplicationSourceIdentifier ** Contém o identificador do cluster de origem, se esse cluster for um cluster secundário. Tipo: String Obrigatório: Não ** ServerlessV2ScalingConfiguration ** A configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor. Tipo: objeto [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) Obrigatório: Não ** Status ** Especifica o estado atual desse cluster. Tipo: String Obrigatório: Não ** StorageEncrypted ** Especifica se o cluster é criptografado. Tipo: booliano Obrigatório: Não ** StorageType ** Tipo de armazenamento associado ao cluster Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento em cluster no *Guia do desenvolvedor do Amazon DocumentDB*. Valores válidos para o tipo de armazenamento - `standard | iopt1` O valor padrão é . `standard ` Tipo: String Obrigatório: Não ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** Uma lista de grupos de segurança da nuvem privada virtual (VPC) a serem associados ao que o cluster pertence. Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) # DBClusterMember Contém informações sobre uma instância que faz parte de um cluster. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** DBClusterParameterGroupStatus ** Especifica o status do grupo de parâmetros do cluster para esse membro do cluster DB. Tipo: String Obrigatório: Não ** DBInstanceIdentifier ** Especifica o identificador da instância para esse membro do cluster. Tipo: String Obrigatório: Não ** IsClusterWriter ** Valor igual a `true` caso o membro do cluster seja a instância principal para o cluster e `false`, caso contrário. Tipo: booleano Obrigatório: Não ** PromotionTier ** Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente. Tipo: número inteiro Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) # DBClusterParameterGroup Informações detalhadas sobre o grupo de parâmetros de cluster. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** DBClusterParameterGroupArn ** O nome do recurso da Amazon (ARN) do grupo de parâmetros de cluster. Tipo: String Obrigatório: Não ** DBClusterParameterGroupName ** Fornece o nome do grupo de parâmetro do cluster. Tipo: String Obrigatório: Não ** DBParameterGroupFamily ** Fornece o nome da família do grupo de parâmetro com o qual esse grupo de parâmetro de cluster é compatível. Tipo: String Obrigatório: Não ** Description ** Fornece a descrição especificada pelo cliente para este grupo de parâmetro do cluster. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) # DBClusterRole Descreve um perfil do (IAM) AWS Identity and Access Management associada a um cluster. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** RoleArn ** O Nome do Recurso da Amazon (ARN) do perfil do IAM associado ao cluster DB. Tipo: string Obrigatório: Não ** Status ** Descreve o estado de associação entre o perfil do IAM e o cluster. A propriedade `Status` retorna um dos valores a seguir: + `ACTIVE` - o ARN do perfil do IAM é associado ao cluster e pode ser usado para acessar outros serviços AWS em seu nome. + `PENDING` – o ARN do perfil do IAM está sendo associado ao cluster. + `INVALID` - o ARN do perfil do IAM é associado ao cluster, mas o cluster não consegue presumir o perfil do IAM para acessar outros serviços AWS em seu nome. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) # DBClusterSnapshot Informações detalhadas sobre um snapshot de cluster. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AvailabilityZones.AvailabilityZone.N ** Fornece a lista de Zonas de Disponibilidade do Amazon EC2 nas quais as instâncias na captura de tela do cluster podem ser restauradas. Tipo: matriz de strings Obrigatório: Não ** ClusterCreateTime ** Especifica a hora em que o cluster foi criado, no Tempo Universal Coordenado (UTC). Tipo: carimbo de hora Obrigatório: Não ** DBClusterIdentifier ** Especifica o identificador do cluster a partir do qual essa captura de tela de cluster foi criada. Tipo: string Obrigatório: Não ** DBClusterSnapshotArn ** O nome do recurso da Amazon (ARN) da captura de tela do cluster. Tipo: String Obrigatório: Não ** DBClusterSnapshotIdentifier ** Especifica o identificador da captura de tela do cluster de banco de dados. Tipo: String Obrigatório: Não ** Engine ** Especifica o nome do mecanismo de banco de dados. Tipo: String Obrigatório: Não ** EngineVersion ** Fornece a versão do mecanismo de banco de dados para essa captura de tela do cluster. Tipo: String Obrigatório: Não ** KmsKeyId ** Se `StorageEncrypted` for `true`, o identificador de chave AWS KMS para a captura de tela do cluster criptografado. Tipo: String Obrigatório: Não ** MasterUsername ** Fornece o nome de usuário mestre para a captura de tela do cluster. Tipo: String Obrigatório: Não ** PercentProgress ** Especifica a porcentagem dos dados estimados transferidos. Tipo: inteiro Obrigatório: Não ** Port ** Especifica a porta da qual o cluster de banco de dados estava receptando no momento da captura de tela. Tipo: inteiro Obrigatório: Não ** SnapshotCreateTime ** Fornece a hora na qual a captura de tela foi criada, em Tempo Universal Coordenado (UTC). Tipo: Timestamp Obrigatório: Não ** SnapshotType ** Fornece o tipo de captura de tela do cluster. Tipo: String Obrigatório: Não ** SourceDBClusterSnapshotArn ** Se a captura de tela do cluster foi copiada de outra do cluster origem, o ARN para a captura de tela do cluster de origem; caso contrário, um valor nulo. Tipo: String Obrigatório: Não ** Status ** Especifica o status dessa captura de tela de cluster. Tipo: String Obrigatório: Não ** StorageEncrypted ** Especifica se a captura de tela do cluster está criptografada. Tipo: booleano Obrigatório: Não ** StorageType ** O tipo de armazenamento associado ao snapshot de cluster Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento em cluster no *Guia do desenvolvedor do Amazon DocumentDB*. Valores válidos para o tipo de armazenamento - `standard | iopt1` O valor padrão é . `standard ` Tipo: String Obrigatório: Não ** VpcId ** Fornece a ID da Nuvem Privada Virtual (VPC) associada à captura de tela de cluster. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) # DBClusterSnapshotAttribute Contém o nome e os valores de um atributo de captura de tela do cluster manual. Os atributos de uma captura de tela de um cluster manual são usados para autorizar outros Contas da AWS a restaurarem uma captura de tela de cluster manual. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** AttributeName ** O nome do atributo da captura de tela do cluster manual. O atributo chamado `restore` refere-se à lista de contas de Contas da AWS com permissão para copiar ou restaurar a captura de tela do cluster manual. Tipo: string Obrigatório: Não ** AttributeValues.AttributeValue.N ** Os valores do atributo da captura de tela do cluster manual. Se o campo `AttributeName` for definido como `restore`, esse elemento retornará uma lista de IDs de Contas da AWS autorizados a copiar ou restaurar a captura de tela do cluster manual. Se um valor de `all` estiver na lista, a captura de tela do cluster manual será pública e estará disponível para qualquer Conta da AWS copiar ou restaurar. Tipo: matriz de strings Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) # DBClusterSnapshotAttributesResult Informações detalhadas sobre os atributos associados a um snapshot de cluster. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N ** A lista de atributos e valores para captura de tela de cluster. Tipo: matriz de objetos [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) Obrigatório: Não ** DBClusterSnapshotIdentifier ** O identificador da captura de tela do cluster a qual os atributos se aplicam. Tipo: string Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) # DBEngineVersion Informações detalhadas sobre uma versão do mecanismo. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** DBEngineDescription ** A descrição do mecanismo de banco de dados. Tipo: String Obrigatório: Não ** DBEngineVersionDescription ** A descrição da versão do mecanismo de banco de dados. Tipo: String Obrigatório: Não ** DBParameterGroupFamily ** O nome da família de grupos de parâmetro para o mecanismo de banco de dados. Tipo: String Obrigatório: Não ** Engine ** O nome do mecanismo de banco de dados. Tipo: String Obrigatório: Não ** EngineVersion ** O número da versão do mecanismo de banco de dados. Tipo: String Obrigatório: Não ** ExportableLogTypes.member.N ** Os tipos de logs que o mecanismo de banco de dados tem disponíveis para exportar para o Amazon CloudWatch Logs. Tipo: matriz de strings Obrigatório: Não ** ServerlessV2FeaturesSupport ** Especifica quaisquer propriedades ou limites do Amazon DocumentDB Sem Servidor que sejam diferentes entre as versões do mecanismo do Amazon DocumentDB. É possível testar os valores desse atributo ao decidir qual versão do Amazon DocumentDB usar em um cluster novo ou atualizado. Também é possível recuperar a versão de um cluster existente e verificar se essa versão oferece suporte a determinados recursos do Amazon DocumentDB Sem Servidor antes de tentar usar esses recursos. Tipo: objeto [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) Obrigatório: Não ** SupportedCACertificateIdentifiers.member.N ** Uma lista dos identificadores de certificado CA com suporte. Para obter mais informações, consulte [Atualização dos certificados TLS do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) e [criptografia de dados em trânsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) no *Guia do desenvolvedor do Amazon DocumentDB.* Tipo: matriz de strings Obrigatório: Não ** SupportsCertificateRotationWithoutRestart ** Indica se a versão do mecanismo suporta a rotação do certificado do servidor sem reinicializar a instância de banco de dados. Tipo: booliano Obrigatório: Não ** SupportsLogExportsToCloudwatchLogs ** Um valor que indica se a versão do mecanismo oferece suporte à exportação dos tipos de log especificados pelo `ExportableLogTypes` para CloudWatch Logs. Tipo: booliano Obrigatório: Não ** ValidUpgradeTarget.UpgradeTarget.N ** Uma lista de versões do mecanismo para as quais essa versão do mecanismo de banco de dados pode ser atualizada. Tipo: matriz de objetos [UpgradeTarget](API_UpgradeTarget.md) Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) # DBInstance Informações detalhadas sobre uma instância. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AutoMinorVersionUpgrade ** Não se aplica. Esse parâmetro não é aplicável ao Amazon DocumentDB. O Amazon DocumentDB não faz atualizações de versões inferiores, independente do valor definido. Tipo: Booliano Obrigatório: Não ** AvailabilityZone ** Especifica o nome da Zona de Disponibilidade na qual a instância de banco de dados está localizada. Tipo: String Obrigatório: Não ** BackupRetentionPeriod ** Especifica o número de dias durante os quais os snapshots automáticos são retidos. Tipo: inteiro Obrigatório: Não ** CACertificateIdentifier ** O identificador do certificado da CA para essa instância DB. Tipo: String Obrigatório: Não ** CertificateDetails ** Detalhes do certificado do servidor da instância DB. Tipo: objeto [CertificateDetails](API_CertificateDetails.md) Obrigatório: Não ** CopyTagsToSnapshot ** Um valor que indica se as tags devem ser copiadas da instância DB nas capturas de tela da mesma. Por padrão, as tags não são copiadas. Tipo: Booliano Obrigatório: Não ** DBClusterIdentifier ** Contém o nome do cluster do qual a instância de banco de dados faz parte, caso a mesma seja membro. Tipo: String Obrigatório: Não ** DBInstanceArn ** O nome do recurso da Amazon (ARN) da instância. Tipo: String Obrigatório: Não ** DBInstanceClass ** Contém o nome da classe de capacidade e memória de computação da instância. Tipo: string Obrigatório: Não ** DBInstanceIdentifier ** Contém um identificador de banco de dados fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica uma instância. Tipo: String Obrigatório: Não ** DBInstanceStatus ** Especifica o estado atual desse banco de dados. Tipo: String Obrigatório: Não ** DbiResourceId ** O identificador exclusivo e imutável Região da AWS para a instância. Esse identificador é encontrado em entradas de log AWS CloudTrail sempre que a chave AWS KMS da instância é acessada. Tipo: String Obrigatório: Não ** DBSubnetGroup ** Especifica informações sobre o grupo de sub-redes associado à instância, como nome, descrição e sub-redes do grupo de sub-redes. Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md) Obrigatório: Não ** EnabledCloudwatchLogsExports.member.N ** Uma lista de tipos de logs que essa instância está configurada para exportar para o CloudWatch Logs. Tipo: matriz de strings Obrigatório: Não ** Endpoint ** Especifica o endpoint de conexão. Tipo: objeto [Endpoint](API_Endpoint.md) Obrigatório: Não ** Engine ** Fornece o nome do mecanismo de banco de dados a ser usado para essa instância. Tipo: String Obrigatório: Não ** EngineVersion ** Indica a versão do mecanismo do banco de dados. Tipo: String Obrigatório: Não ** InstanceCreateTime ** Fornece a data e hora em que a instância foi criada. Tipo: Timestamp Obrigatório: Não ** KmsKeyId ** Se `StorageEncrypted` for `true`, o identificador da chave AWS KMS para a instância criptografada. Tipo: String Obrigatório: Não ** LatestRestorableTime ** Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual. Tipo: carimbo de hora Obrigatório: Não ** PendingModifiedValues ** Especifica alterações da instância pendentes. Esse elemento só é incluído quando as alterações estão pendentes. As alterações específicas são identificadas por subelementos. Tipo: objeto [PendingModifiedValues](API_PendingModifiedValues.md) Obrigatório: Não ** PerformanceInsightsEnabled ** Defina como `true` se a opção Insights de Performance do Amazon RDS estiver ativada para a instância de banco de dados; caso contrário, `false`. Tipo: booliano Obrigatório: Não ** PerformanceInsightsKMSKeyId ** O identificador de chave do AWS KMS para criptografia de dados de Insights de Performance. O ID da chave do AWS KMS é o nome de recurso da Amazon (ARN), o identificador da chave do AWS KMS ou o alias da chave do AWS KMS para a chave de criptografia do AWS KMS. Tipo: String Obrigatório: Não ** PreferredBackupWindow ** Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `BackupRetentionPeriod`. Tipo: String Obrigatório: Não ** PreferredMaintenanceWindow ** Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC). Tipo: String Obrigatório: Não ** PromotionTier ** Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente. Tipo: número inteiro Obrigatório: Não ** PubliclyAccessible ** Sem compatibilidade. No momento, o Amazon DocumentDB não suporta endpoints públicos. O valor de `PubliclyAccessible` é sempre `false`. Tipo: booliano Obrigatório: Não ** StatusInfos.DBInstanceStatusInfo.N ** O status da réplica de leitura. Se a instância não for uma réplica de leitura, isso ficará em branco. Tipo: matriz de objetos [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) Obrigatório: Não ** StorageEncrypted ** Especifica se a instância é ou não criptografada. Tipo: booleano Obrigatório: Não ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** Fornece uma lista de elementos do grupo de segurança da VPC a qual a instância pertence. Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) # DBInstanceStatusInfo Fornece uma lista de informações de status para uma instância. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** Message ** Detalhes do erro se houver um erro para a instância. Se a instância não estiver em um estado de erro, esse valor ficará em branco. Tipo: String Obrigatório: Não ** Normal ** Um valor booliano que será `true` se a instância estiver funcionando normalmente, ou `false` se a instância estiver em um estado de erro. Tipo: booliano Obrigatório: Não ** Status ** Status da instância. Para uma `StatusType` de réplica de leitura, os valores podem ser `replicating`, error `stopped`, ou`terminated`. Tipo: String Obrigatório: Não ** StatusType ** Atualmente, esse valor é "`read replication`". Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) # DBSubnetGroup Informações detalhadas sobre um grupo de sub-rede. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** DBSubnetGroupArn ** O nome de recurso da Amazon (ARN) do grupo de sub-redes de banco de dados. Tipo: String Obrigatório: Não ** DBSubnetGroupDescription ** Fornece a descrição do grupo de sub-redes. Tipo: String Obrigatório: Não ** DBSubnetGroupName ** O nome do grupo de sub-redes. Tipo: String Obrigatório: Não ** SubnetGroupStatus ** Fornece o status do grupo de sub-redes. Tipo: String Obrigatório: Não ** Subnets.Subnet.N ** Informações detalhadas sobre uma ou mais sub-redes em um grupo de sub-rede. Tipo: matriz de objetos [Subnet](API_Subnet.md) Obrigatório: Não ** SupportedNetworkTypes.member.N ** O tipo de rede do grupo de sub-redes do banco de dados. Valores válidos: `IPV4` \$1 `DUAL` Um `DBSubnetGroup` pode oferecer suporte somente ao protocolo IPv4 ou aos protocolos IPv4 e IPv6 (DUPLO). Tipo: matriz de strings Obrigatório: Não ** VpcId ** Fornece o ID da nuvem privada virtual (VPC) do grupo de sub-rede. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) # Endpoint Informações de rede para acessar um cluster ou uma instância. Os programas de clientes devem especificar um endpoint válido para acessar esses recursos do Amazon DocumentDB. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** Address ** Especifica o endereço DNS da instância. Tipo: string Obrigatório: Não ** HostedZoneId ** Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada. Tipo: String Obrigatório: Não ** Port ** Especifica a porta onde o mecanismo de banco de dados está realizando a recepção. Tipo: inteiro Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) # EngineDefaults Contém o resultado de uma invocação bem-sucedida da operação `DescribeEngineDefaultClusterParameters`. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** DBParameterGroupFamily ** O nome da família de grupos de parâmetros de cluster a qual retornar informações de parâmetros do mecanismo. Tipo: string Obrigatório: Não ** Marker ** Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`. Tipo: string Obrigatório: Não ** Parameters.Parameter.N ** Os parâmetros de uma família específica do grupo de parâmetros do cluster. Tipo: matriz de objetos [Parameter](API_Parameter.md) Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) # Event Informações detalhadas sobre um evento. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** Date ** Especifica a data e a hora do evento. Tipo: Timestamp Obrigatório: Não ** EventCategories.EventCategory.N ** Especifica a categoria do evento. Tipo: matriz de strings Obrigatório: Não ** Message ** Fornece o texto desse evento. Tipo: String Obrigatório: Não ** SourceArn ** O nome de recurso da Amazon (ARN) do evento. Tipo: String Obrigatório: Não ** SourceIdentifier ** Fornece o identificador para a origem do evento. Tipo: String Obrigatório: Não ** SourceType ** Especifica o tipo de origem desse evento. Tipo: String Valores Válidos: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) # EventCategoriesMap Um tipo de origem de evento, acompanhado de um ou mais nomes de categorias de eventos. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** EventCategories.EventCategory.N ** As categorias de eventos para o tipo de origem especificado Tipo: matriz de strings Obrigatório: Não ** SourceType ** O tipo de fonte ao qual pertencem as categorias retornadas. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) # EventSubscription Informações detalhadas sobre um evento em você se inscreveu. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** CustomerAwsId ** A conta de cliente da AWS associada à assinatura de notificações de eventos Amazon DocumentDB. Tipo: String Obrigatório: Não ** CustSubscriptionId ** O ID da assinatura de notificação de eventos do Amazon DocumentDB. Tipo: String Obrigatório: Não ** Enabled ** Um valor booliano que indica se a assinatura está ativada. Um valor de `true` indica que a assinatura está ativada. Tipo: booliano Obrigatório: Não ** EventCategoriesList.EventCategory.N ** Uma lista de categorias de eventos da assinatura de notificações de eventos da Amazon DocumentDB. Tipo: matriz de strings Obrigatório: Não ** EventSubscriptionArn ** O nome do recurso da Amazon (ARN) da assinatura de eventos. Tipo: String Obrigatório: Não ** SnsTopicArn ** O ARN do tópico da assinatura de notificações de eventos da Amazon DocumentDB. Tipo: String Obrigatório: Não ** SourceIdsList.SourceId.N ** Uma lista de IDs de origem da assinatura de notificações de eventos da Amazon DocumentDB. Tipo: matriz de strings Obrigatório: Não ** SourceType ** O tipo de origem da assinatura de notificações de eventos da Amazon DocumentDB. Tipo: String Obrigatório: Não ** Status ** O status da assinatura de notificações de eventos da Amazon DocumentDB. Restrições: Pode ser um dos seguintes: `creating`, `modifying`, `deleting`, `active`, `no-permission`, `topic-not-exist` O status `no-permission` indica que o Amazon DocumentDB não tem mais permissão para fazer publicações no tópico do Amazon SNS. O status `topic-not-exist` indica que o tópico foi excluído após a assinatura ser criada. Tipo: String Obrigatório: Não ** SubscriptionCreationTime ** A hora em que a assinatura de notificações de eventos da Amazon DocumentDB foi criada. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) # FailoverState Contém o estado das operações programadas ou em andamento em um cluster global do Amazon DocumentDB. Esse tipo de dados está vazio, a menos que uma operação de alternância ou failover esteja programada ou esteja em andamento no cluster global. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** FromDbClusterArn ** O Amazon Resource Name (ARN) do cluster Amazon DocumentDB que está sendo rebaixado no momento e que está associado a esse estado. Tipo: string Obrigatório: não ** IsDataLossAllowed ** Indica se a operação é uma transição global ou um failover global. Se a perda de dados for permitida, a operação será um failover global. Caso contrário, é uma transição. Tipo: booliano Obrigatório: não ** Status ** O status atual do cluster global. Os valores possíveis são: + **pendente** — O serviço recebeu uma solicitação para alternar ou fazer o failover do cluster global. O cluster primário do cluster global e o cluster secundário especificado estão sendo verificados antes do início da operação. + **failing-over** — O cluster secundário escolhido está sendo promovido para se tornar o novo cluster primário a realizar failover no cluster global. + **cancelamento** — A solicitação para alternar ou fazer o failover do cluster global foi cancelada e o cluster primário e o cluster secundário selecionado estão retornando aos seus estados anteriores. Tipo: string Valores válidos: `pending | failing-over | cancelling` Obrigatório: não ** ToDbClusterArn ** O Amazon Resource Name (ARN) do cluster Amazon DocumentDB que está sendo promovido atualmente e que está associado a esse estado. Tipo: string Obrigatório: não ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) # Filter Um conjunto nomeado de valores de filtro, usado para retornar uma lista mais específica de resultados. Você pode usar um filtro para combinar um conjunto de recursos por critérios específicos, como IDs. Curingas não são compatíveis em filtros. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** Name ** O nome do filtro. Os nomes dos filtros diferenciam maiúsculas de minúsculas. Tipo: string Obrigatório: Sim ** Values.Value.N ** Um ou mais valores de filtro. Os valores do filtro diferenciam maiúsculas de minúsculas. Tipo: matriz de strings Obrigatório: Sim ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) # GlobalCluster Um tipo de dado que representa um cluster global do Amazon DocumentDB. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** DatabaseName ** O nome padrão do banco de dados dentro do novo cluster global. Tipo: string Obrigatório: não ** DeletionProtection ** A configuração de proteção contra exclusão para o novo cluster global. Tipo: booliano Obrigatório: não ** Engine ** O mecanismo de banco de dados Amazon DocumentDB usado pelo cluster global. Tipo: string Obrigatório: não ** EngineVersion ** Indica a versão do mecanismo do banco de dados. Tipo: string Obrigatório: não ** FailoverState ** Um objeto de dados contendo todas as propriedades do estado atual de um processo de alternância ou failover em andamento ou pendente para esse cluster global. Esse objeto está vazio, a menos que a `FailoverGlobalCluster` operação `SwitchoverGlobalCluster` or tenha sido chamada nesse cluster global. Tipo: objeto [FailoverState](API_FailoverState.md) Obrigatório: não ** GlobalClusterArn ** O nome do recurso da Amazon (ARN) para o cluster global. Tipo: string Obrigatório: não ** GlobalClusterIdentifier ** Contém um identificador de cluster global fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um cluster global. Tipo: string Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255. Padrão: `[A-Za-z][0-9A-Za-z-:._]*` Obrigatório: não ** GlobalClusterMembers.GlobalClusterMember.N ** A lista de clusters IDs para clusters secundários dentro do cluster global. Atualmente limitado a um item. Tipo: matriz de objetos [GlobalClusterMember](API_GlobalClusterMember.md) Obrigatório: não ** GlobalClusterResourceId ** O identificador Região da AWS exclusivo da região e imutável para o cluster de banco de dados global. Esse identificador é encontrado nas entradas de AWS CloudTrail registro sempre que a chave mestra AWS KMS do cliente (CMK) do cluster é acessada. Tipo: string Obrigatório: não ** Status ** Especifica o estado atual desse cluster global. Tipo: string Obrigatório: não ** StorageEncrypted ** A configuração de criptografia de armazenamento para o cluster global. Tipo: booliano Obrigatório: não ** TagList.Tag.N ** Uma lista de tags globais de cluster. Tipo: matriz de objetos [Tag](API_Tag.md) Obrigatório: não ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) # GlobalClusterMember Uma estrutura de dados com informações sobre quaisquer clusters primários e secundários associados a clusters globais do Amazon DocumentDB. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** DBClusterArn ** O nome de recurso da Amazon (ARN) para cada cluster do Amazon DocumentDB. Tipo: String Obrigatório: Não ** IsWriter ** Especifica se o cluster Amazon DocumentDB é o cluster primário (ou seja, tem capacidade de leitura e gravação) do cluster global Amazon DocumentDB ao qual está associado. Tipo: Booliano Obrigatório: não ** Readers.member.N ** O nome do recurso da Amazon (ARN) para cada cluster secundário somente de leitura associado ao cluster global do Amazon DocumentDB. Tipo: matriz de strings Obrigatório: Não ** SynchronizationStatus ** O status da sincronização de cada cluster Amazon DocumentDB no cluster global. Tipo: string Valores válidos: `connected | pending-resync` Obrigatório: não ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) # OrderableDBInstanceOption As opções que estão disponíveis para uma instância. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AvailabilityZones.AvailabilityZone.N ** Uma lista das zonas de disponibilidade para uma instância. Tipo: matriz de objetos [AvailabilityZone](API_AvailabilityZone.md) Obrigatório: Não ** DBInstanceClass ** A classe da instância para uma instância. Tipo: String Obrigatório: Não ** Engine ** O tipo de mecanismo de uma instância. Tipo: String Obrigatório: Não ** EngineVersion ** A versão do mecanismo de uma instância. Tipo: String Obrigatório: Não ** LicenseModel ** O modelo de licença para uma instância. Tipo: String Obrigatório: Não ** StorageType ** O tipo de armazenamento a ser associado ao cluster de banco de dados Tipo: String Obrigatório: Não ** Vpc ** Indica se uma instância é uma nuvem privada virtual (VPC). Tipo: booliano Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) # Parameter Informações detalhadas sobre um parâmetro individual. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AllowedValues ** Especifica o intervalo válido de valores para o parâmetro. Tipo: String Obrigatório: Não ** ApplyMethod ** Indica quando aplicar atualizações de parâmetros. Tipo: String Valores válidos: `immediate | pending-reboot` Obrigatório: Não ** ApplyType ** Especifica o tipo de parâmetros específicos do mecanismo. Tipo: String Obrigatório: Não ** DataType ** Especifica o tipo de dados válidos para o parâmetro. Tipo: String Obrigatório: Não ** Description ** Fornece uma descrição do parâmetro. Tipo:String Obrigatório: Não ** IsModifiable ** Indica se o parâmetro pode (`true`) ou não (`false`) ser modificado. Alguns parâmetros têm implicações de segurança ou operacionais que os impedem de ser alterados. Tipo: Booliano Obrigatório: Não ** MinimumEngineVersion ** A versão mais antiga do mecanismo à qual o parâmetro pode ser aplicado. Tipo String Obrigatório: Não ** ParameterName ** Especifica o nome do parâmetro. Tipo: String Obrigatório: Não ** ParameterValue ** Especifica o valor do parâmetro. Deve ser um ou mais dos `AllowedValues` dos parâmetros do cluster em formato CSV: Os valores válidos são: + `enabled`: o cluster aceita conexões seguras usando o TLS versões de 1.0 a 1.3. + `disabled`: o cluster não aceita conexões seguras usando o TLS. + `fips-140-3`: o cluster só aceita conexões seguras de acordo com os requisitos da publicação 140-3 do Federal Information Processing Standards (FIPS). Só há suporte para isso a partir dos clusters do Amazon DocumentDB 5.0 (versão do mecanismo 3.0.3727) nas regiões a seguir: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1. + `tls1.2+`: o cluster aceita conexões seguras usando o TLS versões 1.2 e posteriores Só há suporte para isso a partir do Amazon DocumentDB 4.0 (versão de mecanismo 2.0.10980) e Amazon DocumentDB 5.0 (versão de mecanismo 3.0.11051). + `tls1.3+`: o cluster aceita conexões seguras usando o TLS versões 1.3 e posteriores Só há suporte para isso a partir do Amazon DocumentDB 4.0 (versão de mecanismo 2.0.10980) e Amazon DocumentDB 5.0 (versão de mecanismo 3.0.11051). Tipo: String Obrigatório: Não ** Source ** Indica a origem do valor do parâmetro. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) # PendingCloudwatchLogsExports Uma lista dos tipos de log cuja configuração ainda está pendente. Em outras palavras, esses tipos de log estão em processo de ativação ou desativação. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** LogTypesToDisable.member.N ** Tipos de log que estão em processo de habilitação. Depois de habilitados, esses tipos de log são exportados para o Amazon CloudWatch Logs. Tipo: Matriz de strings Obrigatório: Não ** LogTypesToEnable.member.N ** Tipos de log que estão em processo de desativação. Depois que são desativados, esses tipos de log não são exportados para o CloudWatch Logs. Tipo: Matriz de strings Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) # PendingMaintenanceAction Fornece informações sobre uma ação de manutenção pendente para um recurso. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** Action ** O tipo de ação de manutenção pendente que está disponível para o recurso. Tipo: String Obrigatório: Não ** AutoAppliedAfterDate ** A data da janela de manutenção em que a ação é aplicada. A ação de manutenção é aplicada ao recurso durante a primeira janela de manutenção após essa data. Se essa data for especificada, todas as solicitações de inclusão `next-maintenance` serão ignoradas. Tipo: Timestamp Obrigatório: Não ** CurrentApplyDate ** A data de início de vigência quando a ação de manutenção pendente é aplicada ao recurso. Tipo: Timestamp Obrigatório: Não ** Description ** Uma descrição que fornece mais detalhes sobre a ação de manutenção. Tipo: String Obrigatório: Não ** ForcedApplyDate ** A data em que a ação de manutenção é aplicada automaticamente. A ação de manutenção é aplicada ao recurso nessa data, independentemente da janela de manutenção para o recurso. Se essa data for especificada, todas as solicitações de inclusão `immediate` serão ignoradas. Tipo: Timestamp Obrigatório: Não ** OptInStatus ** Indica o tipo de solicitação de inclusão que foi recebida para o recurso. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) # PendingModifiedValues Uma ou mais configurações modificadas para uma instância. Essas configurações modificadas foram solicitadas, mas ainda não foram aplicadas. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AllocatedStorage ** Contém o novo tamanho de `AllocatedStorage` para a instância que será aplicado ou está sendo aplicado. Tipo: inteiro Obrigatório: Não ** BackupRetentionPeriod ** Especifica o número de dias pendentes durante os quais os backups automatizados são retidos. Tipo: inteiro Obrigatório: Não ** CACertificateIdentifier ** Especifica o identificador da autoridade do certificado (CA) para a instância de banco de dados. Tipo: String Obrigatório: Não ** DBInstanceClass ** Contém a nova `DBInstanceClass` para a instância que será aplicada ou está sendo aplicada. Tipo: String Obrigatório: Não ** DBInstanceIdentifier ** Contém a nova `DBInstanceIdentifier` para a instância que será aplicada ou está sendo aplicada. Tipo: String Obrigatório: Não ** DBSubnetGroupName ** O novo grupo de sub-redes de banco de dados para a instância. Tipo: String Obrigatório: Não ** EngineVersion ** Indica a versão do mecanismo do banco de dados. Tipo: String Obrigatório: Não ** Iops ** Especifica o novo valor de IOPS provisionadas para a instância que será aplicado ou está sendo aplicado. Tipo: inteiro Obrigatório: Não ** LicenseModel ** O modelo de licença da instância. Valores válidos: `license-included`, `bring-your-own-license`, `general-public-license` Tipo: string Obrigatório: Não ** MasterUserPassword ** Contém a alteração pendente ou atualmente em andamento das credenciais mestre para a instância. Tipo: String Obrigatório: Não ** MultiAZ ** Indica que a instância Single-AZ deve ser alterada apara uma implantação Multi-AZ. Tipo: booliano Obrigatório: Não ** PendingCloudwatchLogsExports ** Uma lista dos tipos de log cuja configuração ainda está pendente. Esses tipos de log estão em processo de ativação ou desativação. Tipo: objeto [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) Obrigatório: Não ** Port ** Especifica a porta pendente para a instância. Tipo: inteiro Obrigatório: Não ** StorageType ** Especifica o tipo de armazenamento a ser associado à instância. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) # ResourcePendingMaintenanceActions Representa o resultado de [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md). ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N ** Uma lista que fornece detalhes sobre as ações de manutenção pendentes para o recurso. Tipo: matriz de objetos [PendingMaintenanceAction](API_PendingMaintenanceAction.md) Obrigatório: Não ** ResourceIdentifier ** O nome do recurso da Amazon (ARN) do recurso ao qual a ação de manutenção pendente se aplica. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) # ServerlessV2FeaturesSupport Especifica quaisquer propriedades ou limites do Amazon DocumentDB Sem Servidor que sejam diferentes entre as versões do mecanismo do Amazon DocumentDB. É possível testar os valores desse atributo ao decidir qual versão do Amazon DocumentDB usar em um cluster novo ou atualizado. Também é possível recuperar a versão de um cluster existente e verificar se essa versão oferece suporte a determinados recursos do Amazon DocumentDB Sem Servidor antes de tentar usar esses recursos. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** MaxCapacity ** O número máximo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 32, 32,5, 33, e assim por diante Tipo: duplo Obrigatório: Não ** MinCapacity ** O número mínimo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 8, 8,5, 9, e assim por diante Tipo: duplo Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) # ServerlessV2ScalingConfiguration Define a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** MaxCapacity ** O número máximo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 32, 32,5, 33, e assim por diante Tipo: duplo Obrigatório: Não ** MinCapacity ** O número mínimo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 8, 8,5, 9, e assim por diante Tipo: duplo Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) # ServerlessV2ScalingConfigurationInfo Recupera a configuração de escalabilidade para um cluster do Amazon DocumentDB Sem Servidor. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** MaxCapacity ** O número máximo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 32, 32,5, 33, e assim por diante Tipo: duplo Obrigatório: Não ** MinCapacity ** O número mínimo de unidades de capacidade do Amazon DocumentDB (DCUs) para uma instância em um cluster do Amazon DocumentDB Sem Servidor. É possível especificar valores de DCU em incrementos de meio passo, como 8, 8,5, 9, e assim por diante Tipo: duplo Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) # Subnet Informações detalhadas sobre uma sub-rede. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** SubnetAvailabilityZone ** Especifica a zona de disponibilidade da sub-rede. Tipo: objeto [AvailabilityZone](API_AvailabilityZone.md) Obrigatório: Não ** SubnetIdentifier ** Especifica o identificador da sub-rede. Tipo: String Obrigatório: Não ** SubnetStatus ** Especifica o status da sub-rede. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) # Tag Metadados atribuídos a um recurso do Amazon DocumentDB que consiste em um par de valores-chave. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** Key ** Nome obrigatório da tag. O valor da string pode ter de 1 a 128 caracteres Unicode e não pode ter os prefixos "`aws:`" ou "`rds:`". A string pode conter apenas o conjunto de letras em Unicode, dígitos, espaço em branco, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1"). Tipo: String Obrigatório: Não ** Value ** Valor de string opcional da tag. O valor da string pode ter de 1 a 256 caracteres Unicode e não pode ter os prefixos "`aws:`" ou "`rds:`". A string pode conter apenas o conjunto de letras em Unicode, dígitos, espaço em branco, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1"). Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) # UpgradeTarget A versão do mecanismo de banco de dados para a qual uma instância pode ser atualizada. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** AutoUpgrade ** Um valor que indica se a versão de destino é aplicada a todas as instâncias de banco de dados de origem que têm `AutoMinorVersionUpgrade` definido como `true`. Tipo: booliano Obrigatório: Não ** Description ** A versão do mecanismo de banco de dados para a qual uma instância pode ser atualizada. Tipo: String Obrigatório: Não ** Engine ** O nome do mecanismo de banco de dados de destino de atualização. Tipo: String Obrigatório: Não ** EngineVersion ** O número da versão do mecanismo de banco de dados de destino de atualização. Tipo: String Obrigatório: Não ** IsMajorVersionUpgrade ** Um valor que indica se um mecanismo de banco de dados é atualizado para uma versão principal. Tipo: booliano Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) # VpcSecurityGroupMembership Usado como elemento de resposta para consultas sobre membros do grupo de segurança da nuvem privada virtual (VPC). ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** Status ** O status do grupo de segurança da VPC. Tipo: String Obrigatório: Não ** VpcSecurityGroupId ** O nome do grupo de segurança da VPC. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) # Amazon DocumentDB Elastic Clusters Os seguintes tipos de dados são definidos pelo Amazon DocumentDB Elastic Clusters: + [Cluster](API_elastic_Cluster.md) + [ClusterInList](API_elastic_ClusterInList.md) + [ClusterSnapshot](API_elastic_ClusterSnapshot.md) + [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) + [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) + [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) + [Shard](API_elastic_Shard.md) + [ValidationExceptionField](API_elastic_ValidationExceptionField.md) # Cluster Retorna informações sobre um cluster elástico específico. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** adminUserName ** O nome do administrador do cluster elástico. Tipo: string Obrigatório: Sim ** authType ** O tipo de autenticação do cluster elástico. Tipo: String Valores válidos: `PLAIN_TEXT | SECRET_ARN` Obrigatório: Sim ** clusterArn ** O identificador ARN do cluster elástico. Tipo: string Obrigatório: Sim ** clusterEndpoint ** O URL usado para se conectar ao cluster elástico. Tipo: string Obrigatório: Sim ** clusterName ** O nome do cluster elástico. Tipo: String Obrigatório: Sim ** createTime ** Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC). Tipo: string Obrigatório: Sim ** kmsKeyId ** O identificador de chave do KMS a ser usado para criptografar o cluster elástico. Tipo: string Obrigatório: Sim ** preferredMaintenanceWindow ** O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC). *Formato*: `ddd:hh24:mi-ddd:hh24:mi` Tipo: string Obrigatório: Sim ** shardCapacity ** O número de vCPUs atribuídas a cada fragmento de cluster elástico. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64. Tipo: Inteiro Obrigatório: Sim ** shardCount ** O número de fragmentos atribuídos ao cluster elástico. O máximo é 32. Tipo: inteiro Obrigatório: Sim ** status ** O status do cluster elástico. Tipo: String Valores Válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` Obrigatório: Sim ** subnetIds ** Os IDs de sub-rede do Amazon EC2 do cluster elástico. Tipo: matriz de strings Obrigatório: Sim ** vpcSecurityGroupIds ** Uma lista de grupos de segurança da VPC do EC2 associados a esse cluster elástico. Tipo: matriz de strings Obrigatório: Sim ** backupRetentionPeriod ** O número de dias durante os quais os snapshots automáticos são retidos. Tipo: inteiro Obrigatório: Não ** preferredBackupWindow ** O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem ativados, conforme determinado por `backupRetentionPeriod`. Tipo: String Obrigatório: Não ** shardInstanceCount ** O número de instâncias de réplica que se aplicam a todos os fragmentos no cluster. O valor 1 de `shardInstanceCount` significa que há uma instância gravadora, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade. Tipo: inteiro Obrigatório: Não ** shards ** O número total de fragmentos no cluster. Tipo: matriz de objetos [Shard](API_elastic_Shard.md) Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) # ClusterInList Uma lista de clusters elásticos do Amazon DocumentDB. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** clusterArn ** O identificador ARN do cluster elástico. Tipo: string Obrigatório: Sim ** clusterName ** O nome do cluster elástico. Tipo: String Obrigatório: Sim ** status ** O status do cluster elástico. Tipo: String Valores Válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` Exigido: Sim ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) # ClusterSnapshot Retorna informações sobre um snapshot de cluster elástico específico. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** adminUserName ** O nome do administrador do cluster elástico. Tipo: string Obrigatório: Sim ** clusterArn ** O identificador ARN do cluster elástico. Tipo: string Obrigatório: Sim ** clusterCreationTime ** Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC). Tipo: string Obrigatório: Sim ** kmsKeyId ** O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando um cluster usando a mesma conta da Amazon que possui essa chave de criptografia KMS, poderá usar o alias da chave KMS em vez do ARN como chave de criptografia KMS. Se uma chave de criptografia não for especificada aqui, o Amazon DocumentDB usará a chave de criptografia padrão que o KMS cria para sua conta. Sua conta tem uma chave de criptografia padrão diferente para cada região da Amazon. Tipo: string Obrigatório: Sim ** snapshotArn ** O identificador ARN do snapshot do cluster elástico. Tipo: string Obrigatório: Sim ** snapshotCreationTime ** A hora em que o snapshot do cluster elástico foi criado, no Tempo Universal Coordenado (UTC). Tipo: string Obrigatório: Sim ** snapshotName ** O nome do snapshot do cluster elástico. Tipo: string Obrigatório: Sim ** status ** O status do snapshot do cluster elástico. Tipo: String Valores Válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` Obrigatório: Sim ** subnetIds ** Os IDs de sub-rede do Amazon EC2 do cluster elástico. Tipo: matriz de strings Obrigatório: Sim ** vpcSecurityGroupIds ** Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse cluster elástico. Tipo: Matriz de strings Obrigatório: Sim ** snapshotType ** O tipo de snapshots de cluster a ser retornado. É possível especificar um dos seguintes valores: + `automated`: retorna todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para sua conta da AWS. + `manual` - Retorna todos os snapshots de cluster que você criou manualmente para sua conta da AWS. Tipo: String Valores Válidos: `MANUAL | AUTOMATED` Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) # ClusterSnapshotInList Uma lista de snapshots de cluster elástico. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** clusterArn ** O identificador ARN do cluster elástico. Tipo: string Obrigatório: Sim ** snapshotArn ** O identificador ARN do snapshot do cluster elástico. Tipo: string Obrigatório: Sim ** snapshotCreationTime ** A hora em que o snapshot do cluster elástico foi criado, no Tempo Universal Coordenado (UTC). Tipo: string Obrigatório: Sim ** snapshotName ** O nome do snapshot do cluster elástico. Tipo: string Obrigatório: Sim ** status ** O status do snapshot do cluster elástico. Tipo: String Valores Válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` Exigido: Sim ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) # PendingMaintenanceActionDetails Recupera os detalhes das ações de manutenção que estão pendentes. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** action ** Exibe a ação específica de uma ação de manutenção pendente. Tipo: string Obrigatório: Sim ** autoAppliedAfterDate ** Exibe a data da janela de manutenção em que a ação é aplicada. A ação de manutenção é aplicada ao recurso durante a primeira janela de manutenção após essa data. Se essa data for especificada, todas as solicitações `NEXT_MAINTENANCE` `optInType` serão ignoradas. Tipo: String Obrigatório: Não ** currentApplyDate ** Exibe a data de início de vigência quando a ação de manutenção pendente é aplicada ao recurso. Tipo: String Obrigatório: Não ** description ** Exibe uma descrição que fornece mais detalhes sobre a ação de manutenção. Tipo: String Obrigatório: Não ** forcedApplyDate ** Exibe a data em que a ação de manutenção é aplicada automaticamente. A ação de manutenção é aplicada ao recurso nessa data, independentemente da janela de manutenção para o recurso. Se essa data for especificada, todas as solicitações `IMMEDIATE` `optInType` serão ignoradas. Tipo: String Obrigatório: Não ** optInStatus ** Exibe o tipo de solicitação de `optInType` que foi recebida para o recurso. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) # ResourcePendingMaintenanceAction Fornece informações sobre uma ação de manutenção pendente para um recurso. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** pendingMaintenanceActionDetails ** Fornece informações sobre uma ação de manutenção pendente para um recurso. Tipo: matriz de objetos [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) Obrigatório: Não ** resourceArn ** O nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica. Tipo: String Obrigatório: Não ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) # Shard O nome do fragmento. ## Conteúdo **nota** Na lista a seguir, os parâmetros necessários são descritos primeiro. ** createTime ** A hora em que o fragmento foi criado, no Tempo Universal Coordenado (UTC). Tipo: string Obrigatório: Sim ** shardId ** O ID do fragmento. Tipo: string Obrigatório: Sim ** status ** O status atual do fragmento. Tipo: String Valores Válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` Exigido: Sim ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) # ValidationExceptionField Um campo específico no qual ocorreu uma determinada exceção de validação. ## Conteúdo **nota** Na lista a seguir, os parâmetros obrigatórios são descritos primeiro. ** message ** Uma mensagem de erro descrevendo a exceção de validação nesse campo. Tipo: string Obrigatório: Sim ** name ** O nome do campo no qual ocorreu a exceção de validação. Tipo: string Obrigatório: Sim ## Consulte também Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField)