ACS-VPC-ScheduleToUpgradeEipBandwidth

Template name

ACS-VPC-ScheduleToUpgradeEipBandwidth Schedules a temporary bandwidth upgrade for an EIP

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 timer trigger configuration.	Json	Yes
AllocationId	The IDs of the EIPs to upgrade.	List	Yes
Bandwidth	The target peak bandwidth. Unit: Mbps.	Number	Yes
RegionId	The region ID.	String	No	{{ ACS::RegionId }}
Duration	The duration of the temporary bandwidth upgrade.	String	No	PT1H
RateControl	The concurrency settings for task execution.	Json	No	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}
OOSAssumeRole	The RAM role assumed by OOS.	String	No	""

Output parameters

None

Required permission policy

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

Details

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

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Temporarily upgrades the bandwidth of an EIP on a schedule.
  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 target peak bandwidth for the EIP. The EIP is billed on a pay-by-bandwidth basis. Valid values: 1 to 500. Unit: Mbps.
    Type: Number
    MinValue: 1
    MaxValue: 500
  Duration:
    Label:
      en: Duration
    Description:
      en: The minimum duration is 1 second.
    Type: String
    AssociationProperty: ALIYUN::OOS::Component::DurationExpression
    Default: 'PT1H'
  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: timerTrigger
    Action: ACS::TimerTrigger
    Description:
      en: Triggers the execution at a scheduled time.
    Properties:
      Type:
        Fn::Select:
          - type
          - '{{timerTrigger}}'
      Expression:
        Fn::Select:
          - expression
          - '{{timerTrigger}}'
      StartDate:
        Fn::Select:
          - startDate
          - '{{ timerTrigger }}'
      EndDate:
        Fn::Select:
          - endDate
          - '{{ timerTrigger }}'
      TimeZone:
        Fn::Select:
          - timeZone
          - '{{ timerTrigger }}'
    Outputs: {}
  - Name: GetEipInstance
    Description:
      en: Retrieves the EIP instance.
    Action: ACS::ExecuteAPI
    Properties:
      Service: VPC
      API: DescribeEipAddresses
      Parameters:
        RegionId: '{{ RegionId }}'
        AllocationId:
          Fn::Join:
            - ','
            - '{{ AllocationId }}'
      Headers: {}
      Body: {}
    Outputs: {}
  - Name: UpgradeEipAddressBandwidth
    Action: ACS::VPC::UpgradeEipBandwidth
    Description:
      en: Upgrades the bandwidth of the EIP instance.
    Properties:
      RegionId: '{{ RegionId }}'
      AllocationId: '{{ ACS::TaskLoopItem }}'
      Bandwidth: '{{ Bandwidth }}'
      Duration: '{{ Duration }}'
    Outputs: {}
    Loop:
      Items: '{{ GetEipInstance.EipAddresses.EipAddress[]?.AllocationId }}'
      RateControl: '{{ RateControl }}'
      Outputs: {}
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - TimerTrigger
        Label:
          default:
            en: Timer Trigger Configure
      - Parameters:
          - RegionId
          - AllocationId
          - Bandwidth
          - Duration
        Label:
          default:
            en: Select Instance
      - Parameters:
          - RateControl
          - OOSAssumeRole
        Label:
          default:
            en: Control Options