Amazon RDS Connector リファレンス - Mule 4

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

Amazon RDS Connector v1.3

Amazon RDS 用 Anypoint Connector (Amazon RDS Connector) は、Amazon Relational Database Service (Amazon RDS) API への接続を提供し、ハードウェアプロビジョニング、データベースセットアップ、パッチ設定、バックアップなどの時間のかかる管理作業を自動化する一方で、Amazon RDS と連携してコスト効率の高いサイズ変更可能な容量を提供できます。

設定


デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、インスタンスがパージされます。

接続種別

Basic (基本)

パラメーター

名前 説明 デフォルト値 必須

Session Token (セッショントークン)

String (文字列)

Amazon STS が提供するセッショントークン。

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがギブアップまたはタイムアウトする前に、接続を最初に確立するのを待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Max Connections (最大接続数)

Number (数値)

許可される開いた HTTP 接続の最大数を設定します。

Socket Timeout (ソケットタイムアウト)

Number (数値)

接続がタイムアウトする前に、確立または開いた接続でのデータの転送を待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Access Key (アクセスキー)

String (文字列)

Amazon が提供するアクセスキー。

x

Secret Key (シークレットキー)

String (文字列)

Amazon が提供するシークレットキー。

x

Try Default AWSCredentials Provider Chain (デフォルトの AWSCredentials プロバイダーチェーンを試す)

Boolean (ブール)

AWS 環境からログイン情報を取得するには、この項目を true に設定します。​https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html​ を参照してください。

false

Region Endpoint (リージョンエンドポイント)

String (文字列)

トピックリージョンエンドポイントを設定します。

US_EAST​_1

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Host (ホスト)

String (文字列)

省略可能なプロキシホスト。

Port (ポート)

Number (数値)

省略可能なプロキシポート。

Username (ユーザー名)

String (文字列)

省略可能なプロキシユーザー名。

Password (パスワード)

String (文字列)

省略可能なプロキシパスワード。

Domain (ドメイン)

String (文字列)

省略可能なプロキシドメイン。

Workstation (ワークステーション)

String (文字列)

省略可能なプロキシワークステーション。

Role (ロール)

パラメーター

名前 説明 デフォルト値 必須

Role ARN (ロール ARN)

String (文字列)

ロール ARN は、クロスアカウントアクセスを取得することを前提とするロールを一意に特定します。

x

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがギブアップまたはタイムアウトする前に、接続を最初に確立するのを待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Max Connections (最大接続数)

Number (数値)

許可される開いた HTTP 接続の最大数を設定します。

Socket Timeout (ソケットタイムアウト)

Number (数値)

接続がタイムアウトする前に、確立または開いた接続でのデータの転送を待機する時間 (ミリ秒)。値 0 は無限を意味するため、お勧めできません。

50000

Access Key (アクセスキー)

String (文字列)

Amazon が提供するアクセスキー。

x

Secret Key (シークレットキー)

String (文字列)

Amazon が提供するシークレットキー。

x

Try Default AWSCredentials Provider Chain (デフォルトの AWSCredentials プロバイダーチェーンを試す)

Boolean (ブール)

AWS 環境からログイン情報を取得するには、この項目を true に設定します。​https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html​ を参照してください。

false

Region Endpoint (リージョンエンドポイント)

String (文字列)

トピックリージョンエンドポイントを設定します。

US_EAST​_1

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Host (ホスト)

String (文字列)

省略可能なプロキシホスト。

Port (ポート)

Number (数値)

省略可能なプロキシポート。

Username (ユーザー名)

String (文字列)

省略可能なプロキシユーザー名。

Password (パスワード)

String (文字列)

省略可能なプロキシパスワード。

Domain (ドメイン)

String (文字列)

省略可能なプロキシドメイン。

Workstation (ワークステーション)

String (文字列)

省略可能なプロキシワークステーション。

Create DB Instance

<rds:create-db-instance>

この操作は、新しいデータベースインスタンスを作成します。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Auto Minor Version Upgrade (マイナーバージョンの自動アップグレード)

Boolean (ブール)

false

Copy Tags to Snapshot (タグをスナップショットにコピー)

Boolean (ブール)

false

Storage Type (ストレージの種別)

String (文字列)

Allocated Storage (割り当てられたストレージ)

Number (数値)

Backup Retention Period (バックアップ保持期間)

Number (数値)

Preferred Backup Window (優先されるバックアップウィンドウ)

String (文字列)

Preferred Maintenance Window (優先されるメンテナンスウィンドウ)

String (文字列)

Promotion Tier (昇格階層)

Number (数値)

Storage Encrypted (ストレージ暗号化)

Boolean (ブール)

false

DB Cluster Identifier (DB クラスター識別子)

String (文字列)

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

Domain IAM Role Name (ドメイン IAM ロール名)

String (文字列)

Enable IAM Database Authentication (IAM データベース認証を有効化)

Boolean (ブール)

false

License Model (ライセンスモデル)

String (文字列)

Publicly Accessible (一般公開)

Boolean (ブール)

false

TDE Credential ARN (TDE ログイン情報 ARN)

String (文字列)

TDE Credential Password (TDE ログイン情報パスワード)

String (文字列)

DB Security Groups (DB セキュリティグループ)

Array of String (文字列の配列)

Master User Password (マスターユーザーパスワード)

String (文字列)

VPC Security Group IDs (VPC セキュリティグループ ID)

Array of String (文字列の配列)

Master User Name (マスターユーザー名)

String (文字列)

KMS Key ID (KMS キー ID)

String (文字列)

Monitoring Interval (監視期間)

Number (数値)

Monitoring Role ARN (監視ロール ARN)

String (文字列)

DB Instance Class (DB インスタンスクラス)

String (文字列)

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

x

DB Parameter Group Name (DB パラメーターグループ名)

String (文字列)

Domain (ドメイン)

String (文字列)

Engine Version (エンジンバージョン)

String (文字列)

IOPS

Number (数値)

Multi AZ (マルチ AZ)

Boolean (ブール)

false

Option Group Name (オプショングループ名)

String (文字列)

Availability Zone (可用性ゾーン)

String (文字列)

DB Name (DB 名)

String (文字列)

DB Port Number (DB ポート番号)

Number (数値)

Engine (エンジン)

String (文字列)

x

Character Set Name (文字セット名)

String (文字列)

タグ

Tag (タグ)​ の配列

Time Zone (タイムゾーン)

String (文字列)

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Create DB Instance Read Replica

<rds:create-db-instance-read-replica>

この操作は、既存の複製元 DB インスタンスのリードレプリカとして機能する新しい DB インスタンスを作成します。MySQL、MariaDB、または PostgreSQL を実行している DB インスタンスのリードレプリカを作成できます。

Amazon Aurora ではこのアクションはサポートされていません。Aurora DB クラスターの DB インスタンスを作成するには、​CreateDBInstance​ アクションをコールする必要があります。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Publicly Accessible (一般公開)

Boolean (ブール)

DB インスタンスのアクセシビリティオプションを指定します。

false

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

DB インスタンスの DB サブネットグループを指定します。

KMS Key ID (KMS キー ID)

String (文字列)

暗号化されたリードレプリカの AWS KMS キー ID。

Pre-Signed URL (署名付き URL)

String (文字列)

複製元 DB インスタンスを含む複製元 AWS リージョン内の create-db-instance-read-replica API アクションに対する、署名バージョン 4 署名付き要求を含む URL。

Enable IAM Database Authentication (IAM データベース認証を有効化)

Boolean (ブール)

AWS Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングを有効にする場合、このパラメーターを ​true​ に設定します。

false

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

リードレプリカの DB インスタンス識別子。

x

Source DB Instance Identifier (復元元 DB インスタンス識別子)

String (文字列)

リードレプリカの複製元として機能する DB インスタンスの識別子。

x

DB Instance Class (DB インスタンスクラス)

String (文字列)

リードレプリカの計算容量およびメモリ容量。

Availability Zone (可用性ゾーン)

String (文字列)

リードレプリカが作成される Amazon EC2 可用性ゾーン。

Port (ポート)

Number (数値)

DB インスタンスが接続に使用するポート番号。

IOPS

Number (数値)

DB インスタンスに最初に割り当てられるプロビジョニングされた IOPS (1 秒あたりの入出力操作) の量。

Option Group Name (オプショングループ名)

String (文字列)

DB インスタンスが関連付けられるオプショングループ。

タグ

Tag (タグ)​ の配列

タグのリスト。

Source Region (複製元リージョン)

String (文字列)

リードレプリカの複製元を含むリージョンの ID。

Auto Minor Version Upgrade (マイナーバージョンの自動アップグレード)

Boolean (ブール)

false

Copy Tags to Snapshot (タグをスナップショットにコピー)

Boolean (ブール)

false

Storage Type (ストレージの種別)

String (文字列)

Monitoring Interval (監視期間)

Number (数値)

Monitoring Role ARN (監視ロール ARN)

String (文字列)

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Create DB Snapshot

<rds:create-db-snapshot>

この操作は、DBSnapshot を作成します。複製元 DBInstance が使用可能な状態である必要があります。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

DB インスタンス識別子。DB インスタンスを識別する一意のキー。

x

DB Snapshot Identifier (DB スナップショット識別子)

String (文字列)

DB スナップショットの識別子。

x

タグ

Tag (タグ)​ の配列

タグのリスト。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Delete DB Instance

<rds:delete-db-instance>

Delete Db Instance アクションは、以前にプロビジョニングされた DB インスタンスを削除します。 詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

削除する DB インスタンスの DB インスタンス識別子。このパラメーターは大文字と小文字を区別しません。

x

Final DB Snapshot Identifier (最終 DB スナップショット識別子)

String (文字列)

SkipFinalSnapshot が false に設定されている場合に作成される新しい DBSnapshot の DBSnapshotIdentifier。

Skip Final Snapshot (最終スナップショットをスキップ)

Boolean (ブール)

DB インスタンスが削除される前に最終 DB スナップショットを作成するかどうかを決定します。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Delete DB Snapshot

<rds:delete-db-snapshot>

DBSnapshot を削除します。スナップショットがコピーされている場合、コピー操作は終了します。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Snapshot Identifier (DB スナップショット識別子)

String (文字列)

DB Snapshot Identifier (DB スナップショット識別子)。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Describe DB Instances

<rds:describe-db-instances>

プロビジョニングされた RDS インスタンスに関する情報を返します。この API ではページ設定がサポートされています。 詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

ユーザー指定のインスタンス識別子。

Filters (絞り込み)

検索条件​ の配列

