com.amazonaws.services.rds.model

## クラス CreateEventSubscriptionRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.rds.model.CreateEventSubscriptionRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class CreateEventSubscriptionRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  `CreateEventSubscription operation` のためのパラメータ用コンテナ。

  イベントサブスクリプションを新規作成します。

  通知を行うイベントのソースタイプ(SourceType)、DBインスタンスやDBパラメーターグループなどのソースID(SourceIds)や イベントカテゴリなどを指定して受け取りたいイベントを指定します。例として以下のように指定します。
  SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2, and EventCategories = Availability, Backup.

  「SourceType = db-instance」にしてSourceIdsで「myDBInstance1」を指定したような場合は、 指定されたソースIDに関するdb-instanceカテゴリのイベントがすべて通知されます。 SourceIdsパラメータを省略すると、すべてのDBインスタンスについてイベントが通知されます。 すべてのパラメータを省略した場合は、すべてのDBインスタンスについてすべてのイベントが通知されます。

  関連項目:
    `AmazonRDS.createEventSubscription(CreateEventSubscriptionRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `CreateEventSubscriptionRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.Boolean` | `getEnabled()` 通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse
    `java.util.List<java.lang.String>` | `getEventCategories()` 通知を行うイベントカテゴリのリスト。
    `java.lang.String` | `getNiftyDescription()` イベントサブスクリプション設定の注釈。
    `java.util.List<java.lang.String>` | `getNiftyEmailAddresses()` イベント通知先のメールアドレスを指定します。
    `java.lang.String` | `getSnsTopicArn()` The Amazon Resource Name (ARN) of the SNS topic created for event notification.
    `java.util.List<java.lang.String>` | `getSourceIds()` 通知を行うソースIDのリスト。
    `java.lang.String` | `getSourceType()` 通知を行うイベントのソースタイプ。
    `java.lang.String` | `getSubscriptionName()` イベントサブスクリプション名。
    `int` | `hashCode()`
    `java.lang.Boolean` | `isEnabled()` 通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse
    `void` | `setEnabled(java.lang.Boolean enabled)` 通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse
    `void` | `setEventCategories(java.util.Collection<java.lang.String> eventCategories)` 通知を行うイベントカテゴリのリスト。
    `void` | `setNiftyDescription(java.lang.String niftyDescription)` イベントサブスクリプション設定の注釈。
    `void` | `setNiftyEmailAddresses(java.util.Collection<java.lang.String> niftyEmailAddresses)` イベント通知先のメールアドレスを指定します。
    `void` | `setSnsTopicArn(java.lang.String snsTopicArn)` The Amazon Resource Name (ARN) of the SNS topic created for event notification.
    `void` | `setSourceIds(java.util.Collection<java.lang.String> sourceIds)` 通知を行うソースIDのリスト。
    `void` | `setSourceType(java.lang.String sourceType)` 通知を行うイベントのソースタイプ。
    `void` | `setSubscriptionName(java.lang.String subscriptionName)` イベントサブスクリプション名。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。
    `CreateEventSubscriptionRequest` | `withEnabled(java.lang.Boolean enabled)` 通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。
    `CreateEventSubscriptionRequest` | `withEventCategories(java.util.Collection<java.lang.String> eventCategories)` 通知を行うイベントカテゴリのリスト。
    `CreateEventSubscriptionRequest` | `withEventCategories(java.lang.String... eventCategories)` 通知を行うイベントカテゴリのリスト。
    `CreateEventSubscriptionRequest` | `withNiftyDescription(java.lang.String niftyDescription)` イベントサブスクリプション設定の注釈。
    `CreateEventSubscriptionRequest` | `withNiftyEmailAddresses(java.util.Collection<java.lang.String> niftyEmailAddresses)` イベント通知先のメールアドレスを指定します。
    `CreateEventSubscriptionRequest` | `withNiftyEmailAddresses(java.lang.String... niftyEmailAddresses)` イベント通知先のメールアドレスを指定します。
    `CreateEventSubscriptionRequest` | `withSnsTopicArn(java.lang.String snsTopicArn)` The Amazon Resource Name (ARN) of the SNS topic created for event notification.
    `CreateEventSubscriptionRequest` | `withSourceIds(java.util.Collection<java.lang.String> sourceIds)` 通知を行うソースIDのリスト。
    `CreateEventSubscriptionRequest` | `withSourceIds(java.lang.String... sourceIds)` 通知を行うソースIDのリスト。
    `CreateEventSubscriptionRequest` | `withSourceType(java.lang.String sourceType)` 通知を行うイベントのソースタイプ。
    `CreateEventSubscriptionRequest` | `withSubscriptionName(java.lang.String subscriptionName)` イベントサブスクリプション名。

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### CreateEventSubscriptionRequest

          public CreateEventSubscriptionRequest()

  - ### メソッドの詳細

    - #### getSubscriptionName

          public java.lang.String getSubscriptionName()

      イベントサブスクリプション名。

      イベントサブスクリプション名は255文字より少ない必要があります。

      戻り値:
        イベントサブスクリプション名。

        イベントサブスクリプション名は255文字より少ない必要があります。

    - #### setSubscriptionName

          public void setSubscriptionName(java.lang.String subscriptionName)

      イベントサブスクリプション名。

      イベントサブスクリプション名は255文字より少ない必要があります。

      パラメータ:
        `subscriptionName` - イベントサブスクリプション名。

        イベントサブスクリプション名は255文字より少ない必要があります。

    - #### withSubscriptionName

          public CreateEventSubscriptionRequest withSubscriptionName(java.lang.String subscriptionName)

      イベントサブスクリプション名。

      イベントサブスクリプション名は255文字より少ない必要があります。

      このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

      パラメータ:
        `subscriptionName` - イベントサブスクリプション名。

        イベントサブスクリプション名は255文字より少ない必要があります。

    - #### getSnsTopicArn

          public java.lang.String getSnsTopicArn()

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
      戻り値:
        The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    - #### setSnsTopicArn

          public void setSnsTopicArn(java.lang.String snsTopicArn)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
      パラメータ:
        `snsTopicArn` - The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    - #### withSnsTopicArn

          public CreateEventSubscriptionRequest withSnsTopicArn(java.lang.String snsTopicArn)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `snsTopicArn` - The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    - #### getSourceType

          public java.lang.String getSourceType()

      通知を行うイベントのソースタイプ。 例として、DBインスタンスに関するイベントを受け取りたい場合は、"db-instance"を指定します。 省略された場合はすべてのイベントが返却されます。

      値：db-instance | db-parameter-group | db-security-group | db-snapshot

      戻り値:
        通知を行うイベントのソースタイプ。 例として、DBインスタンスに関するイベントを受け取りたい場合は、"db-instance"を指定します。 省略された場合はすべてのイベントが返却されます。

        値：db-instance | db-parameter-group | db-security-group | db-snapshot

    - #### setSourceType

          public void setSourceType(java.lang.String sourceType)

      通知を行うイベントのソースタイプ。 例として、DBインスタンスに関するイベントを受け取りたい場合は、"db-instance"を指定します。 省略された場合はすべてのイベントが返却されます。

      値：db-instance | db-parameter-group | db-security-group | db-snapshot

      パラメータ:
        `sourceType` - 通知を行うイベントのソースタイプ。 例として、DBインスタンスに関するイベントを受け取りたい場合は、"db-instance"を指定します。 省略された場合はすべてのイベントが返却されます。

        値：db-instance | db-parameter-group | db-security-group | db-snapshot

    - #### withSourceType

          public CreateEventSubscriptionRequest withSourceType(java.lang.String sourceType)

      通知を行うイベントのソースタイプ。 例として、DBインスタンスに関するイベントを受け取りたい場合は、"db-instance"を指定します。 省略された場合はすべてのイベントが返却されます。

      値：db-instance | db-parameter-group | db-security-group | db-snapshot このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

      パラメータ:
        `sourceType` - 通知を行うイベントのソースタイプ。 例として、DBインスタンスに関するイベントを受け取りたい場合は、"db-instance"を指定します。 省略された場合はすべてのイベントが返却されます。

        値：db-instance | db-parameter-group | db-security-group | db-snapshot

    - #### getEventCategories

          public java.util.List<java.lang.String> getEventCategories()

      通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。
      戻り値:
        通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。

    - #### setEventCategories

          public void setEventCategories(java.util.Collection<java.lang.String> eventCategories)

      通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。
      パラメータ:
        `eventCategories` - 通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。

    - #### withEventCategories

          public CreateEventSubscriptionRequest withEventCategories(java.lang.String... eventCategories)

      通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。 このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。
      パラメータ:
        `eventCategories` - 通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。

    - #### withEventCategories

          public CreateEventSubscriptionRequest withEventCategories(java.util.Collection<java.lang.String> eventCategories)

      通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。 このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。
      パラメータ:
        `eventCategories` - 通知を行うイベントカテゴリのリスト。 イベントカテゴリーとソースタイプについては、ユーザーガイドの イベントを参照するか、 DescribeEventCategories を使用して参照してください。

    - #### getSourceIds

          public java.util.List<java.lang.String> getSourceIds()

      通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

      注意:

      - ソースIDを指定する場合は、SourceTypeも必須となります。
      - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
      - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
      - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
      - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。
      戻り値:
        通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

        注意:

        - ソースIDを指定する場合は、SourceTypeも必須となります。
        - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
        - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
        - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
        - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。

    - #### setSourceIds

          public void setSourceIds(java.util.Collection<java.lang.String> sourceIds)

      通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

      注意:

      - ソースIDを指定する場合は、SourceTypeも必須となります。
      - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
      - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
      - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
      - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。
      パラメータ:
        `sourceIds` - 通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

        注意:

        - ソースIDを指定する場合は、SourceTypeも必須となります。
        - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
        - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
        - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
        - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。

    - #### withSourceIds

          public CreateEventSubscriptionRequest withSourceIds(java.lang.String... sourceIds)

      通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

      注意:

      - ソースIDを指定する場合は、SourceTypeも必須となります。
      - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
      - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
      - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
      - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。
      このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。
      パラメータ:
        `sourceIds` - 通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

        注意:

        - ソースIDを指定する場合は、SourceTypeも必須となります。
        - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
        - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
        - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
        - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。

    - #### withSourceIds

          public CreateEventSubscriptionRequest withSourceIds(java.util.Collection<java.lang.String> sourceIds)

      通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

      注意:

      - ソースIDを指定する場合は、SourceTypeも必須となります。
      - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
      - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
      - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
      - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。
      このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。
      パラメータ:
        `sourceIds` - 通知を行うソースIDのリスト。 省略された場合はすべてのリソースが含まれます。 ソースIDにはアルファベット・数字・ハイフンが使用できます; 末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

        注意:

        - ソースIDを指定する場合は、SourceTypeも必須となります。
        - SourceTypeがdb-instanceの場合は、DBInstanceIdentifierを必ず指定してください。
        - SourceTypeがdb-security-groupの場合は、DBSecurityGroupNameを必ず指定してください。
        - SourceTypeがdb-parameter-groupの場合は、DBParameterGroupNameを必ず指定してください。
        - SourceTypeがdb-snapshotの場合は、DBSnapshotIdentifierを必ず指定してください。

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse
      戻り値:
        通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse

    - #### setEnabled

          public void setEnabled(java.lang.Boolean enabled)

      通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse
      パラメータ:
        `enabled` - 通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse

    - #### withEnabled

          public CreateEventSubscriptionRequest withEnabled(java.lang.Boolean enabled)

      通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。
      パラメータ:
        `enabled` - 通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse

    - #### getEnabled

          public java.lang.Boolean getEnabled()

      通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse
      戻り値:
        通知を行うかどうか 通知を行う場合はtrue、通知を作成するが非アクティブにしておく場合はfalse

    - #### getNiftyEmailAddresses

          public java.util.List<java.lang.String> getNiftyEmailAddresses()

      イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)
      戻り値:
        イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)

    - #### setNiftyEmailAddresses

          public void setNiftyEmailAddresses(java.util.Collection<java.lang.String> niftyEmailAddresses)

      イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)
      パラメータ:
        `niftyEmailAddresses` - イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)

    - #### withNiftyEmailAddresses

          public CreateEventSubscriptionRequest withNiftyEmailAddresses(java.lang.String... niftyEmailAddresses)

      イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)

      このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

      パラメータ:
        `niftyEmailAddresses` - イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)

    - #### withNiftyEmailAddresses

          public CreateEventSubscriptionRequest withNiftyEmailAddresses(java.util.Collection<java.lang.String> niftyEmailAddresses)

      イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)

      このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

      パラメータ:
        `niftyEmailAddresses` - イベント通知先のメールアドレスを指定します。(ニフティクラウド独自仕様)

    - #### getNiftyDescription

          public java.lang.String getNiftyDescription()

      イベントサブスクリプション設定の注釈。(ニフティクラウド独自仕様)
      戻り値:
        イベントサブスクリプション設定の注釈。(ニフティクラウド独自仕様)

    - #### setNiftyDescription

          public void setNiftyDescription(java.lang.String niftyDescription)

      イベントサブスクリプション設定の注釈。(ニフティクラウド独自仕様)
      パラメータ:
        `niftyDescription` - イベントサブスクリプション設定の注釈。(ニフティクラウド独自仕様)

    - #### withNiftyDescription

          public CreateEventSubscriptionRequest withNiftyDescription(java.lang.String niftyDescription)

      イベントサブスクリプション設定の注釈。(ニフティクラウド独自仕様)

      このオブジェクトへの参照を返すためのメソッド呼び出しを連結することができます。

      パラメータ:
        `niftyDescription` - イベントサブスクリプション設定の注釈。(ニフティクラウド独自仕様)

    - #### toString

          public java.lang.String toString()

      このオブジェクトの文字列表現を返します。テストやデバッグに利用します。
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        このオブジェクトの文字列表現。
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`