Microsoft.AwsConnector redshiftClusters

2025-05-14

最新のをする
2024-12-01

Bicep リソース定義

redshiftClusters リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.AwsConnector/redshiftClusters@2024-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    arn: 'string'
    awsAccountId: 'string'
    awsProperties: {
      allowVersionUpgrade: bool
      aquaConfigurationStatus: 'string'
      automatedSnapshotRetentionPeriod: int
      availabilityZone: 'string'
      availabilityZoneRelocation: bool
      availabilityZoneRelocationStatus: 'string'
      classic: bool
      clusterIdentifier: 'string'
      clusterNamespaceArn: 'string'
      clusterParameterGroupName: 'string'
      clusterSecurityGroups: [
        'string'
      ]
      clusterSubnetGroupName: 'string'
      clusterType: 'string'
      clusterVersion: 'string'
      dbName: 'string'
      deferMaintenance: bool
      deferMaintenanceDuration: int
      deferMaintenanceEndTime: 'string'
      deferMaintenanceIdentifier: 'string'
      deferMaintenanceStartTime: 'string'
      destinationRegion: 'string'
      elasticIp: 'string'
      encrypted: bool
      endpoint: {
        address: 'string'
        port: 'string'
      }
      enhancedVpcRouting: bool
      hsmClientCertificateIdentifier: 'string'
      hsmConfigurationIdentifier: 'string'
      iamRoles: [
        'string'
      ]
      kmsKeyId: 'string'
      loggingProperties: {
        bucketName: 'string'
        s3KeyPrefix: 'string'
      }
      maintenanceTrackName: 'string'
      manageMasterPassword: bool
      manualSnapshotRetentionPeriod: int
      masterPasswordSecretArn: 'string'
      masterPasswordSecretKmsKeyId: 'string'
      masterUsername: 'string'
      masterUserPassword: 'string'
      multiAZ: bool
      namespaceResourcePolicy: any(...)
      nodeType: 'string'
      numberOfNodes: int
      ownerAccount: 'string'
      port: int
      preferredMaintenanceWindow: 'string'
      publiclyAccessible: bool
      resourceAction: 'string'
      revisionTarget: 'string'
      rotateEncryptionKey: bool
      snapshotClusterIdentifier: 'string'
      snapshotCopyGrantName: 'string'
      snapshotCopyManual: bool
      snapshotCopyRetentionPeriod: int
      snapshotIdentifier: 'string'
      tags: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      vpcSecurityGroupIds: [
        'string'
      ]
    }
    awsRegion: 'string'
    awsSourceSchema: 'string'
    awsTags: {
      {customized property}: 'string'
    }
    publicCloudConnectorsResourceId: 'string'
    publicCloudResourceName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.AwsConnector/redshiftClusters

名前	形容	価値
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：パターン = `^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])` (必須)
プロパティ	このリソースのリソース固有のプロパティ。	RedshiftClusterProperties (英語)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

AwsRedshiftクラスタープロパティ