表示する 1 つ以上の DB インスタンスを指定する検索条件。

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

DB Instance (DB インスタンス)​ ペイロードと ​Request ID Attribute (要求 ID 属性)​ 属性のメッセージの配列

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Describe DB Snapshots

<rds:describe-db-snapshots>

DB スナップショットに関する情報を返します。この API アクションではページ設定がサポートされています。 詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

DB スナップショットのリストを取得する DB インスタンスの ID。

DB Snapshot Identifier (DB スナップショット識別子)

String (文字列)

表示する特定の DB スナップショット識別子。このパラメーターを DBInstanceIdentifier と組み合わせて使用することはできません。

Include Public (公開済みを含める)

Boolean (ブール)

公開されており、任意の AWS アカウントでコピーまたは復元できる手動 DB スナップショットを含める場合、この値を true に設定します。それ以外の場合は、この値を false に設定します。デフォルトは false です。

false

Include Shared (共有済みを含める)

Boolean (ブール)

この AWS アカウントにコピーまたは復元の権限が付与されている他の AWS アカウントから共有された手動 DB スナップショットを含める場合、この値を true に設定します。それ以外の場合は、この値を false に設定します。デフォルトは false です。

false

Snapshot Type (スナップショット種別)

String (文字列)

返されるスナップショットの種別。

Max Records (最大レコード数)

Number (数値)

応答に含めるレコードの最大数。

Filters (絞り込み)

検索条件​ の配列

このパラメーターは現在サポートされていません。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

DB Snapshot (DB スナップショット)​ ペイロードと ​Request ID Attribute (要求 ID 属性)​ 属性のメッセージの配列

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Describe Events

<rds:describe-events>

過去 14 日間の DB インスタンス、DB セキュリティグループ、DB スナップショット、DB パラメーターグループに関連するイベントを返します。特定の DB インスタンス、DB セキュリティグループ、データベーススナップショット、または DB パラメーターグループに固有のイベントは、名前をパラメーターとして指定することで取得できます。デフォルトでは、過去 1 時間のイベントが返されます。 詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Duration (所要時間)

Number (数値)

イベントを取得する分数。

End Time (終了時刻)

DateTime

ISO 8601 形式で指定された、イベントを取得する期間の終了。

Event Categories (イベントカテゴリ)

Array of String (文字列の配列)

イベント通知サブスクリプションの通知をトリガーするイベントカテゴリのリスト。

Source Identifier (複製元識別子)

String (文字列)

イベントが返されるイベント取得元の識別子。指定しない場合、応答にはすべての取得元が含まれます。

Source Type (ソース種別)

String (文字列)

イベントを取得するイベント取得元。値を指定しない場合、すべてのイベントが返されます。

Start Time (開始時刻)

DateTime

ISO 8601 形式で指定された、イベントを取得する期間の開始。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Event (イベント)​ ペイロードと ​Request ID Attribute (要求 ID 属性)​ 属性のメッセージの配列

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Describe Reserved DB Instances

<rds:describe-reserved-db-instances>

このアカウントのリザーブド DB インスタンス、または指定されたリザーブド DB インスタンスに関する情報を返します。 詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reserved DB Instance ID (リザーブド DB インスタンス ID)

String (文字列)

リザーブド DB インスタンス識別子の条件値。

Reserved DB Instances Offering ID (リザーブド DB インスタンス提供 ID)

String (文字列)

提供識別子の条件値。指定した提供 ID と一致する購入済み予約のみを表示するには、このパラメーターを指定します。

DB Instance Class (DB インスタンスクラス)

String (文字列)

DB インスタンスクラスの条件値。指定した DB インスタンスクラスに一致する予約のみを表示するには、このパラメーターを指定します。

Duration (所要時間)

String (文字列)

年または秒で指定された所要時間の条件値。この所要時間の予約のみを表示するには、このパラメーターを指定します。

Product Description (製品説明)

String (文字列)

製品説明の条件値。指定した製品説明に一致する予約のみを表示するには、このパラメーターを指定します。

Offering Type (提供種別)

String (文字列)

提供種別の条件値。指定した提供種別と一致する使用可能な提供のみを表示するには、このパラメーターを指定します。

Multi AZ (マルチ AZ)

Boolean (ブール)

マルチ AZ の条件値。指定したマルチ AZ パラメーターに一致する予約のみを表示するには、このパラメーターを指定します。

false

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[​Reserved DB Instance (リザーブド DB インスタンス)​] ペイロードと ​Request ID Attribute (要求 ID 属性)​ 属性のメッセージの配列

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Describe Reserved DB Instances Offerings

<rds:describe-reserved-db-instances-offerings>

使用可能なリザーブド DB インスタンス提供をリストします。詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Class (DB インスタンスクラス)

String (文字列)

DB インスタンスクラスの条件値。指定した DB インスタンスクラスと一致する使用可能な提供のみを表示するには、このパラメーターを指定します。

Duration (所要時間)

String (文字列)

年または秒で指定された所要時間の条件値。この所要時間の予約のみを表示するには、このパラメーターを指定します。

Multi AZ (マルチ AZ)

Boolean (ブール)

マルチ AZ の条件値。指定したマルチ AZ パラメーターに一致する使用可能な提供のみを表示するには、このパラメーターを指定します。

false

Offering Type (提供種別)

String (文字列)

