ACS-VPC-ScheduleToUpgradeEipBandwidth - CloudOps Orchestration Service

Template name

ACS-VPC-ScheduleToUpgradeEipBandwidth

Execute Now

Template description

Temporarily upgrades the bandwidth of an elastic IP address (EIP) as scheduled.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Type	Required	Default value	Limit
TimerTrigger	The type of the timer trigger.	Json	Yes
AllocationId	The EIP.	List	Yes
Bandwidth	The bandwidth after the upgrade.	Number	Yes
RegionId	The region ID.	String	No	{{ ACS::RegionId }}
DurationHour	The duration for which the additional bandwidth is used.	Number	No	1
RateControl	The rate control settings.	Json	No	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}
OOSAssumeRole	The Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS).	String	No	""

Output parameters

None

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "vpc:DescribeEipAddresses",
                "vpc:ModifyEipAddressAttribute"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

For more information, see ACS-VPC-ScheduleToUpgradeEipBandwidth at GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Schedule to upgrade EIP bandwidth
  name-en: ACS-VPC-ScheduleToUpgradeEipBandwidth
  categories:
    - time_trigger
Parameters:
  TimerTrigger:
    Type: Json
    Label:
      en: TimerTrigger
    AssociationProperty: ALIYUN::OOS::Component::TimerTrigger
    AssociationPropertyMetadata:
      MinuteInterval: 30
  RegionId:
    Type: String
    Label:
      en: The id of region
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  AllocationId:
    Type: List
    Label:
      en: TargetEIPInstance
  Bandwidth:
    Label:
      en: Bandwidth
    Description:
      en: The peak bandwidth of EIP needs to be modified. The value is:1~500. It is billed based on fixed bandwidth, in Mbps. 
    Type: Number
    MinValue: 1
    MaxValue: 500
  DurationHour:
    Label:
      en: DurationHour
    Description:
      en: Unit:Hour. The bandwidth upgrade should last at least 1 hours
    Type: Number
    MinValue: 1
    MaxValue: 24
    Default: 1
  RateControl:
    Label:
      en: RateControl
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: The RAM role to be assumed by OOS
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: GetEipInstance
  Description:
    en: Get the EIP instance
  Action: ACS::ExecuteAPI
  Properties:
    Service: VPC
    API: DescribeEipAddresses
    Parameters:
      RegionId: '{{ RegionId }}'
      AllocationId:
        Fn::Join:
          - ','
          - '{{ AllocationId }}'
  Outputs:
    AllocationIds:
      Type: List
      ValueSelector: .EipAddresses.EipAddress[].AllocationId
- Name: UpgradeEipAddressBandwidth
  Action: ACS::VPC::UpgradeEipBandwidth
  Description:
    en: Upgrade EIP instance bandwidth
  Properties:
    RegionId: '{{ RegionId }}'
    AllocationId: '{{ ACS::TaskLoopItem }}'
    Bandwidth: '{{ Bandwidth }}'
    DurationHour: '{{ DurationHour }}'
  Loop:
    RateControl: '{{ RateControl }}'
    Items: '{{ GetEipInstance.AllocationIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - TimerTrigger
        Label:
          default:
            en: Timer Trigger Configure
      - Parameters:
          - RegionId
          - AllocationId
          - Bandwidth
          - DurationHour
        Label:
          default:
            en: Select ECS Instances
      - Parameters:
          - RateControl
          - OOSAssumeRole
        Label:
          default:
            en: Control Options