名前	形容	価値
allowVersionUpgrade (英語)	メジャーバージョンのアップグレードは、メンテナンス期間中に、クラスターで実行されている Amazon Redshift エンジンに適用できます。既定値は True です	ブール (bool)
aquaConfigurationStatus(アクアコンフィギュレーションステータス)	この値は、クラスターの復元後に AQUA (高度なクエリアクセラレータ) を使用するようにクラスターを構成する方法を表します。使用できる値は次のとおりです。現在のリージョンで使用可能な場合は AQUA を使用し、Amazon Redshift ノードタイプで使用できます。disabled - AQUA.auto を使用しない - Amazon Redshift は AQUA を使用するかどうかを決定します。	糸
自動スナップショット保持期間	自動スナップショットが保持される日数。値が 0 の場合、自動スナップショットは無効になります。既定値は 1 です	整数 (int)
アベイラビリティゾーン	Amazon Redshift でクラスターをプロビジョニングする EC2 可用性ゾーン (AZ)。既定値: エンドポイントによって指定されたリージョン内の、システムが選択したランダムな可用性ゾーン	糸
availabilityZone再配置	クラスターの変更が完了した後で、Availability Zones 間の Amazon Redshift クラスターの再配置を有効にするオプション。	ブール (bool)
availabilityZoneRelocationStatus (可用性ゾーン再配置ステータス)	クラスターの可用性ゾーンの再配置状態	糸
クラシック	サイズ変更操作でクラシックサイズ変更プロセスが使用されているかどうかを示すブール値。このパラメーターを指定しない場合、または値を false に設定すると、サイズ変更の種類はエラスティックになります。	ブール (bool)
クラスタ識別子	クラスターの一意識別子。この識別子は、削除や変更などの後続のクラスター操作でクラスターを参照するために使用します。すべてのアルファベット文字は小文字にする必要があります。末尾にハイペンはなく、2 つの連続するハイフンは使用できません。クラスター名は、AWS アカウント内のすべてのクラスターで一意である必要があります	糸
clusterNamespaceArn	クラスター名前空間の Amazon リソース名 (ARN)。	糸
clusterParameterGroupName (クラスターパラメータグループ名)	このクラスターに関連付けるパラメーターグループの名前。	糸
clusterSecurityGroups (クラスタセキュリティグループ)	このクラスターに関連付けるセキュリティグループの一覧。	文字列[]
クラスタサブネットグループ名	このクラスターに関連付けるクラスターサブネットグループの名前。	糸
クラスタタイプ	クラスターの種類。クラスターの種類が単一ノードとして指定されている場合、NumberOfNodes パラメーターは必要なく、複数ノードの場合は NumberOfNodes パラメーターが必要です。	糸
クラスタバージョン	クラスターにデプロイする Amazon Redshift エンジンソフトウェアのバージョン。選択したバージョンは、クラスター内のすべてのノードで実行されます。	糸
データベース名	クラスターの作成時に作成される最初のデータベースの名前。クラスターの作成後に追加のデータベースを作成するには、SQL クライアントを使用してクラスターに接続し、SQL コマンドを使用してデータベースを作成します。	糸
延期メンテナンス	遅延メンテナンス期間を有効にするかどうかを示すブール値。	ブール (bool)
デファーメンテナンス期間	メンテナンス期間の期間を日数で示す整数。期間を指定した場合、終了時刻を指定することはできません。期間は 45 日以下にする必要があります。	整数 (int)
メンテナンス終了時刻を延期する	遅延メンテナンス期間の終了時刻を示すタイムスタンプ。終了時刻を指定した場合、期間を指定することはできません。	糸
deferMaintenance識別子	遅延メンテナンス期間の一意識別子。	糸
deferMaintenanceStartTime	遅延メンテナンス期間の開始時刻を示すタイムスタンプ。	糸
宛先地域	スナップショットのコピー先の AWS リージョン。制約: 有効な AWS リージョンの名前である必要があります。詳細については、「アマゾンウェブサービスのリージョンとエンドポイント」を参照してください [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] 全般リファレンス	糸
elasticIpの	クラスターのエラスティック IP (EIP) アドレス。	糸
暗号化	true の場合、クラスター内のデータは保存時に暗号化されます。	ブール (bool)
エンドポイント	プロパティエンドポイント	エンドポイント自動生成3
enhancedVpcRouting	拡張 VPC ルーティングを有効にしてクラスターを作成するかどうかを指定するオプション。拡張 VPC ルーティングを使用するクラスターを作成するには、クラスターが VPC 内にある必要があります。詳細については、Amazon Redshift クラスター管理ガイドの拡張 VPC ルーティングを参照してください。このオプションが true の場合、拡張 VPC ルーティングが有効になります。既定値: false	ブール (bool)
hsmClientCertificate識別子	Amazon Redshift クラスターが HSM に格納されているデータ暗号化キーを取得するために使用する HSM クライアント証明書の名前を指定します。	糸
hsmConfiguration識別子	Amazon Redshift クラスターが HSM のキーの取得と格納に使用できる情報を含む HSM 構成の名前を指定します。	糸
iamロール	クラスターが他の AWS サービスにアクセスするために使用できる AWS ID およびアクセス管理 (IAM) ロールの一覧。 IAM ロールは、Amazon リソース名 (ARN) 形式で指定する必要があります。 1 つの要求で最大 50 個の IAM ロールを指定できます	文字列[]
kmsKeyId (英語)	クラスター内のデータの暗号化に使用する暗号化キーの AWS Key Management Service (KMS) キー ID。	糸
ロギングプロパティ	プロパティ loggingProperties	ロギングプロパティ
メンテナンストラック名	クラスターに割り当てるメンテナンストラックの名前。この名前の変更は非同期です。新しいトラック名は、次のメンテナンス期間までクラスターの PendingModifiedValues に保持されます。メンテナンストラックが変更されると、クラスターはメンテナンストラックで使用可能な最新のクラスターリリースに切り替わります。この時点で、メンテナンストラック名が適用されます。	糸
manageMasterPasswordの	Redshift クラスターの管理者ユーザー資格情報が Redshift によって管理されているかどうかを示すブール値。 ManageMasterPassword が true の場合、MasterUserPassword を使用することはできません。 ManageMasterPassword が false または設定されていない場合、Amazon Redshift は管理者ユーザーアカウントのパスワードに MasterUserPassword を使用します。	ブール (bool)
manualSnapshotRetentionPeriod (英語)	コピー元の AWS リージョンからコピーされた後、コピー先の AWS リージョンに新しくコピーされたスナップショットを保持する日数。値が -1 の場合、手動スナップショットは無期限に保持されます。値は、-1 または 1 ~ 3,653 の整数である必要があります。	整数 (int)
masterPasswordSecretArn さん	クラスターの管理者ユーザー資格情報シークレットの Amazon リソース名 (ARN)。	糸
masterPasswordSecretKmsKeyId	クラスターの管理者ユーザー資格情報シークレットの暗号化と格納に使用されるキー管理サービス (KMS) キーの ID。	糸
masterユーザー名	作成されるクラスターのマスターユーザーアカウントに関連付けられているユーザー名。ユーザー名を PUBLIC にすることはできません。最初の文字は文字にする必要があります。	糸
masterUserPassword さん	作成されるクラスターのマスターユーザーアカウントに関連付けられているパスワード。 ManageMasterPassword が true の場合、MasterUserPassword を使用することはできません。パスワードの長さは 8 ~ 64 文字で、大文字は 1 文字以上にする必要があります。少なくとも 1 つの小文字を含む必要があります。1 つの数値を含む必要があります。印刷可能な任意の ASCII 文字を指定できます。	糸
マルチAZ	redshift クラスターが multi-az かどうかを示すブール値。このパラメーターを指定しない場合、または値を false に設定すると、redshift クラスターは単一 az になります。	ブール (bool)
名前空間リソースポリシー	Redshift クラスターにアタッチされる名前空間リソースポリシードキュメント。	任意
ノードタイプ	クラスターにプロビジョニングするノードタイプ。有効な値: ds2.xlarge \|DS2.8XLサイズ \|DC1.ラージ \|DC1.8xラージ \|dc2.ラージ \|DC2.8xラージ \|RA3.4XLサイズ \|RA3.16倍大	糸
numberOfNodes の	クラスター内のコンピューティングノードの数。このパラメーターは、ClusterType パラメーターがマルチノードとして指定されている場合に必要です。	整数 (int)
オーナーアカウント	プロパティ所有者アカウント	糸
港	クラスターが受信接続を受け入れるポート番号。クラスターには、JDBC 接続文字列と ODBC 接続文字列を介してのみアクセスできます	整数 (int)
preferredメンテナンスウィンドウ	クラスターの自動メンテナンスを実行できる週単位の時間範囲 (UTC)。	糸
パブリックアクセス可能	true の場合、クラスターはパブリックネットワークからアクセスできます。	ブール (bool)
リソースアクション	実行する Redshift 操作。 Resource Action では、pause-cluster、resume-cluster、failover-primary-compute API がサポートされます	糸
リビジョンターゲット	データベースリビジョンの識別子。 DescribeClusterDbRevisions 要求への応答からこの値を取得できます。	糸
ローテーション暗号化キー	暗号化キーをローテーションするかどうかを示すブール値。	ブール (bool)
スナップショットクラスタ識別子	ソーススナップショットが作成されたクラスターの名前。このパラメーターは、IAM ユーザーに、クラスター名に * 以外のものを指定するスナップショットリソース要素を含むポリシーがある場合に必要です。	糸
スナップショットCopyGrantName	AWS KMS で暗号化されたクラスターのスナップショットがコピー先リージョンにコピーされるときに使用するスナップショットコピー許可の名前。	糸
スナップショットCopyManual	自動スナップショットではなく、新しくコピーした手動スナップショットにスナップショット保有期間を適用するかどうかを示します。	ブール (bool)
snapshotCopyRetentionPeriod (英語)	コピー元リージョンからコピーされた後に、コピー先リージョンに自動スナップショットを保持する日数。既定値は 7 です。制約: 1 以上 35 以下にする必要があります。	整数 (int)
スナップショット識別子	新しいクラスターの作成元となるスナップショットの名前。このパラメーターでは、大文字と小文字は区別されません。	糸
タグ	クラスターパラメーターグループのタグの一覧。	タグ[]
vpcセキュリティグループID	クラスターに関連付ける仮想プライベートクラウド (VPC) セキュリティグループの一覧。	文字列[]

