AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
New-DOCEventSubscription-SubscriptionName <String>-Enabled <Boolean>-EventCategory <String[]>-SnsTopicArn <String>-SourceId <String[]>-SourceType <String>-Tag <Tag[]>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
SourceType
) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds
) that trigger the events, and you can provide a list of event categories (EventCategories
) for events that you want to be notified of. For example, you can specify SourceType = db-instance
, SourceIds = mydbinstance1, mydbinstance2
and EventCategories = Availability, Backup
.
If you specify both the SourceType
and SourceIds
(such as SourceType = db-instance
and SourceIdentifier = myDBInstance1
), you are notified of all the db-instance
events for the specified source. If you specify a SourceType
but do not specify a SourceIdentifier
, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType
or the SourceIdentifier
, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account. true
to activate the subscription, set to false
to create the subscription but not active it. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
SourceType
that you want to subscribe to. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EventCategories |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
SourceIds
are provided, SourceType
must also be provided.DBInstanceIdentifier
must be provided.DBSecurityGroupName
must be provided.DBParameterGroupName
must be provided.DBSnapshotIdentifier
must be provided.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceIds |
db-instance
. If this value is not specified, all events are returned.Valid values: db-instance
, db-cluster
, db-parameter-group
, db-security-group
, db-cluster-snapshot
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z