提供種別の条件値。指定した提供種別と一致する使用可能な提供のみを表示するには、このパラメーターを指定します。

Product Description (製品説明)

String (文字列)

製品説明の条件値。指定した製品説明と一致する使用可能な提供のみを表示するには、このパラメーターを指定します。

Reserved DB Instances Offering ID (リザーブド DB インスタンス提供 ID)

String (文字列)

提供識別子の条件値。指定した予約識別子と一致する使用可能な提供のみを表示するには、このパラメーターを指定します。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

[​Reserved DB Instances Offering (リザーブド DB インスタンス提供)​] ペイロードと ​Request ID Attribute (要求 ID 属性)​ 属性のメッセージの配列

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Modify DB Instance

<rds:modify-db-instance>

DB インスタンスの設定を変更します。要求でこれらのパラメーターと新しい値を指定することで、1 つ以上のデータベース設定パラメーターを変更できます。詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Auto Minor Version Upgrade (マイナーバージョンの自動アップグレード)

Boolean (ブール)

false

Copy Tags to Snapshot (タグをスナップショットにコピー)

Boolean (ブール)

false

Storage Type (ストレージの種別)

String (文字列)

Allocated Storage (割り当てられたストレージ)

Number (数値)

Backup Retention Period (バックアップ保持期間)

Number (数値)

Preferred Backup Window (優先されるバックアップウィンドウ)

String (文字列)

Preferred Maintenance Window (優先されるメンテナンスウィンドウ)

String (文字列)

Promotion Tier (昇格階層)

Number (数値)

Allow Major Version Upgrade (メジャーバージョンのアップグレードを許可)

Boolean (ブール)

false

Apply Immediately (すぐに適用)

Boolean (ブール)

false

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

Domain IAM Role Name (ドメイン IAM ロール名)

String (文字列)

Enable IAM Database Authentication (IAM データベース認証を有効化)

Boolean (ブール)

false

License Model (ライセンスモデル)

String (文字列)

Publicly Accessible (一般公開)

Boolean (ブール)

false

TDE Credential ARN (TDE ログイン情報 ARN)

String (文字列)

TDE Credential Password (TDE ログイン情報パスワード)

String (文字列)

DB Security Groups (DB セキュリティグループ)

Array of String (文字列の配列)

Master User Password (マスターユーザーパスワード)

String (文字列)

VPC Security Group IDs (VPC セキュリティグループ ID)

Array of String (文字列の配列)

CA Certificate Identifier (CA 証明書識別子)

String (文字列)

Monitoring Interval (監視期間)

Number (数値)

Monitoring Role ARN (監視ロール ARN)

String (文字列)

DB Instance Class (DB インスタンスクラス)

String (文字列)

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

x

DB Parameter Group Name (DB パラメーターグループ名)

String (文字列)

Domain (ドメイン)

String (文字列)

Engine Version (エンジンバージョン)

String (文字列)

IOPS

Number (数値)

Multi AZ (マルチ AZ)

Boolean (ブール)

false

Option Group Name (オプショングループ名)

String (文字列)

DB Port Number (DB ポート番号)

Number (数値)

New DB Instance Identifier (新規 DB インスタンス識別子)

String (文字列)

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Modify DB Snapshot

<rds:modify-db-snapshot>

暗号化できるかどうかに関係なく、手動 DB スナップショットを新しいエンジンバージョンで更新します。エンジンバージョンを新しいメジャーまたはマイナーエンジンバージョンに更新できます。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Snapshot Identifier (DB スナップショット識別子)

String (文字列)

変更する DB スナップショットの識別子。

x

Engine Version (エンジンバージョン)

String (文字列)

DB スナップショットの更新後のエンジンバージョン。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Purchase Reserved DB Instances Offering

<rds:purchase-reserved-db-instances-offering>

リザーブド DB インスタンス提供を購入します。詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Reserved DB Instances Offering ID (リザーブド DB インスタンス提供 ID)

String (文字列)

購入するリザーブド DB インスタンス提供の ID。

x

DB Instance Count (DB インスタンス数)

Number (数値)

予約するインスタンスの数。

Reserved DB Instance ID (リザーブド DB インスタンス ID)

String (文字列)

この予約を追跡する顧客指定の条件値。

タグ

Tag (タグ)​ の配列

タグのリスト。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Reboot DB Instance

<rds:reboot-db-instance>

この操作は DB インスタンスを再起動し、データベースエンジンサービスを再起動します。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

DB インスタンス識別子。

x

Force Failover (フェールオーバーを強制)

Boolean (ブール)

true の場合、MultiAZ ファイルオーバーを介して再起動が実行されます。

false

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Restore DB Instance From DB Snapshot

<rds:restore-db-instance-from-db-snapshot>

DB スナップショットから新しい DB インスタンスを作成します。 詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Availability Zone (可用性ゾーン)

String (文字列)

データベースインスタンスが作成される EC2 可用性ゾーン。

DB Instance Class (DB インスタンスクラス)

String (文字列)

Amazon RDS DB インスタンスの計算容量およびメモリ容量。

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

DB スナップショットから作成する DB インスタンスの名前。このパラメーターは大文字と小文字を区別しません。

x

DB Snapshot Identifier (DB スナップショット識別子)

String (文字列)

復元元の DB スナップショットの識別子。

x

DB Name (DB 名)

String (文字列)

復元された DB インスタンスのデータベース名。