エンドポイント自動生成3

名前	形容	価値
住所	プロパティアドレス	糸
港	プロパティポート	糸

ロギングプロパティ

名前	形容	価値
バケット名	プロパティbucketName	糸
s3Keyプレフィックス	プロパティ s3KeyPrefix	糸

RedshiftClusterProperties (英語)

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

RedshiftClusterPropertiesAwsタグ

名前	形容	価値

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

追跡リソースタグ

名前	形容	価値

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

redshiftClusters リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

{
  "type": "Microsoft.AwsConnector/redshiftClusters",
  "apiVersion": "2024-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "arn": "string",
    "awsAccountId": "string",
    "awsProperties": {
      "allowVersionUpgrade": "bool",
      "aquaConfigurationStatus": "string",
      "automatedSnapshotRetentionPeriod": "int",
      "availabilityZone": "string",
      "availabilityZoneRelocation": "bool",
      "availabilityZoneRelocationStatus": "string",
      "classic": "bool",
      "clusterIdentifier": "string",
      "clusterNamespaceArn": "string",
      "clusterParameterGroupName": "string",
      "clusterSecurityGroups": [ "string" ],
      "clusterSubnetGroupName": "string",
      "clusterType": "string",
      "clusterVersion": "string",
      "dbName": "string",
      "deferMaintenance": "bool",
      "deferMaintenanceDuration": "int",
      "deferMaintenanceEndTime": "string",
      "deferMaintenanceIdentifier": "string",
      "deferMaintenanceStartTime": "string",
      "destinationRegion": "string",
      "elasticIp": "string",
      "encrypted": "bool",
      "endpoint": {
        "address": "string",
        "port": "string"
      },
      "enhancedVpcRouting": "bool",
      "hsmClientCertificateIdentifier": "string",
      "hsmConfigurationIdentifier": "string",
      "iamRoles": [ "string" ],
      "kmsKeyId": "string",
      "loggingProperties": {
        "bucketName": "string",
        "s3KeyPrefix": "string"
      },
      "maintenanceTrackName": "string",
      "manageMasterPassword": "bool",
      "manualSnapshotRetentionPeriod": "int",
      "masterPasswordSecretArn": "string",
      "masterPasswordSecretKmsKeyId": "string",
      "masterUsername": "string",
      "masterUserPassword": "string",
      "multiAZ": "bool",
      "namespaceResourcePolicy": {},
      "nodeType": "string",
      "numberOfNodes": "int",
      "ownerAccount": "string",
      "port": "int",
      "preferredMaintenanceWindow": "string",
      "publiclyAccessible": "bool",
      "resourceAction": "string",
      "revisionTarget": "string",
      "rotateEncryptionKey": "bool",
      "snapshotClusterIdentifier": "string",
      "snapshotCopyGrantName": "string",
      "snapshotCopyManual": "bool",
      "snapshotCopyRetentionPeriod": "int",
      "snapshotIdentifier": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcSecurityGroupIds": [ "string" ]
    },
    "awsRegion": "string",
    "awsSourceSchema": "string",
    "awsTags": {
      "{customized property}": "string"
    },
    "publicCloudConnectorsResourceId": "string",
    "publicCloudResourceName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.AwsConnector/redshiftClusters

名前	形容	価値
apiVersion (英語)	API のバージョン	'2024-12-01'
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：パターン = `^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])` (必須)
プロパティ	このリソースのリソース固有のプロパティ。	RedshiftClusterProperties (英語)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.AwsConnector/redshiftClusters'

AwsRedshiftクラスタープロパティ

名前	形容	価値
allowVersionUpgrade (英語)	メジャーバージョンのアップグレードは、メンテナンス期間中に、クラスターで実行されている Amazon Redshift エンジンに適用できます。既定値は True です	ブール (bool)
aquaConfigurationStatus(アクアコンフィギュレーションステータス)	この値は、クラスターの復元後に AQUA (高度なクエリアクセラレータ) を使用するようにクラスターを構成する方法を表します。使用できる値は次のとおりです。現在のリージョンで使用可能な場合は AQUA を使用し、Amazon Redshift ノードタイプで使用できます。disabled - AQUA.auto を使用しない - Amazon Redshift は AQUA を使用するかどうかを決定します。	糸
自動スナップショット保持期間	自動スナップショットが保持される日数。値が 0 の場合、自動スナップショットは無効になります。既定値は 1 です	整数 (int)
アベイラビリティゾーン	Amazon Redshift でクラスターをプロビジョニングする EC2 可用性ゾーン (AZ)。既定値: エンドポイントによって指定されたリージョン内の、システムが選択したランダムな可用性ゾーン	糸
availabilityZone再配置	クラスターの変更が完了した後で、Availability Zones 間の Amazon Redshift クラスターの再配置を有効にするオプション。	ブール (bool)
availabilityZoneRelocationStatus (可用性ゾーン再配置ステータス)	クラスターの可用性ゾーンの再配置状態	糸
クラシック	サイズ変更操作でクラシックサイズ変更プロセスが使用されているかどうかを示すブール値。このパラメーターを指定しない場合、または値を false に設定すると、サイズ変更の種類はエラスティックになります。	ブール (bool)
クラスタ識別子	クラスターの一意識別子。この識別子は、削除や変更などの後続のクラスター操作でクラスターを参照するために使用します。すべてのアルファベット文字は小文字にする必要があります。末尾にハイペンはなく、2 つの連続するハイフンは使用できません。クラスター名は、AWS アカウント内のすべてのクラスターで一意である必要があります	糸
clusterNamespaceArn	クラスター名前空間の Amazon リソース名 (ARN)。	糸
clusterParameterGroupName (クラスターパラメータグループ名)	このクラスターに関連付けるパラメーターグループの名前。	糸
clusterSecurityGroups (クラスタセキュリティグループ)	このクラスターに関連付けるセキュリティグループの一覧。	文字列[]
クラスタサブネットグループ名	このクラスターに関連付けるクラスターサブネットグループの名前。	糸
クラスタタイプ	クラスターの種類。クラスターの種類が単一ノードとして指定されている場合、NumberOfNodes パラメーターは必要なく、複数ノードの場合は NumberOfNodes パラメーターが必要です。	糸
クラスタバージョン	クラスターにデプロイする Amazon Redshift エンジンソフトウェアのバージョン。選択したバージョンは、クラスター内のすべてのノードで実行されます。	糸
データベース名	クラスターの作成時に作成される最初のデータベースの名前。クラスターの作成後に追加のデータベースを作成するには、SQL クライアントを使用してクラスターに接続し、SQL コマンドを使用してデータベースを作成します。	糸
延期メンテナンス	遅延メンテナンス期間を有効にするかどうかを示すブール値。	ブール (bool)
デファーメンテナンス期間	メンテナンス期間の期間を日数で示す整数。期間を指定した場合、終了時刻を指定することはできません。期間は 45 日以下にする必要があります。	整数 (int)
メンテナンス終了時刻を延期する	遅延メンテナンス期間の終了時刻を示すタイムスタンプ。終了時刻を指定した場合、期間を指定することはできません。	糸
deferMaintenance識別子	遅延メンテナンス期間の一意識別子。	糸
deferMaintenanceStartTime	遅延メンテナンス期間の開始時刻を示すタイムスタンプ。	糸
宛先地域	スナップショットのコピー先の AWS リージョン。制約: 有効な AWS リージョンの名前である必要があります。詳細については、「アマゾンウェブサービスのリージョンとエンドポイント」を参照してください [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] 全般リファレンス	糸
elasticIpの	クラスターのエラスティック IP (EIP) アドレス。	糸
暗号化	true の場合、クラスター内のデータは保存時に暗号化されます。	ブール (bool)
エンドポイント	プロパティエンドポイント	エンドポイント自動生成3
enhancedVpcRouting	拡張 VPC ルーティングを有効にしてクラスターを作成するかどうかを指定するオプション。拡張 VPC ルーティングを使用するクラスターを作成するには、クラスターが VPC 内にある必要があります。詳細については、Amazon Redshift クラスター管理ガイドの拡張 VPC ルーティングを参照してください。このオプションが true の場合、拡張 VPC ルーティングが有効になります。既定値: false	ブール (bool)
hsmClientCertificate識別子	Amazon Redshift クラスターが HSM に格納されているデータ暗号化キーを取得するために使用する HSM クライアント証明書の名前を指定します。	糸
hsmConfiguration識別子	Amazon Redshift クラスターが HSM のキーの取得と格納に使用できる情報を含む HSM 構成の名前を指定します。	糸
iamロール	クラスターが他の AWS サービスにアクセスするために使用できる AWS ID およびアクセス管理 (IAM) ロールの一覧。 IAM ロールは、Amazon リソース名 (ARN) 形式で指定する必要があります。 1 つの要求で最大 50 個の IAM ロールを指定できます	文字列[]
kmsKeyId (英語)	クラスター内のデータの暗号化に使用する暗号化キーの AWS Key Management Service (KMS) キー ID。	糸
ロギングプロパティ	プロパティ loggingProperties	ロギングプロパティ
メンテナンストラック名	クラスターに割り当てるメンテナンストラックの名前。この名前の変更は非同期です。新しいトラック名は、次のメンテナンス期間までクラスターの PendingModifiedValues に保持されます。メンテナンストラックが変更されると、クラスターはメンテナンストラックで使用可能な最新のクラスターリリースに切り替わります。この時点で、メンテナンストラック名が適用されます。	糸
manageMasterPasswordの	Redshift クラスターの管理者ユーザー資格情報が Redshift によって管理されているかどうかを示すブール値。 ManageMasterPassword が true の場合、MasterUserPassword を使用することはできません。 ManageMasterPassword が false または設定されていない場合、Amazon Redshift は管理者ユーザーアカウントのパスワードに MasterUserPassword を使用します。	ブール (bool)
manualSnapshotRetentionPeriod (英語)	コピー元の AWS リージョンからコピーされた後、コピー先の AWS リージョンに新しくコピーされたスナップショットを保持する日数。値が -1 の場合、手動スナップショットは無期限に保持されます。値は、-1 または 1 ~ 3,653 の整数である必要があります。	整数 (int)
masterPasswordSecretArn さん	クラスターの管理者ユーザー資格情報シークレットの Amazon リソース名 (ARN)。	糸
masterPasswordSecretKmsKeyId	クラスターの管理者ユーザー資格情報シークレットの暗号化と格納に使用されるキー管理サービス (KMS) キーの ID。	糸
masterユーザー名	作成されるクラスターのマスターユーザーアカウントに関連付けられているユーザー名。ユーザー名を PUBLIC にすることはできません。最初の文字は文字にする必要があります。	糸
masterUserPassword さん	作成されるクラスターのマスターユーザーアカウントに関連付けられているパスワード。 ManageMasterPassword が true の場合、MasterUserPassword を使用することはできません。パスワードの長さは 8 ~ 64 文字で、大文字は 1 文字以上にする必要があります。少なくとも 1 つの小文字を含む必要があります。1 つの数値を含む必要があります。印刷可能な任意の ASCII 文字を指定できます。	糸
マルチAZ	redshift クラスターが multi-az かどうかを示すブール値。このパラメーターを指定しない場合、または値を false に設定すると、redshift クラスターは単一 az になります。	ブール (bool)
名前空間リソースポリシー	Redshift クラスターにアタッチされる名前空間リソースポリシードキュメント。	任意
ノードタイプ	クラスターにプロビジョニングするノードタイプ。有効な値: ds2.xlarge \|DS2.8XLサイズ \|DC1.ラージ \|DC1.8xラージ \|dc2.ラージ \|DC2.8xラージ \|RA3.4XLサイズ \|RA3.16倍大	糸
numberOfNodes の	クラスター内のコンピューティングノードの数。このパラメーターは、ClusterType パラメーターがマルチノードとして指定されている場合に必要です。	整数 (int)
オーナーアカウント	プロパティ所有者アカウント	糸
港	クラスターが受信接続を受け入れるポート番号。クラスターには、JDBC 接続文字列と ODBC 接続文字列を介してのみアクセスできます	整数 (int)
preferredメンテナンスウィンドウ	クラスターの自動メンテナンスを実行できる週単位の時間範囲 (UTC)。	糸
パブリックアクセス可能	true の場合、クラスターはパブリックネットワークからアクセスできます。	ブール (bool)
リソースアクション	実行する Redshift 操作。 Resource Action では、pause-cluster、resume-cluster、failover-primary-compute API がサポートされます	糸
リビジョンターゲット	データベースリビジョンの識別子。 DescribeClusterDbRevisions 要求への応答からこの値を取得できます。	糸
ローテーション暗号化キー	暗号化キーをローテーションするかどうかを示すブール値。	ブール (bool)
スナップショットクラスタ識別子	ソーススナップショットが作成されたクラスターの名前。このパラメーターは、IAM ユーザーに、クラスター名に * 以外のものを指定するスナップショットリソース要素を含むポリシーがある場合に必要です。	糸
スナップショットCopyGrantName	AWS KMS で暗号化されたクラスターのスナップショットがコピー先リージョンにコピーされるときに使用するスナップショットコピー許可の名前。	糸
スナップショットCopyManual	自動スナップショットではなく、新しくコピーした手動スナップショットにスナップショット保有期間を適用するかどうかを示します。	ブール (bool)
snapshotCopyRetentionPeriod (英語)	コピー元リージョンからコピーされた後に、コピー先リージョンに自動スナップショットを保持する日数。既定値は 7 です。制約: 1 以上 35 以下にする必要があります。	整数 (int)
スナップショット識別子	新しいクラスターの作成元となるスナップショットの名前。このパラメーターでは、大文字と小文字は区別されません。	糸
タグ	クラスターパラメーターグループのタグの一覧。	タグ[]
vpcセキュリティグループID	クラスターに関連付ける仮想プライベートクラウド (VPC) セキュリティグループの一覧。	文字列[]

エンドポイント自動生成3

名前	形容	価値
住所	プロパティアドレス	糸
港	プロパティポート	糸

ロギングプロパティ

名前	形容	価値
バケット名	プロパティbucketName	糸
s3Keyプレフィックス	プロパティ s3KeyPrefix	糸

RedshiftClusterProperties (英語)

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

RedshiftClusterPropertiesAwsタグ

名前	形容	価値

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

追跡リソースタグ

名前	形容	価値

使用例

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

redshiftClusters リソースの種類は、次をターゲットとする操作と共にデプロイできます。

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AwsConnector/redshiftClusters@2024-12-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      arn = "string"
      awsAccountId = "string"
      awsProperties = {
        allowVersionUpgrade = bool
        aquaConfigurationStatus = "string"
        automatedSnapshotRetentionPeriod = int
        availabilityZone = "string"
        availabilityZoneRelocation = bool
        availabilityZoneRelocationStatus = "string"
        classic = bool
        clusterIdentifier = "string"
        clusterNamespaceArn = "string"
        clusterParameterGroupName = "string"
        clusterSecurityGroups = [
          "string"
        ]
        clusterSubnetGroupName = "string"
        clusterType = "string"
        clusterVersion = "string"
        dbName = "string"
        deferMaintenance = bool
        deferMaintenanceDuration = int
        deferMaintenanceEndTime = "string"
        deferMaintenanceIdentifier = "string"
        deferMaintenanceStartTime = "string"
        destinationRegion = "string"
        elasticIp = "string"
        encrypted = bool
        endpoint = {
          address = "string"
          port = "string"
        }
        enhancedVpcRouting = bool
        hsmClientCertificateIdentifier = "string"
        hsmConfigurationIdentifier = "string"
        iamRoles = [
          "string"
        ]
        kmsKeyId = "string"
        loggingProperties = {
          bucketName = "string"
          s3KeyPrefix = "string"
        }
        maintenanceTrackName = "string"
        manageMasterPassword = bool
        manualSnapshotRetentionPeriod = int
        masterPasswordSecretArn = "string"
        masterPasswordSecretKmsKeyId = "string"
        masterUsername = "string"
        masterUserPassword = "string"
        multiAZ = bool
        namespaceResourcePolicy = ?
        nodeType = "string"
        numberOfNodes = int
        ownerAccount = "string"
        port = int
        preferredMaintenanceWindow = "string"
        publiclyAccessible = bool
        resourceAction = "string"
        revisionTarget = "string"
        rotateEncryptionKey = bool
        snapshotClusterIdentifier = "string"
        snapshotCopyGrantName = "string"
        snapshotCopyManual = bool
        snapshotCopyRetentionPeriod = int
        snapshotIdentifier = "string"
        tags = [
          {
            key = "string"
            value = "string"
          }
        ]
        vpcSecurityGroupIds = [
          "string"
        ]
      }
      awsRegion = "string"
      awsSourceSchema = "string"
      awsTags = {
        {customized property} = "string"
      }
      publicCloudConnectorsResourceId = "string"
      publicCloudResourceName = "string"
    }
  }
}

