次の方法で共有

Microsoft.AwsConnector rdsDBClusters 2024-12-01

Bicep リソース定義

rdsDBClusters リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.AwsConnector/rdsDBClusters リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.AwsConnector/rdsDBClusters@2024-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    arn: 'string'
    awsAccountId: 'string'
    awsProperties: {
      allocatedStorage: int
      associatedRoles: [
        {
          featureName: 'string'
          roleArn: 'string'
        }
      ]
      autoMinorVersionUpgrade: bool
      availabilityZones: [
        'string'
      ]
      backtrackWindow: int
      backupRetentionPeriod: int
      copyTagsToSnapshot: bool
      databaseName: 'string'
      dbClusterArn: 'string'
      dbClusterIdentifier: 'string'
      dbClusterInstanceClass: 'string'
      dbClusterParameterGroupName: 'string'
      dbClusterResourceId: 'string'
      dbInstanceParameterGroupName: 'string'
      dbSubnetGroupName: 'string'
      dbSystemId: 'string'
      deletionProtection: bool
      domain: 'string'
      domainIAMRoleName: 'string'
      enableCloudwatchLogsExports: [
        'string'
      ]
      enableGlobalWriteForwarding: bool
      enableHttpEndpoint: bool
      enableIAMDatabaseAuthentication: bool
      endpoint: {
        address: 'string'
        port: 'string'
      }
      engine: 'string'
      engineMode: 'string'
      engineVersion: 'string'
      globalClusterIdentifier: 'string'
      iops: int
      kmsKeyId: 'string'
      manageMasterUserPassword: bool
      masterUsername: 'string'
      masterUserPassword: 'string'
      masterUserSecret: {
        kmsKeyId: 'string'
        secretArn: 'string'
      }
      monitoringInterval: int
      monitoringRoleArn: 'string'
      networkType: 'string'
      performanceInsightsEnabled: bool
      performanceInsightsKmsKeyId: 'string'
      performanceInsightsRetentionPeriod: int
      port: int
      preferredBackupWindow: 'string'
      preferredMaintenanceWindow: 'string'
      publiclyAccessible: bool
      readEndpoint: {
        address: 'string'
      }
      replicationSourceIdentifier: 'string'
      restoreToTime: 'string'
      restoreType: 'string'
      scalingConfiguration: {
        autoPause: bool
        maxCapacity: int
        minCapacity: int
        secondsBeforeTimeout: int
        secondsUntilAutoPause: int
        timeoutAction: 'string'
      }
      serverlessV2ScalingConfiguration: {
        maxCapacity: int
        minCapacity: int
      }
      snapshotIdentifier: 'string'
      sourceDBClusterIdentifier: 'string'
      sourceRegion: 'string'
      storageEncrypted: bool
      storageThroughput: int
      storageType: 'string'
      tags: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      useLatestRestorableTime: bool
      vpcSecurityGroupIds: [
        'string'
      ]
    }
    awsRegion: 'string'
    awsSourceSchema: 'string'
    awsTags: {
      {customized property}: 'string'
    }
    publicCloudConnectorsResourceId: 'string'
    publicCloudResourceName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.AwsConnector/rdsDBClusters

名前 形容 価値
場所 リソースが存在する地理的な場所 string (必須)
名前 リソース名 糸

制約：
パターン = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (必須)
プロパティ このリソースのリソース固有のプロパティ。 RdsDBClusterProperties の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

AwsRdsDBClusterプロパティ

