ACS-Redis-ReleaseInstancePublicConnection

Template name

ACS-Redis-ReleaseInstancePublicConnection — Releases the public endpoint of a Redis instance.

Execute Now

Template description

Releases the public endpoint of a Tair (Redis OSS-compatible) instance.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Data type	Required	Default value	Limit
instanceId	Tair (Redis OSS-compatible) instance ID.	String	Yes
regionId	Region where the instance resides.	String	No	{{ ACS::RegionId }}
OOSAssumeRole	RAM role to assume for execution.	String	No	""

Output parameters

None.

Required permissions

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "kvstore:DescribeDBInstanceNetInfo",
                "kvstore:ReleaseInstancePublicConnection"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

ACS-Redis-ReleaseInstancePublicConnection

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Releases the public endpoint of a Redis instance.
  name-en: ACS-Redis-ReleaseInstancePublicConnection
  categories:
    - security
    - tair
Parameters:
  regionId:
    Label:
      en: Region ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceId:
    Label:
      en: The ID of the Redis instance
    Type: String
  OOSAssumeRole:
    Label:
      en: The RAM role to be assumed by OOS
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: describeDBInstanceNetInfo
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Queries the IP address type and endpoint of the Redis instance.
    Properties:
      Service: R-KVSTORE
      API: DescribeDBInstanceNetInfo
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId: '{{ instanceId }}'
    Outputs:
      connectionString:
        Type: String
        ValueSelector: >-
          .NetInfoItems.InstanceNetInfo[] | select(.IPType=="Public") |
          .ConnectionString
  - Name: checkPublicAddress
    Action: 'ACS::Choice'
    Description:
      en: Checks whether to release the public endpoint of the instance.
    Properties:
      DefaultTask: releaseInstancePublicConnection
      Choices:
        - When:
            'Fn::Equals':
              - Null
              - '{{ describeDBInstanceNetInfo.connectionString }}'
          NextTask: 'ACS::END'
  - Name: releaseInstancePublicConnection
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Releases the public endpoint of the Redis instance.
    Properties:
      Service: R-KVSTORE
      API: ReleaseInstancePublicConnection
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceId: '{{ instanceId }}'
        CurrentConnectionString: '{{ describeDBInstanceNetInfo.connectionString }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceId
        Label:
          default:
            en: Select an instance
      - Parameters:
          - OOSAssumeRole
        Label:
          default:
            en: Advanced options