プロパティ値

Microsoft.AwsConnector/redshiftClusters

名前	形容	価値
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：パターン = `^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])` (必須)
プロパティ	このリソースのリソース固有のプロパティ。	RedshiftClusterProperties (英語)
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.AwsConnector/redshiftClusters@2024-12-01" (マイクロソフト.AwsConnector/-12-01)

AwsRedshiftクラスタープロパティ

名前	形容	価値
allowVersionUpgrade (英語)	メジャーバージョンのアップグレードは、メンテナンス期間中に、クラスターで実行されている Amazon Redshift エンジンに適用できます。既定値は True です	ブール (bool)
aquaConfigurationStatus(アクアコンフィギュレーションステータス)	この値は、クラスターの復元後に AQUA (高度なクエリアクセラレータ) を使用するようにクラスターを構成する方法を表します。使用できる値は次のとおりです。現在のリージョンで使用可能な場合は AQUA を使用し、Amazon Redshift ノードタイプで使用できます。disabled - AQUA.auto を使用しない - Amazon Redshift は AQUA を使用するかどうかを決定します。	糸
自動スナップショット保持期間	自動スナップショットが保持される日数。値が 0 の場合、自動スナップショットは無効になります。既定値は 1 です	整数 (int)
アベイラビリティゾーン	Amazon Redshift でクラスターをプロビジョニングする EC2 可用性ゾーン (AZ)。既定値: エンドポイントによって指定されたリージョン内の、システムが選択したランダムな可用性ゾーン	糸
availabilityZone再配置	クラスターの変更が完了した後で、Availability Zones 間の Amazon Redshift クラスターの再配置を有効にするオプション。	ブール (bool)
availabilityZoneRelocationStatus (可用性ゾーン再配置ステータス)	クラスターの可用性ゾーンの再配置状態	糸
クラシック	サイズ変更操作でクラシックサイズ変更プロセスが使用されているかどうかを示すブール値。このパラメーターを指定しない場合、または値を false に設定すると、サイズ変更の種類はエラスティックになります。	ブール (bool)
クラスタ識別子	クラスターの一意識別子。この識別子は、削除や変更などの後続のクラスター操作でクラスターを参照するために使用します。すべてのアルファベット文字は小文字にする必要があります。末尾にハイペンはなく、2 つの連続するハイフンは使用できません。クラスター名は、AWS アカウント内のすべてのクラスターで一意である必要があります	糸
clusterNamespaceArn	クラスター名前空間の Amazon リソース名 (ARN)。	糸
clusterParameterGroupName (クラスターパラメータグループ名)	このクラスターに関連付けるパラメーターグループの名前。	糸
clusterSecurityGroups (クラスタセキュリティグループ)	このクラスターに関連付けるセキュリティグループの一覧。	文字列[]
クラスタサブネットグループ名	このクラスターに関連付けるクラスターサブネットグループの名前。	糸
クラスタタイプ	クラスターの種類。クラスターの種類が単一ノードとして指定されている場合、NumberOfNodes パラメーターは必要なく、複数ノードの場合は NumberOfNodes パラメーターが必要です。	糸
クラスタバージョン	クラスターにデプロイする Amazon Redshift エンジンソフトウェアのバージョン。選択したバージョンは、クラスター内のすべてのノードで実行されます。	糸
データベース名	クラスターの作成時に作成される最初のデータベースの名前。クラスターの作成後に追加のデータベースを作成するには、SQL クライアントを使用してクラスターに接続し、SQL コマンドを使用してデータベースを作成します。	糸
延期メンテナンス	遅延メンテナンス期間を有効にするかどうかを示すブール値。	ブール (bool)
デファーメンテナンス期間	メンテナンス期間の期間を日数で示す整数。期間を指定した場合、終了時刻を指定することはできません。期間は 45 日以下にする必要があります。	整数 (int)
メンテナンス終了時刻を延期する	遅延メンテナンス期間の終了時刻を示すタイムスタンプ。終了時刻を指定した場合、期間を指定することはできません。	糸
deferMaintenance識別子	遅延メンテナンス期間の一意識別子。	糸
deferMaintenanceStartTime	遅延メンテナンス期間の開始時刻を示すタイムスタンプ。	糸
宛先地域	スナップショットのコピー先の AWS リージョン。制約: 有効な AWS リージョンの名前である必要があります。詳細については、「アマゾンウェブサービスのリージョンとエンドポイント」を参照してください [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] 全般リファレンス	糸
elasticIpの	クラスターのエラスティック IP (EIP) アドレス。	糸
暗号化	true の場合、クラスター内のデータは保存時に暗号化されます。	ブール (bool)
エンドポイント	プロパティエンドポイント	エンドポイント自動生成3
enhancedVpcRouting	拡張 VPC ルーティングを有効にしてクラスターを作成するかどうかを指定するオプション。拡張 VPC ルーティングを使用するクラスターを作成するには、クラスターが VPC 内にある必要があります。詳細については、Amazon Redshift クラスター管理ガイドの拡張 VPC ルーティングを参照してください。このオプションが true の場合、拡張 VPC ルーティングが有効になります。既定値: false	ブール (bool)
hsmClientCertificate識別子	Amazon Redshift クラスターが HSM に格納されているデータ暗号化キーを取得するために使用する HSM クライアント証明書の名前を指定します。	糸
hsmConfiguration識別子	Amazon Redshift クラスターが HSM のキーの取得と格納に使用できる情報を含む HSM 構成の名前を指定します。	糸
iamロール	クラスターが他の AWS サービスにアクセスするために使用できる AWS ID およびアクセス管理 (IAM) ロールの一覧。 IAM ロールは、Amazon リソース名 (ARN) 形式で指定する必要があります。 1 つの要求で最大 50 個の IAM ロールを指定できます	文字列[]
kmsKeyId (英語)	クラスター内のデータの暗号化に使用する暗号化キーの AWS Key Management Service (KMS) キー ID。	糸
ロギングプロパティ	プロパティ loggingProperties	ロギングプロパティ
メンテナンストラック名	クラスターに割り当てるメンテナンストラックの名前。この名前の変更は非同期です。新しいトラック名は、次のメンテナンス期間までクラスターの PendingModifiedValues に保持されます。メンテナンストラックが変更されると、クラスターはメンテナンストラックで使用可能な最新のクラスターリリースに切り替わります。この時点で、メンテナンストラック名が適用されます。	糸
manageMasterPasswordの	Redshift クラスターの管理者ユーザー資格情報が Redshift によって管理されているかどうかを示すブール値。 ManageMasterPassword が true の場合、MasterUserPassword を使用することはできません。 ManageMasterPassword が false または設定されていない場合、Amazon Redshift は管理者ユーザーアカウントのパスワードに MasterUserPassword を使用します。	ブール (bool)
manualSnapshotRetentionPeriod (英語)	コピー元の AWS リージョンからコピーされた後、コピー先の AWS リージョンに新しくコピーされたスナップショットを保持する日数。値が -1 の場合、手動スナップショットは無期限に保持されます。値は、-1 または 1 ~ 3,653 の整数である必要があります。	整数 (int)
masterPasswordSecretArn さん	クラスターの管理者ユーザー資格情報シークレットの Amazon リソース名 (ARN)。	糸
masterPasswordSecretKmsKeyId	クラスターの管理者ユーザー資格情報シークレットの暗号化と格納に使用されるキー管理サービス (KMS) キーの ID。	糸
masterユーザー名	作成されるクラスターのマスターユーザーアカウントに関連付けられているユーザー名。ユーザー名を PUBLIC にすることはできません。最初の文字は文字にする必要があります。	糸
masterUserPassword さん	作成されるクラスターのマスターユーザーアカウントに関連付けられているパスワード。 ManageMasterPassword が true の場合、MasterUserPassword を使用することはできません。パスワードの長さは 8 ~ 64 文字で、大文字は 1 文字以上にする必要があります。少なくとも 1 つの小文字を含む必要があります。1 つの数値を含む必要があります。印刷可能な任意の ASCII 文字を指定できます。	糸
マルチAZ	redshift クラスターが multi-az かどうかを示すブール値。このパラメーターを指定しない場合、または値を false に設定すると、redshift クラスターは単一 az になります。	ブール (bool)
名前空間リソースポリシー	Redshift クラスターにアタッチされる名前空間リソースポリシードキュメント。	任意
ノードタイプ	クラスターにプロビジョニングするノードタイプ。有効な値: ds2.xlarge \|DS2.8XLサイズ \|DC1.ラージ \|DC1.8xラージ \|dc2.ラージ \|DC2.8xラージ \|RA3.4XLサイズ \|RA3.16倍大	糸
numberOfNodes の	クラスター内のコンピューティングノードの数。このパラメーターは、ClusterType パラメーターがマルチノードとして指定されている場合に必要です。	整数 (int)
オーナーアカウント	プロパティ所有者アカウント	糸
港	クラスターが受信接続を受け入れるポート番号。クラスターには、JDBC 接続文字列と ODBC 接続文字列を介してのみアクセスできます	整数 (int)
preferredメンテナンスウィンドウ	クラスターの自動メンテナンスを実行できる週単位の時間範囲 (UTC)。	糸
パブリックアクセス可能	true の場合、クラスターはパブリックネットワークからアクセスできます。	ブール (bool)
リソースアクション	実行する Redshift 操作。 Resource Action では、pause-cluster、resume-cluster、failover-primary-compute API がサポートされます	糸
リビジョンターゲット	データベースリビジョンの識別子。 DescribeClusterDbRevisions 要求への応答からこの値を取得できます。	糸
ローテーション暗号化キー	暗号化キーをローテーションするかどうかを示すブール値。	ブール (bool)
スナップショットクラスタ識別子	ソーススナップショットが作成されたクラスターの名前。このパラメーターは、IAM ユーザーに、クラスター名に * 以外のものを指定するスナップショットリソース要素を含むポリシーがある場合に必要です。	糸
スナップショットCopyGrantName	AWS KMS で暗号化されたクラスターのスナップショットがコピー先リージョンにコピーされるときに使用するスナップショットコピー許可の名前。	糸
スナップショットCopyManual	自動スナップショットではなく、新しくコピーした手動スナップショットにスナップショット保有期間を適用するかどうかを示します。	ブール (bool)
snapshotCopyRetentionPeriod (英語)	コピー元リージョンからコピーされた後に、コピー先リージョンに自動スナップショットを保持する日数。既定値は 7 です。制約: 1 以上 35 以下にする必要があります。	整数 (int)
スナップショット識別子	新しいクラスターの作成元となるスナップショットの名前。このパラメーターでは、大文字と小文字は区別されません。	糸
タグ	クラスターパラメーターグループのタグの一覧。	タグ[]
vpcセキュリティグループID	クラスターに関連付ける仮想プライベートクラウド (VPC) セキュリティグループの一覧。	文字列[]