Domain (ドメイン)

String (文字列)

インスタンスを復元する Active Directory ドメインを指定します。

Engine (エンジン)

String (文字列)

新しいインスタンスで使用するデータベースエンジン。

IOPS

Number (数値)

DB インスタンスのプロビジョニングされた IOPS 量を 1 秒あたりの I/O 操作数で指定します。

Multi AZ (マルチ AZ)

Boolean (ブール)

DB インスタンスがマルチ AZ デプロイメントかどうかを指定します。

false

Option Group Name (オプショングループ名)

String (文字列)

復元された DB インスタンスで使用するオプショングループの名前。

Port (ポート)

Number (数値)

データベースが接続を受け入れるポート番号。

タグ

Tag (タグ)​ の配列

タグのリスト。

Auto Minor Version Upgrade (マイナーバージョンの自動アップグレード)

Boolean (ブール)

false

Copy Tags to Snapshot (タグをスナップショットにコピー)

Boolean (ブール)

false

Storage Type (ストレージの種別)

String (文字列)

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

Domain IAM Role Name (ドメイン IAM ロール名)

String (文字列)

Enable IAM Database Authentication (IAM データベース認証を有効化)

Boolean (ブール)

false

License Model (ライセンスモデル)

String (文字列)

Publicly Accessible (一般公開)

Boolean (ブール)

false

TDE Credential ARN (TDE ログイン情報 ARN)

String (文字列)

TDE Credential Password (TDE ログイン情報パスワード)

String (文字列)

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Restore DB Instance To Point In Time

<rds:restore-db-instance-to-point-in-time>

DB インスタンスを任意の時点に復元します。LatestRestorableTime プロパティで指定された時刻より前の任意の時点に復元できます。BackupRetentionPeriod プロパティで指定された日数まで復元することができます。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Availability Zone (可用性ゾーン)

String (文字列)

データベースインスタンスが作成される EC2 可用性ゾーン。

DB Instance Class (DB インスタンスクラス)

String (文字列)

Amazon RDS DB インスタンスの計算容量およびメモリ容量。

DB Name (DB 名)

String (文字列)

復元された DB インスタンスのデータベース名。

Domain (ドメイン)

String (文字列)

インスタンスを復元する Active Directory ドメインを指定します。

Engine (エンジン)

String (文字列)

新しいインスタンスで使用するデータベースエンジン。

IOPS

Number (数値)

DB インスタンスに最初に割り当てられるプロビジョニングされた IOPS (1 秒あたりの入出力操作) の量。

Multi AZ (マルチ AZ)

Boolean (ブール)

DB インスタンスがマルチ AZ デプロイメントかどうかを指定します。

false

Option Group Name (オプショングループ名)

String (文字列)

復元された DB インスタンスで使用するオプショングループの名前。

Port (ポート)

Number (数値)

データベースが接続を受け入れるポート番号。

Restore Time (復元時刻)

DateTime

復元元の日時。

Source DB Instance Identifier (復元元 DB インスタンス識別子)

String (文字列)

復元元 DB インスタンスの識別子。

x

タグ

Tag (タグ)​ の配列

タグのリスト。

Target DB Instance Identifier (復元先 DB インスタンス識別子)

String (文字列)

作成される新しいデータベースインスタンスの名前。

x

Use Latest Restorable Time (最新の復元可能時刻を使用)

Boolean (ブール)

DB インスタンスを最新のバックアップ時刻から復元するか (true)、否か (false) を指定します。

false

Auto Minor Version Upgrade (マイナーバージョンの自動アップグレード)

Boolean (ブール)

false

Copy Tags to Snapshot (タグをスナップショットにコピー)

Boolean (ブール)

false

Storage Type (ストレージの種別)

String (文字列)

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

Domain IAM Role Name (ドメイン IAM ロール名)

String (文字列)

Enable IAM Database Authentication (IAM データベース認証を有効化)

Boolean (ブール)

false

License Model (ライセンスモデル)

String (文字列)

Publicly Accessible (一般公開)

Boolean (ブール)

false

TDE Credential ARN (TDE ログイン情報 ARN)

String (文字列)

TDE Credential Password (TDE ログイン情報パスワード)

String (文字列)

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Start DB Instance

<rds:start-db-instance>

AWS コンソール、​stop-db-instance​ AWS CLI コマンド、または Stop DB Instance アクションを使用して停止された DB インスタンスを起動します。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

ユーザー指定のインスタンス識別子。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Stop DB Instance

<rds:stop-db-instance>

この操作は、DB インスタンスを停止します。

詳細は、Amazon API リファレンス​でこの操作を参照してください。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

ユーザー指定のインスタンス識別子。

x

DB Snapshot Identifier (DB スナップショット識別子)

String (文字列)

DB インスタンスが停止される直前に作成された DB スナップショットのユーザー指定のインスタンス識別子。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • RDS:ACCESS_DENIED_EXCEPTION

  • RDS:AUTHORIZATION_NOT_FOUND

  • RDS:CERTIFICATE_NOT_FOUND

  • RDS:CONNECTIVITY

  • RDS:DB_CLUSTER_NOT_FOUND_FAULT

  • RDS:DB_INSTANCE_ALREADY_EXISTS

  • RDS:DB_INSTANCE_NOT_FOUND

  • RDS:DB_PARAMETER_GROUP_NOT_FOUND

  • RDS:DB_SECURITY_GROUP_NOT_FOUND

  • RDS:DB_SNAPSHOT_ALREADY_EXISTS

  • RDS:DB_SNAPSHOT_NOT_FOUND

  • RDS:DB_SUBNET_GROUP_DOES_NOT_COVER_ENOUGH_A_ZS

  • RDS:DB_SUBNET_GROUP_NOT_FOUND_FAULT

  • RDS:DB_UPGRADE_DEPENDENCY_FAILURE

  • RDS:DOMAIN_NOT_FOUND_FAULT

  • RDS:INCOMPLETE_SIGNATURE

  • RDS:INSTANCE_QUOTA_EXCEEDED

  • RDS:INSUFFICIENT_DB_INSTANCE_CAPACITY

  • RDS:INTERNAL_FAILURE

  • RDS:INVALID_ACTION

  • RDS:INVALID_CLIENT_TOKEN_ID

  • RDS:INVALID_DB_CLUSTER_STATE_FAULT

  • RDS:INVALID_DB_INSTANCE_STATE

  • RDS:INVALID_DB_SECURITY_GROUP_STATE

  • RDS:INVALID_DB_SNAPSHOT_STATE

  • RDS:INVALID_PARAMETER_COMBINATION

  • RDS:INVALID_PARAMETER_VALUE

  • RDS:INVALID_QUERY_PARAMETER

  • RDS:INVALID_RESTORE_FAULT

  • RDS:INVALID_SUBNET

  • RDS:INVALID_VPC_NETWORK_STATE_FAULT

  • RDS:KMS_KEY_NOT_ACCESSIBLE_FAULT

  • RDS:MALFORMED_QUERY_STRING

  • RDS:MISSING_ACTION

  • RDS:MISSING_AUTHENTICATION_TOKEN

  • RDS:MISSING_PARAMETER

  • RDS:OPT_IN_REQUIRED

  • RDS:OPTION_GROUP_NOT_FOUND_FAULT

  • RDS:POINT_IN_TIME_RESTORE_NOT_ENABLED

  • RDS:PROVISIONED_IOPS_NOT_AVAILABLE_IN_AZ_FAULT

  • RDS:REQUEST_EXPIRED

  • RDS:RESERVED_DB_INSTANCE_NOT_FOUND

  • RDS:RESERVED_DB_INSTANCES_OFFERING_NOT_FOUND

  • RDS:RETRY_EXHAUSTED

  • RDS:SERVICE_UNAVAILABLE

  • RDS:SNAPSHOT_QUOTA_EXCEEDED

  • RDS:STORAGE_QUOTA_EXCEEDED

  • RDS:STORAGE_TYPE_NOT_SUPPORTED

  • RDS:THROTTLING_EXCEPTION

  • RDS:UNKNOWN

  • RDS:VALIDATION_ERROR

認証種別

TLS

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

トラストストア

Key Store (キーストア)

Revocation Check (取り消し確認)

トラストストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

次の設定の場合

スロー

  • RDS:AccessDeniedException

  • RDS:AuthorizationNotFound

  • RDS:CertificateNotFound

  • RDS:CONNECTIVITY

  • RDS:DBClusterNotFoundFault

  • RDS:DBInstanceAlreadyExists

  • RDS:DBInstanceNotFound

  • RDS:DBParameterGroupNotFound

  • RDS:DBSecurityGroupNotFound

  • RDS:DBSnapshotAlreadyExists

  • RDS:DBSnapshotNotFound

  • RDS:DBSubnetGroupDoesNotCoverEnoughAZs

  • RDS:DBSubnetGroupNotFoundFault

  • RDS:DBUpgradeDependencyFailure

  • RDS:DomainNotFoundFault

  • RDS:IncompleteSignature

  • RDS:InstanceQuotaExceeded

  • RDS:InsufficientDBInstanceCapacity

  • RDS:InternalFailure

  • RDS:InvalidAction

  • RDS:InvalidClientTokenId

  • RDS:InvalidDBClusterStateFault

  • RDS:InvalidDBInstanceState

  • RDS:InvalidDBSecurityGroupState

  • RDS:InvalidDBSnapshotState

  • RDS:InvalidParameterCombination

  • RDS:InvalidParameterValue

  • RDS:InvalidQueryParameter

  • RDS:InvalidRestoreFault

  • RDS:InvalidSubnet

  • RDS:InvalidVPCNetworkStateFault

  • RDS:KMSKeyNotAccessibleFault

  • RDS:MalformedQueryString

  • RDS:MissingAction

  • RDS:MissingAuthenticationToken

  • RDS:MissingParameter

  • RDS:OptInRequired

  • RDS:OptionGroupNotFoundFault

  • RDS:PointInTimeRestoreNotEnabled

  • RDS:ProvisionedIopsNotAvailableInAZFault

  • RDS:RequestExpired

  • RDS:ReservedDBInstanceNotFound

  • RDS:ReservedDBInstancesOfferingNotFound

  • RDS:RETRY_EXHAUSTED

  • RDS:ServiceUnavailable

  • RDS:SnapshotQuotaExceeded

  • RDS:StorageQuotaExceeded

  • RDS:StorageTypeNotSupported

  • RDS:ThrottlingException

  • RDS:Unknown

  • RDS:ValidationError

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

DB Instance (DB インスタンス)

項目 説明 デフォルト値 必須

