You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScaling::NotificationConfiguration

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(group_name, type, topic_arn, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(group_name, type, topic_arn, options = {}) ⇒ Object

    Parameters:

    • group_name (String)
    • type (String)
    • topic_arn (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :group_name (required, String)
    • :type (required, String)
    • :topic_arn (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#auto_scaling_group_nameString (readonly)

The name of the group.

Returns:

  • (String)

    The name of the group.

#group_nameString (readonly)

Returns:

  • (String)

#notification_typeString (readonly)

One of the following event notification types:

  • autoscaling:EC2_INSTANCE_LAUNCH

  • autoscaling:EC2_INSTANCE_LAUNCH_ERROR

  • autoscaling:EC2_INSTANCE_TERMINATE

  • autoscaling:EC2_INSTANCE_TERMINATE_ERROR

  • autoscaling:TEST_NOTIFICATION

Returns:

  • (String)

    One of the following event notification types:.

#topic_arnString (readonly)

Returns:

  • (String)

#typeString (readonly)

Returns:

  • (String)

Instance Method Details

#deleteStruct

Deletes the specified notification.

Examples:

Request syntax example with placeholder values


notificationconfiguration.delete()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#groupAutoScalingGroup

Returns:

#putStruct

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.

Examples:

Request syntax example with placeholder values


notificationconfiguration.put()

Returns:

  • (Struct)

    Returns an empty response.

See Also: