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.

Write-ASNotificationConfiguration Cmdlet

Auto Scaling

Search:

Synopsis

Calls the Auto Scaling PutNotificationConfiguration API operation.

Syntax

Write-ASNotificationConfiguration

-AutoScalingGroupName <String>

-TopicARN <String>

-NotificationType <String[]>

-PassThru <SwitchParameter>

-Force <SwitchParameter>

Description

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information see Getting SNS Notifications When Your Auto Scaling Group Scales in the Auto Scaling User Guide.

Used to specify the name and location of the ini-format credential file (shared with
the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential
file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first.
If the profile is not found then the cmdlet will search in the ini-format credential
file at the default location: (user's home directory)\.aws\credentials.
Note that the encrypted credential file is not supported on all platforms.
It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential
file at the location given.

As the current folder can vary in a shell or during script execution it is advised
that you use specify a fully qualified path instead of a relative path.

The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.

Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for
normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region
parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must
direct the call to a specific custom endpoint.

Required?

False

Position?

Named

Accept pipeline input?

False

Inputs

You can pipe a String object to this cmdlet for the AutoScalingGroupName parameter.

Outputs

None or System.String

When you use the PassThru parameter, this cmdlet outputs the value supplied to the AutoScalingGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.AutoScaling.Model.PutNotificationConfigurationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.