Allocated Storage (割り当てられたストレージ)

Number (数値)

Auto Minor Version Upgrade (マイナーバージョンの自動アップグレード)

Boolean (ブール)

Availability Zone (可用性ゾーン)

String (文字列)

Backup Retention Period (バックアップ保持期間)

Number (数値)

Ca Certificate Identifier (CA 証明書識別子)

String (文字列)

Character Set Name (文字セット名)

String (文字列)

Copy Tags to Snapshot (タグをスナップショットにコピー)

Boolean (ブール)

Db Cluster Identifier (DB クラスター識別子)

String (文字列)

Db Instance Arn (DB インスタンス ARN)

String (文字列)

Db Instance Class (DB インスタンスクラス)

String (文字列)

Db Instance Identifier (DB インスタンス識別子)

String (文字列)

Db Instance Port (DB インスタンスポート)

Number (数値)

Db Instance Status (DB インスタンス状況)

String (文字列)

Db Name (DB 名)

String (文字列)

Db Parameter Groups (DB パラメーターグループ)

Db Security Groups (DB セキュリティグループ)

Db Subnet Group (DB サブネットグループ)

Dbi Resource Id (DBI リソース ID)

String (文字列)

Domain Memberships (ドメインメンバーシップ)

エンドポイント

Engine (エンジン)

String (文字列)

Engine Version (エンジンバージョン)

String (文字列)

Enhanced Monitoring Resource Arn (拡張監視リソース ARN)

String (文字列)

Iam Database Authentication Enabled (IAM データベース認証有効)

Boolean (ブール)

Instance Create Time (インスタンス作成時刻)

DateTime

Iops

Number (数値)

Kms Key Id (KMS キー ID)

String (文字列)

Latest Restorable Time (最新の復元可能時刻)

DateTime

License Model (ライセンスモデル)

String (文字列)

Master Username (マスターユーザー名)

String (文字列)

Monitoring Interval (監視期間)

Number (数値)

Monitoring Role Arn (監視ロール ARN)

String (文字列)

Multi AZ (マルチ AZ)

Boolean (ブール)

Option Group Memberships (オプショングループメンバーシップ)

Pending Modified Values (待機中の変更値)

Preferred Backup Window (優先されるバックアップウィンドウ)

String (文字列)

Preferred Maintenance Window (優先されるメンテナンスウィンドウ)

String (文字列)

Promotion Tier (昇格階層)

Number (数値)

Publicly Accessible (一般公開)

Boolean (ブール)

Read Replica DB Cluster Identifiers (リードレプリカ DB クラスター識別子)

Array of String (文字列の配列)

Read Replica DB Instance Identifiers (リードレプリカ DB インスタンス識別子)

Array of String (文字列の配列)

Read Replica Source DB Instance Identifier (リードレプリカ複製元 DB インスタンス識別子)

String (文字列)

Secondary Availability Zone (セカンダリ可用性ゾーン)

String (文字列)

Status Infos (状況情報)

Storage Encrypted (ストレージ暗号化)

Boolean (ブール)

Storage Type (ストレージの種別)

String (文字列)

Tde Credential Arn (TDE ログイン情報 ARN)

String (文字列)

Timezone (タイムゾーン)

String (文字列)

Vpc Security Groups (VPC セキュリティグループ)

DB Parameter Group Status (DB パラメーターグループ状況)

項目 説明 デフォルト値 必須

DB Parameter Group Name (DB パラメーターグループ名)

String (文字列)

Parameter Apply Status (パラメーター適用状況)

String (文字列)

DB Security Group Membership (VPC セキュリティグループメンバーシップ)

項目 説明 デフォルト値 必須

DB Security Group Name (DB セキュリティグループ名)

String (文字列)

Status (状況)

String (文字列)

Db Subnet Group (DB サブネットグループ)

項目 説明 デフォルト値 必須

DB Subnet Group Arn (DB サブネットグループ ARN)

String (文字列)

DB Subnet Group Description (DB サブネットグループ説明)

String (文字列)

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

Subnet Group Status (サブネットグループ状況)

String (文字列)

Subnets (サブネット)

Vpc Id

String (文字列)

Subnet (サブネット)

項目 説明 デフォルト値 必須

Subnet Availability Zone (サブネット可用性ゾーン)

String (文字列)

Subnet Identifier (サブネット識別子)

String (文字列)

Subnet Status (サブネット状況)

String (文字列)

Domain Membership (ドメインメンバーシップ)

項目 説明 デフォルト値 必須

FQDN

String (文字列)

IAM Role Name (IAM ロール名)

String (文字列)

Domain (ドメイン)

String (文字列)

Status (状況)

String (文字列)

エンドポイント

項目 説明 デフォルト値 必須

Address (住所)

String (文字列)

Hosted Zone Id (ホストゾーン ID)

String (文字列)

Port (ポート)

Number (数値)

Option Group Membership (オプショングループメンバーシップ)

項目 説明 デフォルト値 必須

Option Group Name (オプショングループ名)

String (文字列)

Status (状況)

String (文字列)

Pending Modified Values (待機中の変更値)

項目 説明 デフォルト値 必須

CA Certificate Identifier (CA 証明書識別子)

String (文字列)

DB Instance Class (DB インスタンスクラス)

String (文字列)

DB Instance Identifier (DB インスタンス識別子)

String (文字列)

DB Subnet Group Name (DB サブネットグループ名)

String (文字列)

Allocated Storage (割り当てられたストレージ)

Number (数値)

Backup Retention Period (バックアップ保持期間)

Number (数値)

Engine Version (エンジンバージョン)

String (文字列)

Iops

Number (数値)

License Model (ライセンスモデル)

String (文字列)

Master User Password (マスターユーザーパスワード)

String (文字列)

Multi AZ (マルチ AZ)

Boolean (ブール)

Port (ポート)

Number (数値)

Storage Type (ストレージの種別)

String (文字列)

DB Instance Status Info (DB インスタンス状況情報)

項目 説明 デフォルト値 必須

Message (メッセージ)

String (文字列)

Normal (通常)

Boolean (ブール)

Status (状況)

String (文字列)

Status Type (状況種別)

String (文字列)

VPC Security Group Membership (VPC セキュリティグループメンバーシップ)

項目 説明 デフォルト値 必須

Status (状況)

String (文字列)

Vpc Security Group Id (VPC セキュリティグループ ID)

String (文字列)

Tag (タグ)

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

Value (値)

String (文字列)

DB Snapshot (DB スナップショット)

項目 説明 デフォルト値 必須

Allocated Storage (割り当てられたストレージ)

Number (数値)

Availability Zone (可用性ゾーン)

String (文字列)

Db Instance Identifier (DB インスタンス識別子)

String (文字列)

Db Snapshot Arn (DB スナップショット ARN)

String (文字列)

Db Snapshot Identifier (DB スナップショット識別子)

String (文字列)

Encrypted (暗号化)

Boolean (ブール)

Engine (エンジン)

String (文字列)

Engine Version (エンジンバージョン)

String (文字列)

Iam Database Authentication Enabled (IAM データベース認証有効)

Boolean (ブール)

Instance Create Time (インスタンス作成時刻)

DateTime

Iops

Number (数値)

Kms Key Id (KMS キー ID)

String (文字列)

License Model (ライセンスモデル)

String (文字列)

Master Username (マスターユーザー名)

String (文字列)

Option Group Name (オプショングループ名)

String (文字列)

Percent Progress (進行状況パーセント)

Number (数値)

Port (ポート)

Number (数値)

Snapshot Create Time (スナップショット作成時刻)

DateTime

Snapshot Type (スナップショット種別)

String (文字列)

Source DB Snapshot Identifier (複製元 DB スナップショット識別子)

String (文字列)

Source Region (複製元リージョン)

String (文字列)

Status (状況)

String (文字列)

Storage Type (ストレージの種別)

String (文字列)

Tde Credential Arn (TDE ログイン情報 ARN)

String (文字列)

Timezone (タイムゾーン)

String (文字列)

Vpc Id

String (文字列)

Request ID Attribute (要求 ID 属性)

項目 説明 デフォルト値 必須

Request Id (要求 ID)

String (文字列)

検索条件

項目 説明 デフォルト値 必須

Name (名前)

String (文字列)

Values (値)

Array of String (文字列の配列)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームを使用し、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンスの量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

メモリ内に保持されるインスタンスの最大数。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Event (イベント)

項目 説明 デフォルト値 必須

Date (日付)

DateTime

Event Categories (イベントカテゴリ)

Array of String (文字列の配列)

Message (メッセージ)

String (文字列)

Source Arn (複製元 ARN)

String (文字列)

Source Identifier (複製元識別子)

String (文字列)

Source Type (ソース種別)

String (文字列)

Reserved DB Instance (リザーブド DB インスタンス)

項目 説明 デフォルト値 必須

Currency Code (通貨コード)

String (文字列)

Db Instance Class (DB インスタンスクラス)

String (文字列)

Db Instance Count (DB インスタンス数)

Number (数値)

Duration (所要時間)

Number (数値)

Fixed Price (固定価格)

Number (数値)

Multi AZ (マルチ AZ)

Boolean (ブール)

Offering Type (提供種別)

String (文字列)

Product Description (製品説明)

String (文字列)

Recurring Charges (定期的な課金)

Reserved DB Instance Arn (リザーブド DB インスタンス ARN)

String (文字列)

Reserved DB Instance Id (リザーブド DB インスタンス ID)

String (文字列)

Reserved DB Instances Offering Id (リザーブド DB インスタンス提供 ID)

String (文字列)

Start Time (開始時刻)

DateTime

State (状態)

String (文字列)

Usage Price (使用価格)

Number (数値)

Recurring Charge (定期的な課金)

項目 説明 デフォルト値 必須

Recurring Charge Amount (定期的な課金金額)

Number (数値)

Recurring Charge Frequency (定期的な課金頻度)

String (文字列)

Reserved DB Instances Offering (リザーブド DB インスタンス提供)

項目 説明 デフォルト値 必須

DB Instance Class (DB インスタンスクラス)

String (文字列)

Currency Code (通貨コード)

String (文字列)

Duration (所要時間)

Number (数値)

Fixed Price (固定価格)

Number (数値)

Multi AZ (マルチ AZ)

Boolean (ブール)

Offering Type (提供種別)

String (文字列)

Product Description (製品説明)

String (文字列)

Recurring Charges (定期的な課金)

Reserved DB Instances Offering Id (リザーブド DB インスタンス提供 ID)

String (文字列)

Usage Price (使用価格)

Number (数値)