Product logo
DocsBlogPricing

Definitions for @turbot/aws-route53resolver

resolverEndpoint

{
  "type": "object",
  "properties": {
    "Tags": {
      "$ref": "aws#/definitions/tagList"
    },
    "Id": {
      "$ref": "#/definitions/resolverEndpointId"
    },
    "CreatorRequestId": {
      "type": "string"
    },
    "Arn": {
      "$ref": "#/definitions/resolverEndpointArn"
    },
    "SecurityGroupIds": {
      "type": "array"
    },
    "Direction": {
      "$ref": "#/definitions/resolverEndpointDirection"
    },
    "HostVPCId": {
      "type": "string"
    },
    "IpAddressCount": {
      "type": "integer"
    },
    "Status": {
      "$ref": "#/definitions/resolverEndpointStatus"
    },
    "StatusMessage": {
      "type": "string"
    },
    "Name": {
      "$ref": "#/definitions/resolverEndpointName"
    },
    "CreationTime": {
      "type": "string"
    },
    "ModificationTime": {
      "type": "string"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/resolverEndpointArn"
          }
        },
        "tags": {
          "$ref": "aws#/definitions/tagsMap"
        },
        "title": {
          "$ref": "#/definitions/resolverEndpointName"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "Tags": [
          {
            "Key": "key01",
            "Value": "value01"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:route53resolver:us-east-1:624358524054:resolver-endpoint/rslvr-rr-90dae0bf5fd3423b8"
          ],
          "tags": {
            "key01": "value01"
          },
          "title": "foo",
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1"
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverEndpoint",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverEndpointArn

{
  "type": "string",
  "pattern": "arn:aws(-us-gov|-cn)?:route53resolver:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:resolver-endpoint/[-a-z0-9-]{1,64}$",
  "tests": [
    {
      "input": "arn:aws:route53resolver:us-east-1:624358524054:resolver-endpoint/rslvr-rr-90dae0bf5fd3423b8"
    },
    {
      "description": "invalid - input not expected",
      "input": "arn:aws:test",
      "expected": false
    },
    {
      "description": "invalid - incorrect aka format provided",
      "input": "arn:aws:test:us-east-1::rslvr-in-bcbf23edf6c404aa0",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverEndpointArn",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverEndpointDirection

{
  "type": "string",
  "enum": [
    "INBOUND",
    "OUTBOUND"
  ],
  "tests": [
    {
      "input": "INBOUND"
    },
    {
      "input": "OUTBOUND"
    },
    {
      "description": "invalid - not listed in options",
      "input": "FORWARD",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverEndpointDirection",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverEndpointId

{
  "type": "string",
  "pattern": "^[-a-z0-9-]{1,64}$",
  "tests": [
    {
      "input": "rslvr-in-bcbf23edf6c404aa0"
    },
    {
      "description": "invalid - empty string",
      "input": "",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverEndpointId",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverEndpointName

{
  "type": "string",
  "pattern": "^(?!^[0-9]+$)([a-zA-Z0-9-_' ']+){1,64}$",
  "tests": [
    {
      "input": "test-this-mod"
    },
    {
      "input": "this_uses_underscore1234"
    },
    {
      "description": "null value",
      "input": null,
      "expected": false
    },
    {
      "description": "empty string",
      "input": "",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverEndpointName",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverEndpointStatus

{
  "type": "string",
  "enum": [
    "CREATING",
    "OPERATIONAL",
    "UPDATING",
    "AUTO_RECOVERING",
    "ACTION_NEEDED",
    "DELETING"
  ],
  "tests": [
    {
      "input": "CREATING"
    },
    {
      "input": "UPDATING"
    },
    {
      "description": "invalid - not listed in options",
      "input": "TESTING",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverEndpointStatus",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRule

{
  "type": "object",
  "properties": {
    "Tags": {
      "$ref": "aws#/definitions/tagList"
    },
    "Id": {
      "$ref": "#/definitions/resolverRuleId"
    },
    "CreatorRequestId": {
      "type": "string"
    },
    "Arn": {
      "$ref": "#/definitions/resolverRuleArn"
    },
    "DomainName": {
      "type": "string"
    },
    "Status": {
      "$ref": "#/definitions/resolverRuleStatus"
    },
    "StatusMessage": {
      "type": "string"
    },
    "RuleType": {
      "$ref": "#/definitions/resolverRuleType"
    },
    "Name": {
      "type": "string"
    },
    "TargetIps": {
      "type": "array"
    },
    "ResolverEndpointId": {
      "type": "string"
    },
    "OwnerId": {
      "type": "string"
    },
    "ShareStatus": {
      "type": "string"
    },
    "ResolverRuleAssociations": {
      "type": "array"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/resolverRuleArn"
          }
        },
        "tags": {
          "$ref": "aws#/definitions/tagsMap"
        },
        "title": {
          "$ref": "#/definitions/resolverRuleName"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "Tags": [
          {
            "Key": "key01",
            "Value": "value01"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:route53resolver:us-east-1:624358524054:resolver-rule/rslvr-rr-90dae0bf5fd3423b8"
          ],
          "tags": {
            "key01": "value01"
          },
          "title": "foo",
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1"
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRule",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRuleArn

{
  "type": "string",
  "pattern": "arn:aws(-us-gov|-cn)?:route53resolver:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:resolver-rule/(rslvr-[a-z0-9-]{2,64})",
  "tests": [
    {
      "input": "arn:aws:route53resolver:us-east-1:624358524054:resolver-rule/rslvr-rr-90dae0bf5fd3423b8"
    },
    {
      "description": "invalid - input not expected",
      "input": "arn:aws:test",
      "expected": false
    },
    {
      "description": "invalid - AWS account id is wrong",
      "input": "arn:aws:test:us-east-1::autodefined-rule/rslvr-autodefined-rr-internet-resolver",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRuleArn",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRuleId

{
  "type": "string",
  "pattern": "^(rslvr-[a-z0-9-]{2,64})$",
  "tests": [
    {
      "input": "rslvr-rr-90dae0bf5fd3423b8"
    },
    {
      "description": "invalid - incorrect id format used",
      "input": "test-1244",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRuleId",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRuleName

{
  "type": "string",
  "pattern": "^[a-zA-Z0-9\\s_-]{1,64}$",
  "tests": [
    {
      "input": "foo"
    },
    {
      "input": "avesfss"
    },
    {
      "description": "null value",
      "input": null,
      "expected": false
    },
    {
      "description": "empty string",
      "input": "",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRuleName",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRuleShareStatus

{
  "type": "string",
  "enum": [
    "NOT_SHARED",
    "SHARED_WITH_ME",
    "SHARED_BY_ME"
  ],
  "tests": [
    {
      "input": "NOT_SHARED"
    },
    {
      "input": "SHARED_WITH_ME"
    },
    {
      "description": "invalid - not listed in options",
      "input": "SHARED",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRuleShareStatus",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRuleStatus

{
  "type": "string",
  "enum": [
    "COMPLETE",
    "DELETING",
    "UPDATING",
    "FAILED"
  ],
  "tests": [
    {
      "input": "COMPLETE"
    },
    {
      "input": "DELETING"
    },
    {
      "description": "invalid - not listed in options",
      "input": "CREATING",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRuleStatus",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

resolverRuleType

{
  "type": "string",
  "enum": [
    "FORWARD",
    "SYSTEM",
    "RECURSIVE"
  ],
  "tests": [
    {
      "input": "FORWARD"
    },
    {
      "input": "RECURSIVE"
    },
    {
      "description": "invalid - not listed in options",
      "input": "RULED OUT",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/resolverRuleType",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

route53Resolver

{
  "allOf": [
    {
      "$ref": "turbot#/definitions/service"
    },
    {
      "type": "object",
      "properties": {
        "name": {
          "const": "Route53 Resolver"
        },
        "turbot": {
          "type": "object",
          "properties": {
            "akas": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/route53ResolverAka"
              }
            },
            "title": {
              "const": "Route53 Resolver"
            },
            "custom": {
              "type": "object",
              "properties": {
                "aws": {
                  "$ref": "aws#/definitions/awsMetadata"
                }
              }
            }
          }
        }
      },
      "additionalProperties": true,
      "tests": [
        {
          "description": "All valid properties",
          "input": {
            "name": "Route53 Resolver",
            "turbot": {
              "akas": [
                "arn:aws:route53resolver:us-east-1:123456789012"
              ],
              "title": "Route53 Resolver",
              "custom": {
                "aws": {
                  "accountId": 123456789012
                }
              }
            }
          }
        },
        {
          "description": "invalid - name missing",
          "input": {
            "turbot": {
              "akas": [
                "arn:aws:route53resolver:us-east-1:123456789012"
              ],
              "title": "Route53 Resolver",
              "custom": {
                "aws": {
                  "accountId": 123456789012,
                  "regionName": "us-east-1"
                }
              }
            }
          },
          "expected": false
        }
      ]
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/route53Resolver",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}

route53ResolverAka

{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:route53resolver:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}$",
  "tests": [
    {
      "description": "base",
      "input": "arn:aws:route53resolver:us-east-1:123123123123"
    },
    {
      "description": "invalid aka",
      "input": "arn:aws:route53resolver007:us-east-1:123123123123",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-route53resolver#/definitions/route53ResolverAka",
    "modUri": "tmod:@turbot/aws-route53resolver"
  }
}