CreateEventSubscription - Amazon DocumentDB
Parâmetros da solicitaçãoElementos de RespostaErrosConsulte Também

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á.

CreateEventSubscription

Cria uma assinatura de notificação de evento do Amazon DocumentDB. Essa ação exige um AFRN (nome de recurso da Amazon) de tópico criado pelo console do Amazon DocumentDB, pelo console do SNS ou pela API do SNS. Para obter um ARN com o SNS, crie um tópico no Amazon SNS e assine o ao tópico. O ARN é exibido no console do Amazon SNS.

Você pode especificar o tipo de origem (SourceType) sobre o qual deseja ser notificado. Você também pode fornecer uma lista das fontes do Amazon DocumentDB (SourceIds) que acionam os eventos, e você pode fornecer uma lista de categorias de eventos (EventCategories) para eventos sobre os quais você deseja ser notificado. Por exemplo, é possível especificar SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 e EventCategories = Availability, Backup.

Se você especificar o SourceType e SourceIds (como SourceType = db-instance e SourceIdentifier = myDBInstance1), você será notificado de todos os eventos db-instance da fonte especificada. Se você especificar um SourceType, mas não especificar uma SourceIdentifier, você receberá um aviso dos eventos desse tipo de origem para todas as suas origens do Amazon DocumentDB. Se você não especificar o SourceType ou o SourceIdentifier, você receberá notificações de eventos gerados de todas as origens do Amazon DocumentDB que pertencem à sua conta de cliente.

Parâmetros da solicitação

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.

SnsTopicArn

O Amazon Resource Name (ARN) do tópico do SNS criado para notificação de eventos. O Amazon SNS cria o SNS quando você cria um tópico e o assina.

Tipo: string

Obrigatório: Sim

SubscriptionName

O nome da inscrição.

Restrições: o nome deve ter menos de 255 caracteres.

Tipo: string

Obrigatório: Sim

Enabled

Um valor booliano, definido como true para ativar a assinatura, e definido como false para criar a assinatura, mas não ativá-la.

Tipo: booliano

Obrigatório: não

EventCategories. EventCategoryN.

Uma lista de categorias de eventos para um SourceType em que você deseja se inscrever.

Tipo: Matriz de strings

Obrigatório: não

SourceIds. SourceIdN.

A lista de identificadores das origens de eventos para as quais os eventos são retornados. Se não for especificado, todas as origens serão incluídas na resposta. Um identificador deve começar com uma letra e conter apenas letras ASCII, dígitos e hifens e não terminar com um hífen nem conter dois hifens consecutivos.

Restrições:

  • Se SourceIds forem fornecidos, SourceType também deve ser fornecido.

  • Se o tipo de fonte for uma instância, um DBInstanceIdentifier deverá ser fornecido.

  • Se o tipo de origem for um grupo de segurança, um DBSecurityGroupName deverá ser fornecido.

  • Se o tipo de origem for um grupo de parâmetros, um DBParameterGroupName deverá ser fornecido.

  • Se o tipo de origem for um snapshot, um DBSnapshotIdentifier deverá ser fornecido.

Tipo: matriz de strings

Obrigatório: não

SourceType

O tipo de origem gerando os eventos. Por exemplo, caso você queira ser notificado de eventos gerados por uma instância, defina esse parâmetro como db-instance. Se esse valor não for especificado, todos os eventos serão retornados.

Valores válidos: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

Tipo: sequência

Obrigatório: não

Tags.Tag.N

Uma ou mais tags a serem atribuídas à assinatura do evento.

Tipo: matriz de objetos Tag

Obrigatório: não

Elementos de Resposta

O elemento a seguir é retornado pelo serviço.

EventSubscription

Informações detalhadas sobre um evento em você se inscreveu.

Tipo: objeto EventSubscription

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

EventSubscriptionQuotaExceeded

O número máximo de assinaturas de eventos.

Código de Status HTTP: 400

SNSInvalidTopic

O Amazon SNS respondeu que há um problema com o tópico especificado.

Código de Status HTTP: 400

SNSNoAuthorization

Você não tem permissão para publicar no tópico do SNS nome do recurso da Amazon (ARN).

Código de Status HTTP: 400

SNSTopicArnNotFound

Não existe o tópico SNS nome do recurso da Amazon (ARN).

Código de Status HTTP: 404

SourceNotFound

Não foi possível encontrar a origem solicitada.

Código de Status HTTP: 404

SubscriptionAlreadyExist

O nome da assinatura fornecido já existe.

Código de Status HTTP: 400

SubscriptionCategoryNotFound

A categoria fornecida não existe.

Código de Status HTTP: 404

Consulte Também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: