Product logo
DocsBlogPricing

Definitions for @turbot/aws-cloudfront

cfOriginAccessIdentityId

Schema
{
  "type": "string",
  "pattern": "^[0-9A-Z]{1,32}$",
  "tests": [
    {
      "input": "E74FTE3AJFJ256A"
    },
    {
      "description": "invalid - special characters passed",
      "input": "!@#$%^&*()_",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/cfOriginAccessIdentityId",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

cloudFront

Schema
{
  "allOf": [
    {
      "$ref": "turbot#/definitions/service"
    },
    {
      "type": "object",
      "properties": {
        "name": {
          "const": "cloudFront"
        },
        "turbot": {
          "type": "object",
          "properties": {
            "akas": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/cloudFrontAka"
              }
            },
            "title": {
              "const": "cloudFront"
            },
            "custom": {
              "type": "object",
              "properties": {
                "aws": {
                  "$ref": "aws#/definitions/awsMetadata"
                }
              }
            }
          }
        }
      },
      "additionalProperties": true,
      "tests": [
        {
          "description": "All data are valid",
          "input": {
            "name": "cloudFront",
            "turbot": {
              "akas": [
                "arn:aws:cloudfront::123456789012"
              ],
              "title": "cloudFront",
              "custom": {
                "aws": {
                  "accountId": 123456789012
                }
              }
            }
          }
        }
      ]
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/cloudFront",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

cloudFrontAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:cloudfront::[0-9]{12}$",
  "tests": [
    {
      "description": "base",
      "input": "arn:aws:cloudfront::123123123123"
    },
    {
      "description": "invalid service name",
      "input": "arn:aws:cloudSearch::123123123123",
      "expected": false
    },
    {
      "description": "invalid account id",
      "input": "arn:aws:cloudfront::1234567890128364859934",
      "expected": false
    },
    {
      "description": "invalid provider id",
      "input": "arn:gcp:cloudfront::1234567890128364859934",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/cloudFrontAka",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

cloudFrontOriginAccessIdentity

Schema
{
  "type": "object",
  "properties": {
    "Id": {
      "$ref": "#/definitions/cfOriginAccessIdentityId"
    },
    "S3CanonicalUserId": {
      "type": "string"
    },
    "CloudFrontOriginAccessIdentityConfig": {
      "type": "object"
    },
    "CallerReference": {
      "type": "string"
    },
    "Comment": {
      "type": "string"
    },
    "ETag": {
      "type": "string"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/cloudFrontOriginAccessIdentityArn"
          }
        },
        "title": {
          "$ref": "#/definitions/cfOriginAccessIdentityId"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "Id": "E74FTE3AJFJ256A",
        "S3CanonicalUserId": "a106b3e06c1d341db0a1bd7d20a61e4c3888ecabf51934c0b256933a058afc65485992d22de985e21c70d72519a77e73",
        "turbot": {
          "akas": [
            "arn:aws:cloudfront::123456789012:origin-access-identity/E74FTE3AJFJ256A"
          ],
          "title": "E74FTE3AJFJ256A",
          "custom": {
            "aws": {
              "accountId": 123456789012
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/cloudFrontOriginAccessIdentity",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

cloudFrontOriginAccessIdentityArn

Schema
{
  "type": "string",
  "pattern": "arn:aws(-us-gov|-cn)?:cloudfront::[0-9]{12}:origin-access-identity/[0-9A-Z]{1,32}$",
  "tests": [
    {
      "input": "arn:aws:cloudfront::123456789012:origin-access-identity/E74FTE3AJFJ256A"
    },
    {
      "description": "invalid - invalid service name",
      "input": "arm:aws:cloudfrontfgf::123456789012:origin-access-identity/E3GD0DZENMMPPC",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/cloudFrontOriginAccessIdentityArn",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

distribution

Schema
{
  "type": "object",
  "properties": {
    "Id": {
      "$ref": "#/definitions/distributionId"
    },
    "ARN": {
      "$ref": "#/definitions/distributionArn"
    },
    "Status": {
      "$ref": "#/definitions/distributionStatus"
    },
    "LastModifiedTime": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "InProgressInvalidationBatches": {
      "type": "integer"
    },
    "DistributionConfig": {
      "type": "object"
    },
    "Comment": {
      "type": "string"
    },
    "DomainName": {
      "type": "string"
    },
    "Restrictions": {
      "type": "object"
    },
    "ETag": {
      "type": "string"
    },
    "CacheBehaviors": {
      "type": "object"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/distributionArn"
          }
        },
        "title": {
          "$ref": "#/definitions/distributionId"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "Id": "E3GD0DZENMMPPC",
        "Status": "Deployed",
        "LastModifiedTime": "2019-12-09T08:47:38.099Z",
        "InProgressInvalidationBatches": 0,
        "DomainName": "d3iqgy9siz1n9v.cloudfront.net",
        "DistributionConfig": {
          "CallerReference": "1575881257288",
          "Aliases": {
            "Quantity": 0,
            "Items": []
          },
          "DefaultRootObject": "",
          "Origins": {
            "Quantity": 1
          }
        },
        "ARN": "arn:aws:cloudfront::560741234067:distribution/E3GD0DZENMMPPC",
        "turbot": {
          "akas": [
            "arn:aws:cloudfront::560741234067:distribution/E3GD0DZENMMPPC"
          ],
          "title": "E3GD0DZENMMPPC",
          "custom": {
            "aws": {
              "accountId": 123456789012
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/distribution",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

distributionArn

Schema
{
  "type": "string",
  "pattern": "arn:aws(-us-gov|-cn)?:cloudfront::[0-9]{12}:distribution/E[0-9A-Z]{13}$",
  "tests": [
    {
      "input": "arn:aws:cloudfront::123456789012:distribution/E3GD0DZENMMPPC"
    },
    {
      "description": "invalid - invalid service name",
      "input": "arm:aws:cloudfrontfgf::123456789012:distribution/E3GD0DZENMMPPC",
      "expected": false
    },
    {
      "description": "invalid - AWS account id is wrong",
      "input": "arn:aws:cloudfront::123456789021312:distribution/E3GD0DZENMMPPC",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/distributionArn",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

distributionId

Schema
{
  "type": "string",
  "pattern": "^E[0-9A-Z]{13}$",
  "tests": [
    {
      "input": "E3GD0DZENMMPPC"
    },
    {
      "description": "max length exceeded",
      "input": "E3GD0DZENMMPPCE3GD0DZENMMPPCE3GD0DZENMMPPCE3GD0DZENMMPPC",
      "expected": false
    },
    {
      "description": "must not have special character",
      "input": "E3@D0DZENMMPPC",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/distributionId",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

distributionStatus

Schema
{
  "type": "string",
  "enum": [
    "Deployed",
    "InProgress"
  ],
  "tests": [
    {
      "input": "Deployed"
    },
    {
      "input": "InProgress"
    },
    {
      "description": "invalid - not listed in options",
      "input": "reactive",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/distributionStatus",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

streamingDistribution

Schema
{
  "type": "object",
  "properties": {
    "Id": {
      "$ref": "#/definitions/streamingDistributionId"
    },
    "ARN": {
      "$ref": "#/definitions/streamingDistributionArn"
    },
    "Status": {
      "$ref": "#/definitions/streamingDistributionStatus"
    },
    "LastModifiedTime": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "DomainName": {
      "type": "string"
    },
    "ActiveTrustedSigners": {
      "type": "object"
    },
    "StreamingDistributionConfig": {
      "type": "object"
    },
    "ETag": {
      "type": "string"
    },
    "Tags": {
      "$ref": "aws#/definitions/tagList"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/streamingDistributionArn"
          }
        },
        "title": {
          "$ref": "#/definitions/streamingDistributionId"
        },
        "tags": {
          "$ref": "aws#/definitions/tagsMap"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "Id": "EGTXBD79EXAMPLE",
        "ARN": "arn:aws:cloudfront::560741234067:streaming-distribution/EGTXBD79EXAMPLE",
        "Status": "Deployed",
        "DomainName": "s5c39gqb8ow64r.cloudfront.net",
        "ETag": "E2QWRUHAPOMQZL",
        "Tags": [
          {
            "Key": "jack",
            "Value": "jill"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:cloudfront::560741234067:streaming-distribution/EGTXBD79EXAMPLE"
          ],
          "title": "EGTXBD79EXAMPLE",
          "tags": {
            "jack": "jill"
          },
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "partition": "aws"
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/streamingDistribution",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

streamingDistributionArn

Schema
{
  "type": "string",
  "pattern": "arn:aws(-us-gov|-cn)?:cloudfront::[0-9]{12}:streaming-distribution/E[0-9A-Z]{1,15}$",
  "tests": [
    {
      "input": "arn:aws:cloudfront::123456789012:streaming-distribution/E3GD0DZENMMPPC"
    },
    {
      "description": "invalid - invalid service name",
      "input": "arm:aws:cloudfrontfgf::123456789012:streaming-distribution/E3GD0DZENMMPPC",
      "expected": false
    },
    {
      "description": "invalid - AWS account id is wrong",
      "input": "arn:aws:cloudfront::123456789021312:streaming-distribution/E3GD0DZENMMPPC",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/streamingDistributionArn",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

streamingDistributionId

Schema
{
  "type": "string",
  "pattern": "^E[0-9A-Z]{1,15}$",
  "tests": [
    {
      "input": "E3GD0DZENMMPPC"
    },
    {
      "description": "max length exceeded",
      "input": "E3GD0DZENMMPPCE3GD0DZENMMPPCE3GD0DZENMMPPCE3GD0DZENMMPPC",
      "expected": false
    },
    {
      "description": "must not have special character",
      "input": "E3@D0DZENMMPPC",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/streamingDistributionId",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}

streamingDistributionStatus

Schema
{
  "type": "string",
  "enum": [
    "Deployed",
    "InProgress"
  ],
  "tests": [
    {
      "input": "Deployed"
    },
    {
      "input": "InProgress"
    },
    {
      "description": "invalid - not listed in options",
      "input": "reactive",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-cloudfront#/definitions/streamingDistributionStatus",
    "modUri": "tmod:@turbot/aws-cloudfront"
  }
}