proserve-cloudformation-stackinstances.json

{
    "typeName": "ProServe::Cloudformation::StackInstances",
    "description": "Concurrent cloudformation stack instance management within stacksets",
    "sourceUrl": "https://gitlab.aws.dev/manu-lz/aws-cloudformation-stack-instances",
    "definitions": {
        "OperationPreferences": {
            "description": "The user-specified preferences for how AWS CloudFormation performs a stack set operation.",
            "type": "object",
            "properties": {
                "FailureToleranceCount": {
                    "type": "integer",
                    "minimum": 0
                },
                "FailureTolerancePercentage": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 100
                },
                "MaxConcurrentCount": {
                    "type": "integer",
                    "minimum": 1
                },
                "MaxConcurrentPercentage": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 100
                },
                "RegionOrder": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Region"
                    }
                },
                "RegionConcurrencyType": {
                    "$ref": "#/definitions/RegionConcurrencyType"
                }
            },
            "additionalProperties": false
        },
        "Parameter": {
            "type": "object",
            "properties": {
                "ParameterKey": {
                    "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.",
                    "type": "string"
                },
                "ParameterValue": {
                    "description": "The input value associated with the parameter.",
                    "type": "string"
                }
            },
            "required": [
                "ParameterKey",
                "ParameterValue"
            ],
            "additionalProperties": false
        },
        "Capability": {
            "type": "string",
            "enum": [
                "CAPABILITY_IAM",
                "CAPABILITY_NAMED_IAM",
                "CAPABILITY_AUTO_EXPAND"
            ]
        },
        "RegionConcurrencyType": {
            "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time",
            "type": "string",
            "enum": [
                "SEQUENTIAL",
                "PARALLEL"
            ]
        },
        "Account": {
            "pattern": "^[0-9]{12}$",
            "type": "string"
        },
        "Region": {
            "pattern": "^[a-zA-Z0-9-]{1,128}$",
            "type": "string"
        },
        "DeploymentTargets": {
            "description": " The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.",
            "type": "object",
            "properties": {
                "Accounts": {
                    "description": "AWS accounts that you want to create stack instances in the specified Region(s) for.",
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "insertionOrder": false,
                    "items": {
                        "$ref": "#/definitions/Account"
                    }
                }
            },
            "additionalProperties": false
        },
        "StackInstances": {
            "description": "Stack instances in some specific accounts and Regions.",
            "type": "object",
            "properties": {
                "DeploymentTargets": {
                    "$ref": "#/definitions/DeploymentTargets"
                },
                "Regions": {
                    "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s).",
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "insertionOrder": false,
                    "items": {
                        "$ref": "#/definitions/Region"
                    }
                },
                "ParameterOverrides": {
                    "description": "A list of stack set parameters whose values you want to override in the selected stack instances.",
                    "type": "array",
                    "uniqueItems": true,
                    "insertionOrder": false,
                    "items": {
                        "$ref": "#/definitions/Parameter"
                    }
                }
            },
            "required": [
                "DeploymentTargets",
                "Regions"
            ],
            "additionalProperties": false
        }
    },
    "properties": {
        "InstanceId": {
            "description": "Id is automatically generated on creation and assigned as the unique identifier.",
            "type": "string"
        },
        "StackSetName": {
            "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set.",
            "type": "string",
            "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,127}$",
            "maxLength": 128
        },
        "Capabilities": {
            "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.",
            "type": "array",
            "uniqueItems": true,
            "insertionOrder": false,
            "items": {
                "$ref": "#/definitions/Capability"
            }
        },
        "StackInstances": {
            "$ref": "#/definitions/StackInstances"
        },
        "OperationPreferences": {
            "$ref": "#/definitions/OperationPreferences"
        },
        "Parameters": {
            "description": "The input parameters for the stack set template.",
            "type": "array",
            "uniqueItems": true,
            "insertionOrder": false,
            "items": {
                "$ref": "#/definitions/Parameter"
            }
        }
    },
    "additionalProperties": false,
    "required": [
        "StackSetName",
        "StackInstances"
    ],
    "readOnlyProperties": [
        "/properties/InstanceId"
    ],
    "primaryIdentifier": [
        "/properties/InstanceId"
    ],
    "handlers": {
        "create": {
            "timeoutInMinutes" : 720,
            "permissions": [
                "cloudformation:CreateStackInstances",
                "cloudformation:Get*",
                "cloudformation:List*",
                "cloudformation:Describe*"
            ]
        },
        "read": {
            "permissions": [
                "cloudformation:DescribeStackInstances",
                "cloudformation:Get*",
                "cloudformation:List*",
                "cloudformation:Describe*"
            ]
        },
        "update": {
            "timeoutInMinutes" : 720,
            "permissions": [
                "cloudformation:UpdateStackInstances",
                "cloudformation:Get*",
                "cloudformation:List*",
                "cloudformation:Describe*"
            ]
        },
        "delete": {
            "timeoutInMinutes" : 720,
            "permissions": [
                "cloudformation:DeleteStackInstances",
                "cloudformation:Get*",
                "cloudformation:List*",
                "cloudformation:Describe*"
            ]
        },
        "list": {
            "permissions": [
                "cloudformation:ListStackInstances",
                "cloudformation:Get*",
                "cloudformation:List*",
                "cloudformation:Describe*"
            ]
        }
    }
}