Resource Orchestration Service:ALIYUN::ECS::ImagePipeline

構文

{
  "Type": "ALIYUN::ECS::ImagePipeline",
  "Properties": {
    "BaseImageType": String,
    "Description": String,
    "ResourceGroupId": String,
    "SystemDiskSize": Integer,
    "VSwitchId": String,
    "AddAccount": List,
    "Name": String,
    "ExecutePipeline": Boolean,
    "DeleteInstanceOnFailure": Boolean,
    "ImageName": String,
    "ToRegionId": List,
    "InternetMaxBandwidthOut": Integer,
    "InstanceType": String,
    "Tags": List,
    "BuildContent": String,
    "BaseImage": String
  }
}

プロパティ

タグの構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

タグのプロパティ

戻り値

Fn::GetAtt

ImagePipelineId: イメージテンプレートの ID。

例

• YAML 形式

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters:
    AddAccount:
      AssociationProperty: List[Parameter]
      AssociationPropertyMetadata:
        Parameter:
          Description:
            ja: Ali アカウントの ID。
          Required: false
          Type: String
      Description:
        ja: イメージテンプレートに基づいて作成されるイメージを共有する Alibaba Cloud アカウントの ID。最大 20 個のアカウント ID を指定できます。
      MaxLength: 20
      Required: false
      Type: Json
    BaseImage:
      Description:
        ja: 'ソースイメージ。
  
          BaseImageType を IMAGE に設定する場合は、BaseImage パラメーターをカスタムイメージの ID に設定します。
  
          BaseImageType を IMAGE_FAMILY に設定する場合は、BaseImage パラメーターをイメージファミリの名前に設定します。'
      Required: true
      Type: String
    BaseImageType:
      AllowedValues:
      - IMAGE
      - IMAGE_FAMILY
      Description:
        ja: 'ソースイメージのタイプ。有効な値：
  
          IMAGE：イメージ
  
          IMAGE_FAMILY：イメージファミリ'
      Required: true
      Type: String
    BuildContent:
      Description:
        ja: イメージテンプレートの内容。コンテンツのサイズは 16 KB を超えることはできず、最大 127 個のコマンドを含めることができます。サポートされているコマンドの詳細については、このトピックの「使用上の注意」セクションをご参照ください。
      Required: false
      Type: String
    DeleteInstanceOnFailure:
      Description:
        ja: 'イメージを作成できない場合に中間インスタンスを解放するかどうかを指定します。有効な値：
  
          true
  
          false
  
          デフォルト値：true。
  
          注：中間インスタンスを起動できない場合、インスタンスはデフォルトで解放されます。'
      Required: false
      Type: Boolean
    Description:
      AssociationProperty: TextArea
      Description:
        ja: イメージテンプレートの説明。説明は 2 ～ 256 文字でなければなりません。http:// または https:// で始めることはできません。
      Required: false
      Type: String
    ExecutePipeline:
      Default: true
      Description:
        ja: パイプラインを実行するかどうか。デフォルト値は true です。
      Required: false
      Type: Boolean
    ImageName:
      Description:
        ja: 'イメージ名のプレフィックス。プレフィックスは 2 ～ 64 文字でなければなりません。文字で始まり、http:// または https:// で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ピリオド（.）、ハイフン（-）を含めることができます。
  
          システムは、指定されたプレフィックスとビルドタスクの ID ( ExecutionId ) で構成される最終的な完全なイメージ名を {ImageName}_{ExecutionId} の形式で生成します。'
      Required: false
      Type: String
    InstanceType:
      Description:
        ja: 'インスタンスタイプ。 DescribeInstanceTypes を呼び出して、インスタンスタイプをクエリできます。
  
          このパラメーターを構成しない場合、最小の vCPU とメモリリソースを提供するインスタンスタイプが自動的に選択されます。この構成は、インスタンスタイプのリソースの可用性によって異なります。たとえば、ecs.g6.large インスタンスタイプが自動的に選択されます。使用可能な ecs.g6.large リソースが不足している場合は、ecs.g6.xlarge インスタンスタイプが選択されます。'
      Required: false
      Type: String
    InternetMaxBandwidthOut:
      Description:
        ja: '中間インスタンスのパブリックアウトバウンドトラフィックのサイズ。単位：Mbit/s。有効な値：0 ～ 100。
  
          デフォルト値：0。'
      Required: false
      Type: Number
    Name:
      Description:
        ja: 'イメージテンプレートの名前。名前は 2 ～ 128 文字でなければなりません。文字で始まり、http:// または https:// で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ピリオド（.）、ハイフン（-）を含めることができます。
  
          注：Name パラメーターを指定しない場合、ImagePipelineId の戻り値が使用されます。'
      Required: false
      Type: String
    ResourceGroupId:
      AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
      Description:
        ja: リソースグループの ID。
      Required: false
      Type: String
    SystemDiskSize:
      Description:
        ja: '中間インスタンスのシステムディスクサイズ。単位：GiB。有効な値：20 ～ 500。
  
          デフォルト値：40。'
      Required: false
      Type: Number
    Tags:
      AssociationProperty: List[Parameters]
      AssociationPropertyMetadata:
        ListMetadata:
          Order:
          - Key
          - Value
        Parameters:
          Key:
            Description:
              ja: 'キャパシティ予約に追加するタグ N のキー。N の有効な値：1 ～ 20。タグキーは空の文字列を指定できません。タグキーは最大 128 文字で、http:// または https:// を含めることはできません。acs: または aliyun で始めることはできません。'
            Required: false
            Type: String
          Value:
            Description:
              ja: 'キャパシティ予約に追加するタグ N の値。N の有効な値：1 ～ 20。タグ値は空の文字列を指定できます。タグ値は最大 128 文字で、acs: で始めることはできません。タグ値には http:// または https:// を含めることはできません。'
            Required: false
            Type: String
      MaxLength: 20
      Required: false
      Type: Json
    ToRegionId:
      AssociationProperty: List[Parameter]
      AssociationPropertyMetadata:
        Parameter:
          Description:
            ja: リージョン ID。
          Required: false
          Type: String
      Description:
        ja: 'イメージテンプレートに基づいて作成されたイメージを配布するリージョンの ID。最大 20 個のリージョン ID を指定できます。
  
          このパラメーターを指定しない場合、イメージは現在のリージョンにのみ作成されます。'
      MaxLength: 20
      Required: false
      Type: Json
    VSwitchId:
      AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
      AssociationPropertyMetadata:
        VpcId: ${VpcId}
        ZoneId: ${ZoneId}
      Description:
        ja: 'vSwitch の ID。
  
          このパラメーターを指定しない場合、新しい VPC と vSwitch が作成されます。アカウントの VPC クォータが十分であることを確認してください。詳細については、「制限とクォータ」をご参照ください。'
      Required: false
      Type: String
  Resources:
    ImagePipeline:
      Properties:
        AddAccount:
          Ref: AddAccount
        BaseImage:
          Ref: BaseImage
        BaseImageType:
          Ref: BaseImageType
        BuildContent:
          Ref: BuildContent
        DeleteInstanceOnFailure:
          Ref: DeleteInstanceOnFailure
        Description:
          Ref: Description
        ExecutePipeline:
          Ref: ExecutePipeline
        ImageName:
          Ref: ImageName
        InstanceType:
          Ref: InstanceType
        InternetMaxBandwidthOut:
          Ref: InternetMaxBandwidthOut
        Name:
          Ref: Name
        ResourceGroupId:
          Ref: ResourceGroupId
        SystemDiskSize:
          Ref: SystemDiskSize
        Tags:
          Ref: Tags
        ToRegionId:
          Ref: ToRegionId
        VSwitchId:
          Ref: VSwitchId
      Type: ALIYUN::ECS::ImagePipeline
  Outputs:
    ImagePipelineId:
      Description: イメージテンプレートの ID。
      Value:
        Fn::GetAtt:
        - ImagePipeline
        - ImagePipelineId
                          

