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

Class: Aws::SNS::Types::SubscribeInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SubscribeInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  topic_arn: "topicARN", # required
  protocol: "protocol", # required
  endpoint: "endpoint",
}

Input for Subscribe action.

Instance Attribute Summary collapse

Instance Attribute Details

#endpointString

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with \"http://%22

  • For the https protocol, the endpoint is a URL beginning with \"https://%22

  • For the email protocol, the endpoint is an email address

  • For the email-json protocol, the endpoint is an email address

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

Returns:

  • (String)

    The endpoint that you want to receive notifications.

#protocolString

The protocol you want to use. Supported protocols include:

  • http -- delivery of JSON-encoded message via HTTP POST

  • https -- delivery of JSON-encoded message via HTTPS POST

  • email -- delivery of message via SMTP

  • email-json -- delivery of JSON-encoded message via SMTP

  • sms -- delivery of message via SMS

  • sqs -- delivery of JSON-encoded message to an Amazon SQS queue

  • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.

  • lambda -- delivery of JSON-encoded message to an AWS Lambda function.

Returns:

  • (String)

    The protocol you want to use.

#topic_arnString

The ARN of the topic you want to subscribe to.

Returns:

  • (String)

    The ARN of the topic you want to subscribe to.