名前 形容 価値
割り当て済みストレージ マルチ AZ DB クラスター内の各 DB インスタンスに割り当てるジビバイト (GiB) 単位のストレージの量。 整数 (int)
associatedロール DB クラスターに関連付けられている AWS Identity and Access Management (IAM) ロールの一覧を提供します。 DB クラスターに関連付けられている IAM ロールは、DB クラスターがユーザーに代わって他の AWS サービスにアクセスするためのアクセス許可を付与します。 DBClusterロール[]
autoMinorVersionアップグレード メンテナンス期間中にマイナー エンジンのアップグレードが DB クラスターに自動的に適用されるかどうかを示す値。 既定では、マイナー エンジンのアップグレードは自動的に適用されます。 ブール (bool)
可用性ゾーン DB クラスター内のインスタンスを作成できる Availability Zones (AZs) の一覧。 AWS リージョンと Availability Zones の詳細については、Amazon Aurora ユーザー ガイドの「リージョンと Availability Zones の選択」を参照してください。 文字列[]
バックトラックウィンドウ ターゲット バックトラック ウィンドウ (秒単位)。 バックトラッキングを無効にするには、この値を 0 に設定します。 整数 (int)
バックアップ保持期間 自動バックアップが保持される日数。 整数 (int)
copyTagsToSnapshot すべてのタグを DB クラスターから DB クラスターのスナップショットにコピーするかどうかを示す値。 既定では、コピーされません。 ブール (bool)
データベース名 データベースの名前。 名前を指定しない場合、Amazon RDS はこの DB クラスターにデータベースを作成しません。 名前付け制約については、Amazon RDS ユーザーガイドの「名前付け制約」を参照してください。 糸
dbClusterArn の DB クラスターの Amazon リソース名 (ARN)。 糸
dbClusterIdentifier の DB クラスター識別子。 このパラメーターは、小文字の文字列として格納されます。 糸
dbClusterInstanceClass の マルチ AZ DB クラスター内の各 DB インスタンスのコンピューティング容量とメモリ容量 (例: db.m6g.xlarge)。 糸
dbClusterParameterGroupName (英語) この DB クラスターに関連付ける DB クラスター パラメーター グループの名前。 糸
dbClusterResourceId DB クラスターの AWS リージョン固有の不変識別子。 糸
dbInstanceParameterGroupName の DB クラスターのすべてのインスタンスに適用する DB パラメーター グループの名前。 糸
dbSubnetGroupName (英語) この DB クラスターに関連付ける DB サブネット グループ。 糸
dbSystemId の 将来の使用のために予約されています。 糸
削除保護 DB クラスターで削除保護が有効になっているかどうかを示す値。 削除保護が有効になっている場合、データベースを削除できません。 既定では、削除保護は無効になっています。 ブール (bool)
ドメイン DB クラスターを作成する Active Directory ディレクトリ ID。 糸
ドメインIAMRoleName ディレクトリサービスへの API 呼び出しを行うときに使用する IAM ロールの名前を指定します。 糸
enableCloudwatchLogsExports CloudWatch ログへのエクスポートを有効にする必要があるログの種類の一覧。 一覧の値は、使用されている DB エンジンによって異なります。 詳細については、Amazon Aurora ユーザーガイドの「Amazon CloudWatch ログへのデータベースログの発行」を参照してください。 文字列[]
enableGlobalWriteForwardingを使用します。 この DB クラスターがグローバル クラスター (Aurora グローバル データベース) のプライマリ クラスターに書き込み操作を転送できるようにするかどうかを指定します。 既定では、Aurora グローバル データベース内のセカンダリ クラスターである Aurora DB クラスターでは、書き込み操作は許可されません。 ブール (bool)
enableHttpエンドポイント DB クラスターの HTTP エンドポイントを有効にするかどうかを示す値。 既定では、HTTP エンドポイントは無効になっています。 ブール (bool)
enableIAMDatabase認証 AWS Identity and Access Management (IAM) アカウントのデータベース アカウントへのマッピングを有効にするかどうかを示す値。 既定では、マッピングは無効になっています。 ブール (bool)
エンドポイント プロパティ エンドポイント エンドポイント自動生成
エンジン この DB クラスターに使用するデータベース エンジンの名前。 有効な値: aurora (MySQL 5.6 と互換性のある Aurora の場合)、aurora-mysql (MySQL 5.7 互換の Aurora の場合)、aurora-postgresql 糸
エンジンモード DB クラスターの DB エンジン モード(プロビジョニング済み、サーバーレス、並列クエリ、グローバル、マルチマスター)。 糸
エンジンバージョン 使用するデータベース エンジンのバージョン番号。 糸
グローバルクラスタ識別子 Aurora グローバル データベース クラスターを構成していて、Aurora DB クラスターをグローバル データベース クラスターのセカンダリ メンバーにする場合は、グローバル データベース クラスターのグローバル クラスター ID を指定します。 グローバル クラスターのプライマリ データベース クラスターを定義するには、AWS::RDS::GlobalCluster リソースを使用します。グローバル データベース クラスターを構成していない場合は、このプロパティを指定しないでください。 糸
IOPSの マルチ AZ DB クラスター内の各 DB インスタンスに最初に割り当てられるプロビジョニング済み IOPS (1 秒あたりの入力/出力操作) の量。 整数 (int)
kmsKeyId (英語) DB クラスター内のデータベース インスタンスの暗号化に使用される AWS Key Management Service マスター キーの Amazon リソース名 (ARN) (arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef など)。 StorageEncrypted プロパティを有効にしたが、このプロパティを指定しない場合は、既定のマスター キーが使用されます。 このプロパティを指定する場合は、StorageEncrypted プロパティを true に設定する必要があります。 糸
manageMasterUserPassword さん AWS Secrets Manager でマスターユーザーパスワードを管理するかどうかを示す値。 ブール (bool)
masterユーザー名 DB クラスターのマスター ユーザーの名前。 SnapshotIdentifier を指定しない限り、MasterUsername を指定する必要があります。 その場合は、MasterUsername を指定しないでください。 糸
masterUserPassword さん DB インスタンスのマスター パスワード。 糸
masterUserSecret さん マスターユーザーパスワードの AWS Secrets Manager で RDS によって管理されるシークレットが含まれます。 masterUserSecret の
モニタリング間隔 拡張監視メトリックが DB クラスターに対して収集されるポイント間の間隔 (秒単位)。 拡張監視メトリックの収集をオフにするには、0 を指定します。 既定値は 0 です。 整数 (int)
監視ロールアルン RDS が拡張監視メトリックを Amazon CloudWatch ログに送信することを許可する IAM ロールの Amazon リソース名 (ARN)。 糸
ネットワークタイプ DB クラスターのネットワークの種類。 糸
performanceInsightsEnabled (パフォーマンスインサイト有効) DB クラスターの Performance Insights を有効にするかどうかを示す値。 ブール (bool)
performanceInsightsKmsKeyId Performance Insights データの暗号化のための Amazon Web Services KMS キー識別子。 糸
performanceInsights保持期間 Performance Insights データを保持する時間 (日数)。 整数 (int)
港 DB クラスター内のインスタンスが接続を受け入れるポート番号。 既定値: エンジンが aurora として設定されている場合は 3306、aurora-postgresql に設定されている場合は 5432。 整数 (int)
preferredBackupWindow BackupRetentionPeriod パラメーターを使用して自動バックアップが有効になっている場合に自動バックアップが作成される 1 日の時間範囲。 既定値は、AWS リージョンごとに 8 時間のブロックからランダムに選択された 30 分のウィンドウです。 使用可能な時間ブロックを確認するには、Amazon Aurora ユーザーガイドの「優先 DB クラスターメンテナンス期間の調整」を参照してください。 糸
preferredメンテナンスウィンドウ システムメンテナンスを実行できる週単位の時間範囲 (協定世界時 (UTC)。 既定では、AWS リージョンごとに 8 時間のブロックからランダムに選択された 30 分のウィンドウが、週のランダムな日に発生します。 使用可能な時間ブロックを確認するには、Amazon Aurora ユーザーガイドの「優先 DB クラスターメンテナンス期間の調整」を参照してください。 糸
パブリックアクセス可能 DB クラスターにパブリックにアクセスできるかどうかを示す値。 ブール (bool)
readエンドポイント プロパティ readEndpoint ReadEndpoint の
replicationSource識別子 この DB クラスターが読み取りレプリカとして作成される場合は、ソース DB インスタンスまたは DB クラスターの Amazon リソース名 (ARN)。 糸
restoreToTime(リストア・トゥ・タイム) DB クラスターの復元先の日付と時刻。 値は、世界協定時刻 (UTC) 形式の時刻である必要があります。 例: 2015-03-07T23:45:00Z 糸
リストアタイプ 実行する復元の種類。 次のいずれかの値を指定できます。完全コピー - 新しい DB クラスターは、ソース DB クラスターの完全コピーとして復元されます。書き込み時のコピー - 新しい DB クラスターは、ソース DB クラスターの複製として復元されます。 糸
スケーリング設定 ScalingConfiguration プロパティの種類は、Aurora サーバーレス DB クラスターのスケーリング構成を指定します。 ScalingConfiguration プロパティの種類は、Aurora サーバーレス DB クラスターのスケーリング構成を指定します。 スケーリング構成
サーバーレスV2ScalingConfiguration Aurora サーバーレス v2 DB クラスターのスケーリング構成が含まれています。 Aurora サーバーレス v2 DB クラスターのスケーリング構成が含まれています。 ServerlessV2ScalingConfiguration (サーバーレスV2Scaling構成)
スナップショット識別子 復元元の DB スナップショットまたは DB クラスター スナップショットの識別子。名前または Amazon リソース名 (ARN) を使用して、DB クラスタースナップショットを指定できます。 ただし、ARN のみを使用して DB スナップショットを指定できます。SnapshotIdentifier プロパティを使用して DB クラスターを復元した後は、DB クラスターに対する今後の更新に対して同じ SnapshotIdentifier プロパティを指定する必要があります。 更新プログラムにこのプロパティを指定した場合、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。 ただし、SnapshotIdentifier プロパティを指定しない場合は、空の DB クラスターが作成され、元の DB クラスターが削除されます。 前のスナップショット復元プロパティとは異なるプロパティを指定すると、指定した SnapshotIdentifier プロパティから DB クラスターが復元され、元の DB クラスターが削除されます。 糸
sourceDBCluster識別子 復元元のソース DB クラスターの識別子。 糸
ソースリージョン DB クラスターをレプリケートするときにソース DB クラスターを含む AWS リージョン。 たとえば、us-east-1 などです。 糸
ストレージ暗号化 DB インスタンスが暗号化されているかどうかを示します。DBClusterIdentifier、SnapshotIdentifier、または SourceDBInstanceIdentifier プロパティを指定する場合は、このプロパティを指定しないでください。 値は、クラスター、スナップショット、またはソース DB インスタンスから継承されます。 ブール (bool)
ストレージスループット DB クラスターのストレージ スループット値を指定します。 この設定は、gp3 ストレージの種類にのみ適用されます。 整数 (int)
ストレージタイプ DB クラスターに関連付けるストレージの種類を指定します。 糸
タグ このリソースに適用するキーと値のペアの配列。 タグ自動生成45[]
useLatestRestorableTime DB クラスターを最新の復元可能なバックアップ時間に復元するかどうかを示す値。 既定では、DB クラスターは復元可能な最新のバックアップ時間には復元されません。 ブール (bool)
vpcセキュリティグループID この DB クラスターに関連付ける EC2 VPC セキュリティグループの一覧。 文字列[]

DBClusterロール

名前 形容 価値
featureName (フィーチャー名) AWS Identity and Access Management (IAM) ロールに関連付けられている機能の名前。 サポートされている機能名の一覧については、Amazon RDS API リファレンスの DBEngineVersion を参照してください。 糸
ロールArn DB クラスターに関連付けられている IAM ロールの Amazon リソース名 (ARN)。 糸

エンドポイント自動生成

名前 形容 価値
住所 DB クラスターの接続エンドポイント。 糸
港 この DB クラスターでの接続を受け入れるポート番号。 糸

マスターユーザーシークレット

名前 形容 価値
kmsKeyId (英語) シークレットの暗号化に使用される AWS KMS キー識別子。 糸
シークレットアーン シークレットの Amazon リソース名 (ARN)。 糸

RdsDBClusterプロパティ

名前 形容 価値
ARN Amazon リソース名 (ARN) 糸
awsAccountId (英語) AWS アカウント ID 糸
awsプロパティ AWS のプロパティ awsRdsDBClusterProperties の
awsリージョン AWS リージョン 糸
awsSourceSchema (英語) AWS ソーススキーマ 糸
awsタグ AWS タグ RdsDBClusterPropertiesAwsTags の
publicCloudConnectorsリソースID パブリック クラウド コネクタのリソース ID 糸
publicCloudResourceName (パブリッククラウドリソース名) パブリック クラウド リソース名 糸

RdsDBClusterプロパティAwsTags

名前 形容 価値

リードエンドポイント

名前 形容 価値
住所 DB クラスターのリーダー エンドポイント。 糸

スケーリング構成

名前 形容 価値
自動一時停止 サーバーレス DB エンジン モードでの Aurora DB クラスターの自動一時停止を許可または禁止するかどうかを示す値。 DB クラスターは、アイドル状態 (接続がない場合) にのみ一時停止できます。 ブール (bool)
最大容量 サーバーレス DB エンジン モードでの Aurora DB クラスターの最大容量。Aurora MySQL の場合、有効な容量の値は 1、2、4、8、16、32、64、128、256 です。Aurora PostgreSQL の場合、有効な容量の値は 2、4、8、16、32、64、192、384 です。最大容量は最小容量以上である必要があります。 整数 (int)
最小容量 サーバーレス DB エンジン モードでの Aurora DB クラスターの最小容量。Aurora MySQL の場合、有効な容量の値は 1、2、4、8、16、32、64、128、256 です。Aurora PostgreSQL の場合、有効な容量の値は 2、4、8、16、32、64、192、384 です。最小容量は最大容量以下である必要があります。 整数 (int)
secondsBeforeTimeout (秒タイムアウト前) Aurora サーバーレス v1 が、タイムアウト アクションを適用する前にシームレスなスケーリングを実行するためのスケーリング ポイントの検索を試行する時間 (秒単位)。既定値は 300 です。 整数 (int)
秒UntilAutoPause サーバーレス モードの Aurora DB クラスターが一時停止されるまでの時間 (秒単位)。 整数 (int)
タイムアウトアクション タイムアウトに達したときに実行するアクション 。ForceApplyCapacityChange または RollbackCapacityChange.ForceApplyCapacityChange は、できるだけ早く指定された値に容量を設定します。既定値の RollbackCapacityChange は、タイムアウト期間中にスケーリング ポイントが見つからない場合、容量の変更を無視します。詳細については、Amazon Aurora ユーザーガイドの「Aurora サーバーレス v1 の自動スケーリング」を参照してください。 糸

ServerlessV2ScalingConfiguration (サーバーレスV2Scaling構成)

名前 形容 価値
最大容量 Aurora サーバーレス v2 クラスター内の DB インスタンスの Aurora 容量ユニット (AKU) の最大数。 ACU 値は、40、40.5、41 など、半ステップ単位で指定できます。 使用できる最大値は 128 です。 整数 (int)
最小容量 Aurora サーバーレス v2 クラスター内の DB インスタンスの Aurora 容量ユニット (AKU) の最小数。 ACU 値は、8、8.5、9 など、半ステップ単位で指定できます。 使用できる最小値は 0.5 です。 整数 (int)

タグ自動生成45

名前 形容 価値
鍵 タグのキー名。 長さが 1 ~ 128 の Unicode 文字の値を指定でき、aws: でプレフィックスを付けることはできません。 Unicode 文字、数字、空白文字、_、.、/、=、+、-のいずれかの文字を使用できます。 糸
価値 タグの値。 長さが 0 ~ 256 Unicode 文字の値を指定でき、aws: でプレフィックスを付けることはできません。 Unicode 文字、数字、空白文字、_、.、/、=、+、-のいずれかの文字を使用できます。 糸

追跡リソースタグ

名前 形容 価値

ARM テンプレート リソース定義

rdsDBClusters リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.AwsConnector/rdsDBClusters リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.AwsConnector/rdsDBClusters",
  "apiVersion": "2024-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "arn": "string",
    "awsAccountId": "string",
    "awsProperties": {
      "allocatedStorage": "int",
      "associatedRoles": [
        {
          "featureName": "string",
          "roleArn": "string"
        }
      ],
      "autoMinorVersionUpgrade": "bool",
      "availabilityZones": [ "string" ],
      "backtrackWindow": "int",
      "backupRetentionPeriod": "int",
      "copyTagsToSnapshot": "bool",
      "databaseName": "string",
      "dbClusterArn": "string",
      "dbClusterIdentifier": "string",
      "dbClusterInstanceClass": "string",
      "dbClusterParameterGroupName": "string",
      "dbClusterResourceId": "string",
      "dbInstanceParameterGroupName": "string",
      "dbSubnetGroupName": "string",
      "dbSystemId": "string",
      "deletionProtection": "bool",
      "domain": "string",
      "domainIAMRoleName": "string",
      "enableCloudwatchLogsExports": [ "string" ],
      "enableGlobalWriteForwarding": "bool",
      "enableHttpEndpoint": "bool",
      "enableIAMDatabaseAuthentication": "bool",
      "endpoint": {
        "address": "string",
        "port": "string"
      },
      "engine": "string",
      "engineMode": "string",
      "engineVersion": "string",
      "globalClusterIdentifier": "string",
      "iops": "int",
      "kmsKeyId": "string",
      "manageMasterUserPassword": "bool",
      "masterUsername": "string",
      "masterUserPassword": "string",
      "masterUserSecret": {
        "kmsKeyId": "string",
        "secretArn": "string"
      },
      "monitoringInterval": "int",
      "monitoringRoleArn": "string",
      "networkType": "string",
      "performanceInsightsEnabled": "bool",
      "performanceInsightsKmsKeyId": "string",
      "performanceInsightsRetentionPeriod": "int",
      "port": "int",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "publiclyAccessible": "bool",
      "readEndpoint": {
        "address": "string"
      },
      "replicationSourceIdentifier": "string",
      "restoreToTime": "string",
      "restoreType": "string",
      "scalingConfiguration": {
        "autoPause": "bool",
        "maxCapacity": "int",
        "minCapacity": "int",
        "secondsBeforeTimeout": "int",
        "secondsUntilAutoPause": "int",
        "timeoutAction": "string"
      },
      "serverlessV2ScalingConfiguration": {
        "maxCapacity": "int",
        "minCapacity": "int"
      },
      "snapshotIdentifier": "string",
      "sourceDBClusterIdentifier": "string",
      "sourceRegion": "string",
      "storageEncrypted": "bool",
      "storageThroughput": "int",
      "storageType": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "useLatestRestorableTime": "bool",
      "vpcSecurityGroupIds": [ "string" ]
    },
    "awsRegion": "string",
    "awsSourceSchema": "string",
    "awsTags": {
      "{customized property}": "string"
    },
    "publicCloudConnectorsResourceId": "string",
    "publicCloudResourceName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.AwsConnector/rdsDBClusters

名前 形容 価値
apiVersion (英語) API のバージョン '2024-12-01'
場所 リソースが存在する地理的な場所 string (必須)
名前 リソース名 糸

制約：
パターン = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (必須)
プロパティ このリソースのリソース固有のプロパティ。 RdsDBClusterProperties の
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.AwsConnector/rdsDBClusters'

AwsRdsDBClusterプロパティ

名前 形容 価値
割り当て済みストレージ マルチ AZ DB クラスター内の各 DB インスタンスに割り当てるジビバイト (GiB) 単位のストレージの量。 整数 (int)
associatedロール DB クラスターに関連付けられている AWS Identity and Access Management (IAM) ロールの一覧を提供します。 DB クラスターに関連付けられている IAM ロールは、DB クラスターがユーザーに代わって他の AWS サービスにアクセスするためのアクセス許可を付与します。 DBClusterロール[]
autoMinorVersionアップグレード メンテナンス期間中にマイナー エンジンのアップグレードが DB クラスターに自動的に適用されるかどうかを示す値。 既定では、マイナー エンジンのアップグレードは自動的に適用されます。 ブール (bool)
可用性ゾーン DB クラスター内のインスタンスを作成できる Availability Zones (AZs) の一覧。 AWS リージョンと Availability Zones の詳細については、Amazon Aurora ユーザー ガイドの「リージョンと Availability Zones の選択」を参照してください。 文字列[]
バックトラックウィンドウ ターゲット バックトラック ウィンドウ (秒単位)。 バックトラッキングを無効にするには、この値を 0 に設定します。 整数 (int)
バックアップ保持期間 自動バックアップが保持される日数。 整数 (int)
copyTagsToSnapshot すべてのタグを DB クラスターから DB クラスターのスナップショットにコピーするかどうかを示す値。 既定では、コピーされません。 ブール (bool)
データベース名 データベースの名前。 名前を指定しない場合、Amazon RDS はこの DB クラスターにデータベースを作成しません。 名前付け制約については、Amazon RDS ユーザーガイドの「名前付け制約」を参照してください。 糸
dbClusterArn の DB クラスターの Amazon リソース名 (ARN)。 糸
dbClusterIdentifier の DB クラスター識別子。 このパラメーターは、小文字の文字列として格納されます。 糸
dbClusterInstanceClass の マルチ AZ DB クラスター内の各 DB インスタンスのコンピューティング容量とメモリ容量 (例: db.m6g.xlarge)。 糸
dbClusterParameterGroupName (英語) この DB クラスターに関連付ける DB クラスター パラメーター グループの名前。 糸
dbClusterResourceId DB クラスターの AWS リージョン固有の不変識別子。 糸
dbInstanceParameterGroupName の DB クラスターのすべてのインスタンスに適用する DB パラメーター グループの名前。 糸
dbSubnetGroupName (英語) この DB クラスターに関連付ける DB サブネット グループ。 糸
dbSystemId の 将来の使用のために予約されています。 糸
削除保護 DB クラスターで削除保護が有効になっているかどうかを示す値。 削除保護が有効になっている場合、データベースを削除できません。 既定では、削除保護は無効になっています。 ブール (bool)
ドメイン DB クラスターを作成する Active Directory ディレクトリ ID。 糸
ドメインIAMRoleName ディレクトリサービスへの API 呼び出しを行うときに使用する IAM ロールの名前を指定します。 糸
enableCloudwatchLogsExports CloudWatch ログへのエクスポートを有効にする必要があるログの種類の一覧。 一覧の値は、使用されている DB エンジンによって異なります。 詳細については、Amazon Aurora ユーザーガイドの「Amazon CloudWatch ログへのデータベースログの発行」を参照してください。 文字列[]
enableGlobalWriteForwardingを使用します。 この DB クラスターがグローバル クラスター (Aurora グローバル データベース) のプライマリ クラスターに書き込み操作を転送できるようにするかどうかを指定します。 既定では、Aurora グローバル データベース内のセカンダリ クラスターである Aurora DB クラスターでは、書き込み操作は許可されません。 ブール (bool)
enableHttpエンドポイント DB クラスターの HTTP エンドポイントを有効にするかどうかを示す値。 既定では、HTTP エンドポイントは無効になっています。 ブール (bool)
enableIAMDatabase認証 AWS Identity and Access Management (IAM) アカウントのデータベース アカウントへのマッピングを有効にするかどうかを示す値。 既定では、マッピングは無効になっています。 ブール (bool)
エンドポイント プロパティ エンドポイント エンドポイント自動生成
エンジン この DB クラスターに使用するデータベース エンジンの名前。 有効な値: aurora (MySQL 5.6 と互換性のある Aurora の場合)、aurora-mysql (MySQL 5.7 互換の Aurora の場合)、aurora-postgresql 糸
エンジンモード DB クラスターの DB エンジン モード(プロビジョニング済み、サーバーレス、並列クエリ、グローバル、マルチマスター)。 糸
エンジンバージョン 使用するデータベース エンジンのバージョン番号。 糸
グローバルクラスタ識別子 Aurora グローバル データベース クラスターを構成していて、Aurora DB クラスターをグローバル データベース クラスターのセカンダリ メンバーにする場合は、グローバル データベース クラスターのグローバル クラスター ID を指定します。 グローバル クラスターのプライマリ データベース クラスターを定義するには、AWS::RDS::GlobalCluster リソースを使用します。グローバル データベース クラスターを構成していない場合は、このプロパティを指定しないでください。 糸
IOPSの マルチ AZ DB クラスター内の各 DB インスタンスに最初に割り当てられるプロビジョニング済み IOPS (1 秒あたりの入力/出力操作) の量。 整数 (int)
kmsKeyId (英語) DB クラスター内のデータベース インスタンスの暗号化に使用される AWS Key Management Service マスター キーの Amazon リソース名 (ARN) (arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef など)。 StorageEncrypted プロパティを有効にしたが、このプロパティを指定しない場合は、既定のマスター キーが使用されます。 このプロパティを指定する場合は、StorageEncrypted プロパティを true に設定する必要があります。 糸
manageMasterUserPassword さん AWS Secrets Manager でマスターユーザーパスワードを管理するかどうかを示す値。 ブール (bool)
masterユーザー名 DB クラスターのマスター ユーザーの名前。 SnapshotIdentifier を指定しない限り、MasterUsername を指定する必要があります。 その場合は、MasterUsername を指定しないでください。 糸
masterUserPassword さん DB インスタンスのマスター パスワード。 糸
masterUserSecret さん マスターユーザーパスワードの AWS Secrets Manager で RDS によって管理されるシークレットが含まれます。 masterUserSecret の
モニタリング間隔 拡張監視メトリックが DB クラスターに対して収集されるポイント間の間隔 (秒単位)。 拡張監視メトリックの収集をオフにするには、0 を指定します。 既定値は 0 です。 整数 (int)
監視ロールアルン RDS が拡張監視メトリックを Amazon CloudWatch ログに送信することを許可する IAM ロールの Amazon リソース名 (ARN)。 糸
ネットワークタイプ DB クラスターのネットワークの種類。 糸
performanceInsightsEnabled (パフォーマンスインサイト有効) DB クラスターの Performance Insights を有効にするかどうかを示す値。 ブール (bool)
performanceInsightsKmsKeyId Performance Insights データの暗号化のための Amazon Web Services KMS キー識別子。 糸
performanceInsights保持期間 Performance Insights データを保持する時間 (日数)。 整数 (int)
港 DB クラスター内のインスタンスが接続を受け入れるポート番号。 既定値: エンジンが aurora として設定されている場合は 3306、aurora-postgresql に設定されている場合は 5432。 整数 (int)
preferredBackupWindow BackupRetentionPeriod パラメーターを使用して自動バックアップが有効になっている場合に自動バックアップが作成される 1 日の時間範囲。 既定値は、AWS リージョンごとに 8 時間のブロックからランダムに選択された 30 分のウィンドウです。 使用可能な時間ブロックを確認するには、Amazon Aurora ユーザーガイドの「優先 DB クラスターメンテナンス期間の調整」を参照してください。 糸
preferredメンテナンスウィンドウ システムメンテナンスを実行できる週単位の時間範囲 (協定世界時 (UTC)。 既定では、AWS リージョンごとに 8 時間のブロックからランダムに選択された 30 分のウィンドウが、週のランダムな日に発生します。 使用可能な時間ブロックを確認するには、Amazon Aurora ユーザーガイドの「優先 DB クラスターメンテナンス期間の調整」を参照してください。 糸
パブリックアクセス可能 DB クラスターにパブリックにアクセスできるかどうかを示す値。 ブール (bool)
readエンドポイント プロパティ readEndpoint ReadEndpoint の
replicationSource識別子 この DB クラスターが読み取りレプリカとして作成される場合は、ソース DB インスタンスまたは DB クラスターの Amazon リソース名 (ARN)。 糸
restoreToTime(リストア・トゥ・タイム) DB クラスターの復元先の日付と時刻。 値は、世界協定時刻 (UTC) 形式の時刻である必要があります。 例: 2015-03-07T23:45:00Z 糸
リストアタイプ 実行する復元の種類。 次のいずれかの値を指定できます。完全コピー - 新しい DB クラスターは、ソース DB クラスターの完全コピーとして復元されます。書き込み時のコピー - 新しい DB クラスターは、ソース DB クラスターの複製として復元されます。 糸
スケーリング設定 ScalingConfiguration プロパティの種類は、Aurora サーバーレス DB クラスターのスケーリング構成を指定します。 ScalingConfiguration プロパティの種類は、Aurora サーバーレス DB クラスターのスケーリング構成を指定します。 スケーリング構成
サーバーレスV2ScalingConfiguration Aurora サーバーレス v2 DB クラスターのスケーリング構成が含まれています。 Aurora サーバーレス v2 DB クラスターのスケーリング構成が含まれています。 ServerlessV2ScalingConfiguration (サーバーレスV2Scaling構成)
スナップショット識別子 復元元の DB スナップショットまたは DB クラスター スナップショットの識別子。名前または Amazon リソース名 (ARN) を使用して、DB クラスタースナップショットを指定できます。 ただし、ARN のみを使用して DB スナップショットを指定できます。SnapshotIdentifier プロパティを使用して DB クラスターを復元した後は、DB クラスターに対する今後の更新に対して同じ SnapshotIdentifier プロパティを指定する必要があります。 更新プログラムにこのプロパティを指定した場合、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。 ただし、SnapshotIdentifier プロパティを指定しない場合は、空の DB クラスターが作成され、元の DB クラスターが削除されます。 前のスナップショット復元プロパティとは異なるプロパティを指定すると、指定した SnapshotIdentifier プロパティから DB クラスターが復元され、元の DB クラスターが削除されます。 糸
sourceDBCluster識別子 復元元のソース DB クラスターの識別子。 糸
ソースリージョン DB クラスターをレプリケートするときにソース DB クラスターを含む AWS リージョン。 たとえば、us-east-1 などです。 糸
ストレージ暗号化 DB インスタンスが暗号化されているかどうかを示します。DBClusterIdentifier、SnapshotIdentifier、または SourceDBInstanceIdentifier プロパティを指定する場合は、このプロパティを指定しないでください。 値は、クラスター、スナップショット、またはソース DB インスタンスから継承されます。 ブール (bool)
ストレージスループット DB クラスターのストレージ スループット値を指定します。 この設定は、gp3 ストレージの種類にのみ適用されます。 整数 (int)
ストレージタイプ DB クラスターに関連付けるストレージの種類を指定します。 糸
タグ このリソースに適用するキーと値のペアの配列。 タグ自動生成45[]
useLatestRestorableTime DB クラスターを最新の復元可能なバックアップ時間に復元するかどうかを示す値。 既定では、DB クラスターは復元可能な最新のバックアップ時間には復元されません。 ブール (bool)
vpcセキュリティグループID この DB クラスターに関連付ける EC2 VPC セキュリティグループの一覧。 文字列[]

DBClusterロール

名前 形容 価値
featureName (フィーチャー名) AWS Identity and Access Management (IAM) ロールに関連付けられている機能の名前。 サポートされている機能名の一覧については、Amazon RDS API リファレンスの DBEngineVersion を参照してください。 糸
ロールArn DB クラスターに関連付けられている IAM ロールの Amazon リソース名 (ARN)。 糸

エンドポイント自動生成

名前 形容 価値
住所 DB クラスターの接続エンドポイント。 糸
港 この DB クラスターでの接続を受け入れるポート番号。 糸

マスターユーザーシークレット

名前 形容 価値
kmsKeyId (英語) シークレットの暗号化に使用される AWS KMS キー識別子。 糸
シークレットアーン シークレットの Amazon リソース名 (ARN)。 糸

RdsDBClusterプロパティ

名前 形容 価値
ARN Amazon リソース名 (ARN) 糸
awsAccountId (英語) AWS アカウント ID 糸
awsプロパティ AWS のプロパティ awsRdsDBClusterProperties の
awsリージョン AWS リージョン 糸
awsSourceSchema (英語) AWS ソーススキーマ 糸
awsタグ AWS タグ RdsDBClusterPropertiesAwsTags の
publicCloudConnectorsリソースID パブリック クラウド コネクタのリソース ID 糸
publicCloudResourceName (パブリッククラウドリソース名) パブリック クラウド リソース名 糸

RdsDBClusterプロパティAwsTags

名前 形容 価値

リードエンドポイント

名前 形容 価値
住所 DB クラスターのリーダー エンドポイント。 糸

スケーリング構成

名前 形容 価値
自動一時停止 サーバーレス DB エンジン モードでの Aurora DB クラスターの自動一時停止を許可または禁止するかどうかを示す値。 DB クラスターは、アイドル状態 (接続がない場合) にのみ一時停止できます。 ブール (bool)
最大容量 サーバーレス DB エンジン モードでの Aurora DB クラスターの最大容量。Aurora MySQL の場合、有効な容量の値は 1、2、4、8、16、32、64、128、256 です。Aurora PostgreSQL の場合、有効な容量の値は 2、4、8、16、32、64、192、384 です。最大容量は最小容量以上である必要があります。 整数 (int)
最小容量 サーバーレス DB エンジン モードでの Aurora DB クラスターの最小容量。Aurora MySQL の場合、有効な容量の値は 1、2、4、8、16、32、64、128、256 です。Aurora PostgreSQL の場合、有効な容量の値は 2、4、8、16、32、64、192、384 です。最小容量は最大容量以下である必要があります。 整数 (int)
secondsBeforeTimeout (秒タイムアウト前) Aurora サーバーレス v1 が、タイムアウト アクションを適用する前にシームレスなスケーリングを実行するためのスケーリング ポイントの検索を試行する時間 (秒単位)。既定値は 300 です。 整数 (int)
秒UntilAutoPause サーバーレス モードの Aurora DB クラスターが一時停止されるまでの時間 (秒単位)。 整数 (int)
タイムアウトアクション タイムアウトに達したときに実行するアクション 。ForceApplyCapacityChange または RollbackCapacityChange.ForceApplyCapacityChange は、できるだけ早く指定された値に容量を設定します。既定値の RollbackCapacityChange は、タイムアウト期間中にスケーリング ポイントが見つからない場合、容量の変更を無視します。詳細については、Amazon Aurora ユーザーガイドの「Aurora サーバーレス v1 の自動スケーリング」を参照してください。 糸

ServerlessV2ScalingConfiguration (サーバーレスV2Scaling構成)

名前 形容 価値
最大容量 Aurora サーバーレス v2 クラスター内の DB インスタンスの Aurora 容量ユニット (AKU) の最大数。 ACU 値は、40、40.5、41 など、半ステップ単位で指定できます。 使用できる最大値は 128 です。 整数 (int)
最小容量 Aurora サーバーレス v2 クラスター内の DB インスタンスの Aurora 容量ユニット (AKU) の最小数。 ACU 値は、8、8.5、9 など、半ステップ単位で指定できます。 使用できる最小値は 0.5 です。 整数 (int)

タグ自動生成45

名前 形容 価値
鍵 タグのキー名。 長さが 1 ~ 128 の Unicode 文字の値を指定でき、aws: でプレフィックスを付けることはできません。 Unicode 文字、数字、空白文字、_、.、/、=、+、-のいずれかの文字を使用できます。 糸
価値 タグの値。 長さが 0 ~ 256 Unicode 文字の値を指定でき、aws: でプレフィックスを付けることはできません。 Unicode 文字、数字、空白文字、_、.、/、=、+、-のいずれかの文字を使用できます。 糸

追跡リソースタグ

名前 形容 価値

使用例

Terraform (AzAPI プロバイダー) リソース定義

rdsDBClusters リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.AwsConnector/rdsDBClusters リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AwsConnector/rdsDBClusters@2024-12-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      arn = "string"
      awsAccountId = "string"
      awsProperties = {
        allocatedStorage = int
        associatedRoles = [
          {
            featureName = "string"
            roleArn = "string"
          }
        ]
        autoMinorVersionUpgrade = bool
        availabilityZones = [
          "string"
        ]
        backtrackWindow = int
        backupRetentionPeriod = int
        copyTagsToSnapshot = bool
        databaseName = "string"
        dbClusterArn = "string"
        dbClusterIdentifier = "string"
        dbClusterInstanceClass = "string"
        dbClusterParameterGroupName = "string"
        dbClusterResourceId = "string"
        dbInstanceParameterGroupName = "string"
        dbSubnetGroupName = "string"
        dbSystemId = "string"
        deletionProtection = bool
        domain = "string"
        domainIAMRoleName = "string"
        enableCloudwatchLogsExports = [
          "string"
        ]
        enableGlobalWriteForwarding = bool
        enableHttpEndpoint = bool
        enableIAMDatabaseAuthentication = bool
        endpoint = {
          address = "string"
          port = "string"
        }
        engine = "string"
        engineMode = "string"
        engineVersion = "string"
        globalClusterIdentifier = "string"
        iops = int
        kmsKeyId = "string"
        manageMasterUserPassword = bool
        masterUsername = "string"
        masterUserPassword = "string"
        masterUserSecret = {
          kmsKeyId = "string"
          secretArn = "string"
        }
        monitoringInterval = int
        monitoringRoleArn = "string"
        networkType = "string"
        performanceInsightsEnabled = bool
        performanceInsightsKmsKeyId = "string"
        performanceInsightsRetentionPeriod = int
        port = int
        preferredBackupWindow = "string"
        preferredMaintenanceWindow = "string"
        publiclyAccessible = bool
        readEndpoint = {
          address = "string"
        }
        replicationSourceIdentifier = "string"
        restoreToTime = "string"
        restoreType = "string"
        scalingConfiguration = {
          autoPause = bool
          maxCapacity = int
          minCapacity = int
          secondsBeforeTimeout = int
          secondsUntilAutoPause = int
          timeoutAction = "string"
        }
        serverlessV2ScalingConfiguration = {
          maxCapacity = int
          minCapacity = int
        }
        snapshotIdentifier = "string"
        sourceDBClusterIdentifier = "string"
        sourceRegion = "string"
        storageEncrypted = bool
        storageThroughput = int
        storageType = "string"
        tags = [
          {
            key = "string"
            value = "string"
          }
        ]
        useLatestRestorableTime = bool
        vpcSecurityGroupIds = [
          "string"
        ]
      }
      awsRegion = "string"
      awsSourceSchema = "string"
      awsTags = {
        {customized property} = "string"
      }
      publicCloudConnectorsResourceId = "string"
      publicCloudResourceName = "string"
    }
  }
}