• JSON 形式

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
      "BaseImageType": {
        "Type": "String",
        "Description": {
          "ja": "ソースイメージのタイプ。有効な値：\nIMAGE：イメージ\nIMAGE_FAMILY：イメージファミリ"
        },
        "AllowedValues": [
          "IMAGE",
          "IMAGE_FAMILY"
        ],
        "Required": true
      },
      "Description": {
        "AssociationProperty": "TextArea",
        "Type": "String",
        "Description": {
          "ja": "イメージテンプレートの説明。説明は 2 ～ 256 文字でなければなりません。http:// または https:// で始めることはできません。"
        },
        "Required": false
      },
      "ResourceGroupId": {
        "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
        "Type": "String",
        "Description": {
          "ja": "リソースグループの ID。"
        },
        "Required": false
      },
      "SystemDiskSize": {
        "Type": "Number",
        "Description": {
          "ja": "中間インスタンスのシステムディスクサイズ。単位：GiB。有効な値：20 ～ 500。\nデフォルト値：40。"
        },
        "Required": false
      },
      "VSwitchId": {
        "AssociationPropertyMetadata": {
          "VpcId": "${VpcId}",
          "ZoneId": "${ZoneId}"
        },
        "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
        "Type": "String",
        "Description": {
          "ja": "vSwitch の ID。\nこのパラメーターを指定しない場合、新しい VPC と vSwitch が作成されます。アカウントの VPC クォータが十分であることを確認してください。詳細については、「制限とクォータ」をご参照ください。"
        },
        "Required": false
      },
      "AddAccount": {
        "AssociationPropertyMetadata": {
          "Parameter": {
            "Type": "String",
            "Description": {
              "ja": "Ali アカウントの ID。"
            },
            "Required": false
          }
        },
        "AssociationProperty": "List[Parameter]",
        "Type": "Json",
        "Description": {
          "ja": "イメージテンプレートに基づいて作成されるイメージを共有する Alibaba Cloud アカウントの ID。最大 20 個のアカウント ID を指定できます。"
        },
        "Required": false,
        "MaxLength": 20
      },
      "Name": {
        "Type": "String",
        "Description": {
          "ja": "イメージテンプレートの名前。名前は 2 ～ 128 文字でなければなりません。文字で始まり、http:// または https:// で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ピリオド（.）、ハイフン（-）を含めることができます。\n注：Name パラメーターを指定しない場合、ImagePipelineId の戻り値が使用されます。"
        },
        "Required": false
      },
      "ExecutePipeline": {
        "Type": "Boolean",
        "Description": {
          "ja": "パイプラインを実行するかどうか。デフォルト値は true です。"
        },
        "Required": false,
        "Default": true
      },
      "DeleteInstanceOnFailure": {
        "Type": "Boolean",
        "Description": {
          "ja": "イメージを作成できない場合に中間インスタンスを解放するかどうかを指定します。有効な値：\ntrue\nfalse\nデフォルト値：true。\n注：中間インスタンスを起動できない場合、インスタンスはデフォルトで解放されます。"
        },
        "Required": false
      },
      "ImageName": {
        "Type": "String",
        "Description": {
          "ja": "イメージ名のプレフィックス。プレフィックスは 2 ～ 64 文字でなければなりません。文字で始まり、http:// または https:// で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ピリオド（.）、ハイフン（-）を含めることができます。\nシステムは、指定されたプレフィックスとビルドタスクの ID ( ExecutionId ) で構成される最終的な完全なイメージ名を {ImageName}_{ExecutionId} の形式で生成します。"
        },
        "Required": false
      },
      "ToRegionId": {
        "AssociationPropertyMetadata": {
          "Parameter": {
            "Type": "String",
            "Description": {
              "ja": "リージョン ID。"
            },
            "Required": false
          }
        },
        "AssociationProperty": "List[Parameter]",
        "Type": "Json",
        "Description": {
          "ja": "イメージテンプレートに基づいて作成されたイメージを配布するリージョンの ID。最大 20 個のリージョン ID を指定できます。\nこのパラメーターを指定しない場合、イメージは現在のリージョンにのみ作成されます。"
        },
        "Required": false,
        "MaxLength": 20
      },
      "InternetMaxBandwidthOut": {
        "Type": "Number",
        "Description": {
          "ja": "中間インスタンスのパブリックアウトバウンドトラフィックのサイズ。単位：Mbit/s。有効な値：0 ～ 100。\nデフォルト値：0。"
        },
        "Required": false
      },
      "InstanceType": {
        "Type": "String",
        "Description": {
          "ja": "インスタンスタイプ。 DescribeInstanceTypes を呼び出して、インスタンスタイプをクエリできます。\nこのパラメーターを構成しない場合、最小の vCPU とメモリリソースを提供するインスタンスタイプが自動的に選択されます。この構成は、インスタンスタイプのリソースの可用性によって異なります。たとえば、ecs.g6.large インスタンスタイプが自動的に選択されます。使用可能な ecs.g6.large リソースが不足している場合は、ecs.g6.xlarge インスタンスタイプが選択されます。"
        },
        "Required": false
      },
      "Tags": {
        "AssociationPropertyMetadata": {
          "Parameters": {
            "Value": {
              "Type": "String",
              "Description": {
                "ja": "キャパシティ予約に追加するタグ N の値。N の有効な値：1 ～ 20。タグ値は空の文字列を指定できます。タグ値は最大 128 文字で、acs: で始めることはできません。タグ値には http:// または https:// を含めることはできません。"
              },
              "Required": false
            },
            "Key": {
              "Type": "String",
              "Description": {
                "ja": "キャパシティ予約に追加するタグ N のキー。N の有効な値：1 ～ 20。タグキーは空の文字列を指定できません。タグキーは最大 128 文字で、http:// または https:// を含めることはできません。acs: または aliyun で始めることはできません。"
              },
              "Required": false
            }
          },
          "ListMetadata": {
            "Order": [
              "Key",
              "Value"
            ]
          }
        },
        "AssociationProperty": "List[Parameters]",
        "Type": "Json",
        "Required": false,
        "MaxLength": 20
      },
      "BuildContent": {
        "Type": "String",
        "Description": {
          "ja": "イメージテンプレートの内容。コンテンツのサイズは 16 KB を超えることはできず、最大 127 個のコマンドを含めることができます。サポートされているコマンドの詳細については、このトピックの「使用上の注意」セクションをご参照ください。"
        },
        "Required": false
      },
      "BaseImage": {
        "Type": "String",
        "Description": {
          "ja": "ソースイメージ。\nBaseImageType を IMAGE に設定する場合は、BaseImage パラメーターをカスタムイメージの ID に設定します。\nBaseImageType を IMAGE_FAMILY に設定する場合は、BaseImage パラメーターをイメージファミリの名前に設定します。"
        },
        "Required": true
      }
    },
    "Resources": {
      "ImagePipeline": {
        "Type": "ALIYUN::ECS::ImagePipeline",
        "Properties": {
          "BaseImageType": {
            "Ref": "BaseImageType"
          },
          "Description": {
            "Ref": "Description"
          },
          "ResourceGroupId": {
            "Ref": "ResourceGroupId"
          },
          "SystemDiskSize": {
            "Ref": "SystemDiskSize"
          },
          "VSwitchId": {
            "Ref": "VSwitchId"
          },
          "AddAccount": {
            "Ref": "AddAccount"
          },
          "Name": {
            "Ref": "Name"
          },
          "ExecutePipeline": {
            "Ref": "ExecutePipeline"
          },
          "DeleteInstanceOnFailure": {
            "Ref": "DeleteInstanceOnFailure"
          },
          "ImageName": {
            "Ref": "ImageName"
          },
          "ToRegionId": {
            "Ref": "ToRegionId"
          },
          "InternetMaxBandwidthOut": {
            "Ref": "InternetMaxBandwidthOut"
          },
          "InstanceType": {
            "Ref": "InstanceType"
          },
          "Tags": {
            "Ref": "Tags"
          },
          "BuildContent": {
            "Ref": "BuildContent"
          },
          "BaseImage": {
            "Ref": "BaseImage"
          }
        }
      }
    },
    "Outputs": {
      "ImagePipelineId": {
        "Description": "イメージテンプレートの ID。",
        "Value": {
          "Fn::GetAtt": [
            "ImagePipeline",
            "ImagePipelineId"
          ]
        }
      }
    }
  }