エンドポイント自動生成3

名前	形容	価値
住所	プロパティアドレス	糸
港	プロパティポート	糸

ロギングプロパティ

名前	形容	価値
バケット名	プロパティbucketName	糸
s3Keyプレフィックス	プロパティ s3KeyPrefix	糸

RedshiftClusterProperties (英語)

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

RedshiftClusterPropertiesAwsタグ

名前	形容	価値

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

追跡リソースタグ

名前	形容	価値

次の方法で共有

Microsoft.AwsConnector redshiftClusters

Bicep リソース定義

リソースの形式

プロパティ値

Microsoft.AwsConnector/redshiftClusters

AwsRedshiftクラスタープロパティ

エンドポイント自動生成3

ロギングプロパティ

RedshiftClusterProperties (英語)

RedshiftClusterPropertiesAwsタグ

タグ

追跡リソースタグ

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

リソースの形式

プロパティ値

Microsoft.AwsConnector/redshiftClusters

AwsRedshiftクラスタープロパティ

エンドポイント自動生成3

ロギングプロパティ

RedshiftClusterProperties (英語)

RedshiftClusterPropertiesAwsタグ

タグ

追跡リソースタグ

使用例

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

リソースの形式

プロパティ値

Microsoft.AwsConnector/redshiftClusters

AwsRedshiftクラスタープロパティ

エンドポイント自動生成3

ロギングプロパティ

RedshiftClusterProperties (英語)

RedshiftClusterPropertiesAwsタグ

タグ

追跡リソースタグ

フィードバック

その他のリソース

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