プロパティ値

Microsoft.AwsConnector/rdsDBClusters

名前 形容 価値
場所 リソースが存在する地理的な場所 string (必須)
名前 リソース名 糸

制約：
パターン = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (必須)
プロパティ このリソースのリソース固有のプロパティ。 RdsDBClusterProperties の
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.AwsConnector/rdsDBClusters@2024-12-01" (英語)

AwsRdsDBClusterプロパティ

名前 形容 価値
割り当て済みストレージ マルチ AZ DB クラスター内の各 DB インスタンスに割り当てるジビバイト (GiB) 単位のストレージの量。 整数 (int)
associatedロール DB クラスターに関連付けられている AWS Identity and Access Management (IAM) ロールの一覧を提供します。 DB クラスターに関連付けられている IAM ロールは、DB クラスターがユーザーに代わって他の AWS サービスにアクセスするためのアクセス許可を付与します。 DBClusterロール[]
autoMinorVersionアップグレード メンテナンス期間中にマイナー エンジンのアップグレードが DB クラスターに自動的に適用されるかどうかを示す値。 既定では、マイナー エンジンのアップグレードは自動的に適用されます。 ブール (bool)
可用性ゾーン DB クラスター内のインスタンスを作成できる Availability Zones (AZs) の一覧。 AWS リージョンと Availability Zones の詳細については、Amazon Aurora ユーザー ガイドの「リージョンと Availability Zones の選択」を参照してください。 文字列[]
バックトラックウィンドウ ターゲット バックトラック ウィンドウ (秒単位)。 バックトラッキングを無効にするには、この値を 0 に設定します。 整数 (int)
バックアップ保持期間 自動バックアップが保持される日数。 整数 (int)
copyTagsToSnapshot すべてのタグを DB クラスターから DB クラスターのスナップショットにコピーするかどうかを示す値。 既定では、コピーされません。 ブール (bool)
データベース名 データベースの名前。 名前を指定しない場合、Amazon RDS はこの DB クラスターにデータベースを作成しません。 名前付け制約については、Amazon RDS ユーザーガイドの「名前付け制約」を参照してください。 糸
dbClusterArn の DB クラスターの Amazon リソース名 (ARN)。 糸
dbClusterIdentifier の DB クラスター識別子。 このパラメーターは、小文字の文字列として格納されます。 糸
dbClusterInstanceClass の マルチ AZ DB クラスター内の各 DB インスタンスのコンピューティング容量とメモリ容量 (例: db.m6g.xlarge)。 糸
dbClusterParameterGroupName (英語) この DB クラスターに関連付ける DB クラスター パラメーター グループの名前。 糸
dbClusterResourceId DB クラスターの AWS リージョン固有の不変識別子。 糸
dbInstanceParameterGroupName の DB クラスターのすべてのインスタンスに適用する DB パラメーター グループの名前。 糸
dbSubnetGroupName (英語) この DB クラスターに関連付ける DB サブネット グループ。 糸
dbSystemId の 将来の使用のために予約されています。 糸
削除保護 DB クラスターで削除保護が有効になっているかどうかを示す値。 削除保護が有効になっている場合、データベースを削除できません。 既定では、削除保護は無効になっています。 ブール (bool)
ドメイン DB クラスターを作成する Active Directory ディレクトリ ID。 糸
ドメインIAMRoleName ディレクトリサービスへの API 呼び出しを行うときに使用する IAM ロールの名前を指定します。 糸
enableCloudwatchLogsExports CloudWatch ログへのエクスポートを有効にする必要があるログの種類の一覧。 一覧の値は、使用されている DB エンジンによって異なります。 詳細については、Amazon Aurora ユーザーガイドの「Amazon CloudWatch ログへのデータベースログの発行」を参照してください。 文字列[]
enableGlobalWriteForwardingを使用します。 この DB クラスターがグローバル クラスター (Aurora グローバル データベース) のプライマリ クラスターに書き込み操作を転送できるようにするかどうかを指定します。 既定では、Aurora グローバル データベース内のセカンダリ クラスターである Aurora DB クラスターでは、書き込み操作は許可されません。 ブール (bool)
enableHttpエンドポイント DB クラスターの HTTP エンドポイントを有効にするかどうかを示す値。 既定では、HTTP エンドポイントは無効になっています。 ブール (bool)
enableIAMDatabase認証 AWS Identity and Access Management (IAM) アカウントのデータベース アカウントへのマッピングを有効にするかどうかを示す値。 既定では、マッピングは無効になっています。 ブール (bool)
エンドポイント プロパティ エンドポイント エンドポイント自動生成
エンジン この DB クラスターに使用するデータベース エンジンの名前。 有効な値: aurora (MySQL 5.6 と互換性のある Aurora の場合)、aurora-mysql (MySQL 5.7 互換の Aurora の場合)、aurora-postgresql 糸
エンジンモード DB クラスターの DB エンジン モード(プロビジョニング済み、サーバーレス、並列クエリ、グローバル、マルチマスター)。 糸
エンジンバージョン 使用するデータベース エンジンのバージョン番号。 糸
グローバルクラスタ識別子 Aurora グローバル データベース クラスターを構成していて、Aurora DB クラスターをグローバル データベース クラスターのセカンダリ メンバーにする場合は、グローバル データベース クラスターのグローバル クラスター ID を指定します。 グローバル クラスターのプライマリ データベース クラスターを定義するには、AWS::RDS::GlobalCluster リソースを使用します。グローバル データベース クラスターを構成していない場合は、このプロパティを指定しないでください。 糸
IOPSの マルチ AZ DB クラスター内の各 DB インスタンスに最初に割り当てられるプロビジョニング済み IOPS (1 秒あたりの入力/出力操作) の量。 整数 (int)
kmsKeyId (英語) DB クラスター内のデータベース インスタンスの暗号化に使用される AWS Key Management Service マスター キーの Amazon リソース名 (ARN) (arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef など)。 StorageEncrypted プロパティを有効にしたが、このプロパティを指定しない場合は、既定のマスター キーが使用されます。 このプロパティを指定する場合は、StorageEncrypted プロパティを true に設定する必要があります。 糸
manageMasterUserPassword さん AWS Secrets Manager でマスターユーザーパスワードを管理するかどうかを示す値。 ブール (bool)
masterユーザー名 DB クラスターのマスター ユーザーの名前。 SnapshotIdentifier を指定しない限り、MasterUsername を指定する必要があります。 その場合は、MasterUsername を指定しないでください。 糸
masterUserPassword さん DB インスタンスのマスター パスワード。 糸
masterUserSecret さん マスターユーザーパスワードの AWS Secrets Manager で RDS によって管理されるシークレットが含まれます。 masterUserSecret の
モニタリング間隔 拡張監視メトリックが DB クラスターに対して収集されるポイント間の間隔 (秒単位)。 拡張監視メトリックの収集をオフにするには、0 を指定します。 既定値は 0 です。 整数 (int)
監視ロールアルン RDS が拡張監視メトリックを Amazon CloudWatch ログに送信することを許可する IAM ロールの Amazon リソース名 (ARN)。 糸
ネットワークタイプ DB クラスターのネットワークの種類。 糸
performanceInsightsEnabled (パフォーマンスインサイト有効) DB クラスターの Performance Insights を有効にするかどうかを示す値。 ブール (bool)
performanceInsightsKmsKeyId Performance Insights データの暗号化のための Amazon Web Services KMS キー識別子。 糸
performanceInsights保持期間 Performance Insights データを保持する時間 (日数)。 整数 (int)
港 DB クラスター内のインスタンスが接続を受け入れるポート番号。 既定値: エンジンが aurora として設定されている場合は 3306、aurora-postgresql に設定されている場合は 5432。 整数 (int)
preferredBackupWindow BackupRetentionPeriod パラメーターを使用して自動バックアップが有効になっている場合に自動バックアップが作成される 1 日の時間範囲。 既定値は、AWS リージョンごとに 8 時間のブロックからランダムに選択された 30 分のウィンドウです。 使用可能な時間ブロックを確認するには、Amazon Aurora ユーザーガイドの「優先 DB クラスターメンテナンス期間の調整」を参照してください。 糸
preferredメンテナンスウィンドウ システムメンテナンスを実行できる週単位の時間範囲 (協定世界時 (UTC)。 既定では、AWS リージョンごとに 8 時間のブロックからランダムに選択された 30 分のウィンドウが、週のランダムな日に発生します。 使用可能な時間ブロックを確認するには、Amazon Aurora ユーザーガイドの「優先 DB クラスターメンテナンス期間の調整」を参照してください。 糸
パブリックアクセス可能 DB クラスターにパブリックにアクセスできるかどうかを示す値。 ブール (bool)
readエンドポイント プロパティ readEndpoint ReadEndpoint の
replicationSource識別子 この DB クラスターが読み取りレプリカとして作成される場合は、ソース DB インスタンスまたは DB クラスターの Amazon リソース名 (ARN)。 糸
restoreToTime(リストア・トゥ・タイム) DB クラスターの復元先の日付と時刻。 値は、世界協定時刻 (UTC) 形式の時刻である必要があります。 例: 2015-03-07T23:45:00Z 糸
リストアタイプ 実行する復元の種類。 次のいずれかの値を指定できます。完全コピー - 新しい DB クラスターは、ソース DB クラスターの完全コピーとして復元されます。書き込み時のコピー - 新しい DB クラスターは、ソース DB クラスターの複製として復元されます。 糸
スケーリング設定 ScalingConfiguration プロパティの種類は、Aurora サーバーレス DB クラスターのスケーリング構成を指定します。 ScalingConfiguration プロパティの種類は、Aurora サーバーレス DB クラスターのスケーリング構成を指定します。 スケーリング構成
サーバーレスV2ScalingConfiguration Aurora サーバーレス v2 DB クラスターのスケーリング構成が含まれています。 Aurora サーバーレス v2 DB クラスターのスケーリング構成が含まれています。 ServerlessV2ScalingConfiguration (サーバーレスV2Scaling構成)
スナップショット識別子 復元元の DB スナップショットまたは DB クラスター スナップショットの識別子。名前または Amazon リソース名 (ARN) を使用して、DB クラスタースナップショットを指定できます。 ただし、ARN のみを使用して DB スナップショットを指定できます。SnapshotIdentifier プロパティを使用して DB クラスターを復元した後は、DB クラスターに対する今後の更新に対して同じ SnapshotIdentifier プロパティを指定する必要があります。 更新プログラムにこのプロパティを指定した場合、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。 ただし、SnapshotIdentifier プロパティを指定しない場合は、空の DB クラスターが作成され、元の DB クラスターが削除されます。 前のスナップショット復元プロパティとは異なるプロパティを指定すると、指定した SnapshotIdentifier プロパティから DB クラスターが復元され、元の DB クラスターが削除されます。 糸
sourceDBCluster識別子 復元元のソース DB クラスターの識別子。 糸
ソースリージョン DB クラスターをレプリケートするときにソース DB クラスターを含む AWS リージョン。 たとえば、us-east-1 などです。 糸
ストレージ暗号化 DB インスタンスが暗号化されているかどうかを示します。DBClusterIdentifier、SnapshotIdentifier、または SourceDBInstanceIdentifier プロパティを指定する場合は、このプロパティを指定しないでください。 値は、クラスター、スナップショット、またはソース DB インスタンスから継承されます。 ブール (bool)
ストレージスループット DB クラスターのストレージ スループット値を指定します。 この設定は、gp3 ストレージの種類にのみ適用されます。 整数 (int)
ストレージタイプ DB クラスターに関連付けるストレージの種類を指定します。 糸
タグ このリソースに適用するキーと値のペアの配列。 タグ自動生成45[]
useLatestRestorableTime DB クラスターを最新の復元可能なバックアップ時間に復元するかどうかを示す値。 既定では、DB クラスターは復元可能な最新のバックアップ時間には復元されません。 ブール (bool)
vpcセキュリティグループID この DB クラスターに関連付ける EC2 VPC セキュリティグループの一覧。 文字列[]

DBClusterロール

名前 形容 価値
featureName (フィーチャー名) AWS Identity and Access Management (IAM) ロールに関連付けられている機能の名前。 サポートされている機能名の一覧については、Amazon RDS API リファレンスの DBEngineVersion を参照してください。 糸
ロールArn DB クラスターに関連付けられている IAM ロールの Amazon リソース名 (ARN)。 糸

エンドポイント自動生成

名前 形容 価値
住所 DB クラスターの接続エンドポイント。 糸
港 この DB クラスターでの接続を受け入れるポート番号。 糸

マスターユーザーシークレット

名前 形容 価値
kmsKeyId (英語) シークレットの暗号化に使用される AWS KMS キー識別子。 糸
シークレットアーン シークレットの Amazon リソース名 (ARN)。 糸

RdsDBClusterプロパティ

名前 形容 価値
ARN Amazon リソース名 (ARN) 糸
awsAccountId (英語) AWS アカウント ID 糸
awsプロパティ AWS のプロパティ awsRdsDBClusterProperties の
awsリージョン AWS リージョン 糸
awsSourceSchema (英語) AWS ソーススキーマ 糸
awsタグ AWS タグ RdsDBClusterPropertiesAwsTags の
publicCloudConnectorsリソースID パブリック クラウド コネクタのリソース ID 糸
publicCloudResourceName (パブリッククラウドリソース名) パブリック クラウド リソース名 糸

RdsDBClusterプロパティAwsTags

名前 形容 価値

リードエンドポイント

名前 形容 価値
住所 DB クラスターのリーダー エンドポイント。 糸

スケーリング構成

名前 形容 価値
自動一時停止 サーバーレス DB エンジン モードでの Aurora DB クラスターの自動一時停止を許可または禁止するかどうかを示す値。 DB クラスターは、アイドル状態 (接続がない場合) にのみ一時停止できます。 ブール (bool)
最大容量 サーバーレス DB エンジン モードでの Aurora DB クラスターの最大容量。Aurora MySQL の場合、有効な容量の値は 1、2、4、8、16、32、64、128、256 です。Aurora PostgreSQL の場合、有効な容量の値は 2、4、8、16、32、64、192、384 です。最大容量は最小容量以上である必要があります。 整数 (int)
最小容量 サーバーレス DB エンジン モードでの Aurora DB クラスターの最小容量。Aurora MySQL の場合、有効な容量の値は 1、2、4、8、16、32、64、128、256 です。Aurora PostgreSQL の場合、有効な容量の値は 2、4、8、16、32、64、192、384 です。最小容量は最大容量以下である必要があります。 整数 (int)
secondsBeforeTimeout (秒タイムアウト前) Aurora サーバーレス v1 が、タイムアウト アクションを適用する前にシームレスなスケーリングを実行するためのスケーリング ポイントの検索を試行する時間 (秒単位)。既定値は 300 です。 整数 (int)
秒UntilAutoPause サーバーレス モードの Aurora DB クラスターが一時停止されるまでの時間 (秒単位)。 整数 (int)
タイムアウトアクション タイムアウトに達したときに実行するアクション 。ForceApplyCapacityChange または RollbackCapacityChange.ForceApplyCapacityChange は、できるだけ早く指定された値に容量を設定します。既定値の RollbackCapacityChange は、タイムアウト期間中にスケーリング ポイントが見つからない場合、容量の変更を無視します。詳細については、Amazon Aurora ユーザーガイドの「Aurora サーバーレス v1 の自動スケーリング」を参照してください。 糸

ServerlessV2ScalingConfiguration (サーバーレスV2Scaling構成)

名前 形容 価値
最大容量 Aurora サーバーレス v2 クラスター内の DB インスタンスの Aurora 容量ユニット (AKU) の最大数。 ACU 値は、40、40.5、41 など、半ステップ単位で指定できます。 使用できる最大値は 128 です。 整数 (int)
最小容量 Aurora サーバーレス v2 クラスター内の DB インスタンスの Aurora 容量ユニット (AKU) の最小数。 ACU 値は、8、8.5、9 など、半ステップ単位で指定できます。 使用できる最小値は 0.5 です。 整数 (int)

タグ自動生成45

名前 形容 価値
鍵 タグのキー名。 長さが 1 ~ 128 の Unicode 文字の値を指定でき、aws: でプレフィックスを付けることはできません。 Unicode 文字、数字、空白文字、_、.、/、=、+、-のいずれかの文字を使用できます。 糸
価値 タグの値。 長さが 0 ~ 256 Unicode 文字の値を指定でき、aws: でプレフィックスを付けることはできません。 Unicode 文字、数字、空白文字、_、.、/、=、+、-のいずれかの文字を使用できます。 糸

追跡リソースタグ

名前 形容 価値