Module Smaws_Client_CloudFormation.Types

type nonrec resource_type = string
type nonrec resource_types = resource_type list
type nonrec warnings = {
  1. unrecognized_resource_types : resource_types option;
    (*

    A list of all of the unrecognized resource types. This is only returned if the TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning configuration set to True.

    *)
}

Contains any warnings returned by the GetTemplateSummary API action.

type nonrec warning_type =
  1. | EXCLUDED_RESOURCES
  2. | EXCLUDED_PROPERTIES
  3. | MUTUALLY_EXCLUSIVE_TYPES
  4. | UNSUPPORTED_PROPERTIES
  5. | MUTUALLY_EXCLUSIVE_PROPERTIES
type nonrec property_path = string
type nonrec required_property = bool
type nonrec property_description = string
type nonrec warning_property = {
  1. description : property_description option;
    (*

    The description of the property from the resource provider schema.

    *)
  2. required : required_property option;
    (*

    If true, the specified property is required.

    *)
  3. property_path : property_path option;
    (*

    The path of the property. For example, if this is for the S3Bucket member of the Code property, the property path would be Code/S3Bucket.

    *)
}

A specific property that is impacted by a warning.

type nonrec warning_properties = warning_property list
type nonrec warning_detail = {
  1. properties : warning_properties option;
    (*

    The properties of the resource that are impacted by this warning.

    *)
  2. type_ : warning_type option;
    (*

    The type of this warning. For more information, see Resolve write-only properties in the CloudFormation User Guide.

    • MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.
    • UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property.
    • MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.

    Currently the resource and property reference documentation does not indicate if a property uses a type of oneOf or anyOf. You need to look at the resource provider schema.

    *)
}

The warnings generated for a specific resource for this generated template.

type nonrec warning_details = warning_detail list
type nonrec visibility =
  1. | PRIVATE
  2. | PUBLIC
type nonrec version_bump =
  1. | MINOR
  2. | MAJOR
type nonrec version = string
type nonrec value = string
type nonrec validation_status_reason = string
type nonrec validation_status =
  1. | SKIPPED
  2. | FAILED
type nonrec validation_path = string
type nonrec validation_name = string
type nonrec parameter_key = string
type nonrec parameter_value = string
type nonrec no_echo = bool
type nonrec description = string
type nonrec template_parameter = {
  1. description : description option;
    (*

    User defined description associated with the parameter.

    *)
  2. no_echo : no_echo option;
    (*

    Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

    *)
  3. default_value : parameter_value option;
    (*

    The default value associated with the parameter.

    *)
  4. parameter_key : parameter_key option;
    (*

    The name associated with the parameter.

    *)
}

The TemplateParameter data type.

type nonrec template_parameters = template_parameter list
type nonrec capability =
  1. | CAPABILITY_AUTO_EXPAND
  2. | CAPABILITY_NAMED_IAM
  3. | CAPABILITY_IAM
type nonrec capabilities = capability list
type nonrec capabilities_reason = string
type nonrec transform_name = string
type nonrec transforms_list = transform_name list
type nonrec validate_template_output = {
  1. declared_transforms : transforms_list option;
    (*

    A list of the transforms that are declared in the template.

    *)
  2. capabilities_reason : capabilities_reason option;
    (*

    The list of resources that generated the values in the Capabilities response element.

    *)
  3. capabilities : capabilities option;
    (*

    The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    *)
  4. description : description option;
    (*

    The description found within the template.

    *)
  5. parameters : template_parameters option;
    (*

    A list of TemplateParameter structures.

    *)
}

The output for ValidateTemplate action.

type nonrec template_body = string
type nonrec template_ur_l = string
type nonrec validate_template_input = {
  1. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    *)
  2. template_body : template_body option;
    (*

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    *)
}

The input for ValidateTemplate action.

type nonrec use_previous_value = bool
type nonrec use_previous_template = bool
type nonrec url = string
type nonrec stack_id = string
type nonrec update_termination_protection_output = {
  1. stack_id : stack_id option;
    (*

    The unique ID of the stack.

    *)
}
type nonrec enable_termination_protection = bool
type nonrec stack_name_or_id = string
type nonrec update_termination_protection_input = {
  1. stack_name : stack_name_or_id;
    (*

    The name or unique ID of the stack for which you want to set termination protection.

    *)
  2. enable_termination_protection : enable_termination_protection;
    (*

    Whether to enable termination protection on the specified stack.

    *)
}
type nonrec client_request_token = string
type nonrec update_stack_set_output = {
  1. operation_id : client_request_token option;
    (*

    The unique ID for this StackSet operation.

    *)
}
type nonrec stack_set_name = string
type nonrec parameter = {
  1. resolved_value : parameter_value option;
    (*

    Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see Specify existing resources at runtime with CloudFormation-supplied parameter types in the CloudFormation User Guide.

    *)
  2. use_previous_value : use_previous_value option;
    (*

    During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

    *)
  3. parameter_value : parameter_value option;
    (*

    The input value associated with the parameter.

    *)
  4. parameter_key : parameter_key option;
    (*

    The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

    *)
}

The Parameter data type.

type nonrec parameters = parameter list
type nonrec tag_key = string
type nonrec tag_value = string
type nonrec tag = {
  1. value : tag_value;
    (*

    A string that contains the value for this tag. You can specify a maximum of 256 characters for a tag value.

    *)
  2. key : tag_key;
    (*

    A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix: aws:.

    *)
}

The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

type nonrec tags = tag list
type nonrec region_concurrency_type =
  1. | PARALLEL
  2. | SEQUENTIAL
type nonrec region = string
type nonrec region_list = region list
type nonrec failure_tolerance_count = int
type nonrec failure_tolerance_percentage = int
type nonrec max_concurrent_count = int
type nonrec max_concurrent_percentage = int
type nonrec concurrency_mode =
  1. | SOFT_FAILURE_TOLERANCE
  2. | STRICT_FAILURE_TOLERANCE
type nonrec stack_set_operation_preferences = {
  1. concurrency_mode : concurrency_mode option;
    (*

    Specifies how the concurrency level behaves during the operation execution.

    • STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

      If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

    • SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows StackSet operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.
    *)
  2. max_concurrent_percentage : max_concurrent_percentage option;
    (*

    The maximum percentage of accounts in which to perform this operation at one time.

    When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    You can specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

    By default, 1 is specified.

    *)
  3. max_concurrent_count : max_concurrent_count option;
    (*

    The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    You can specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

    By default, 1 is specified.

    *)
  4. failure_tolerance_percentage : failure_tolerance_percentage option;
    (*

    The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

    When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

    You can specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

    By default, 0 is specified.

    *)
  5. failure_tolerance_count : failure_tolerance_count option;
    (*

    The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

    You can specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

    By default, 0 is specified.

    *)
  6. region_order : region_list option;
    (*

    The order of the Regions where you want to perform the stack operation.

    *)
  7. region_concurrency_type : region_concurrency_type option;
    (*

    The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

    *)
}

The user-specified preferences for how CloudFormation performs a StackSet operation.

For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.

StackSetOperationPreferences don't apply to AutoDeployment, even if it's enabled.

type nonrec role_ar_n = string
type nonrec execution_role_name = string
type nonrec account = string
type nonrec account_list = account list
type nonrec accounts_url = string
type nonrec organizational_unit_id = string
type nonrec organizational_unit_id_list = organizational_unit_id list
type nonrec account_filter_type =
  1. | UNION
  2. | DIFFERENCE
  3. | INTERSECTION
  4. | NONE
type nonrec deployment_targets = {
  1. account_filter_type : account_filter_type option;
    (*

    Refines which accounts will have stack operations performed on them by specifying how to use the Accounts and OrganizationalUnitIds properties together.

    The following values determine how CloudFormation selects target accounts:

    • INTERSECTION: Performs stack operations only on specific individual accounts within the selected OUs. Only accounts that are both specified in the Accounts property and belong to the specified OUs will be targeted.
    • DIFFERENCE: Performs stack operations on all accounts in the selected OUs except for specific accounts listed in the Accounts property. This enables you to exclude certain accounts within an OU, such as suspended accounts.
    • UNION: Performs stack operations on the specified OUs plus additional individual accounts listed in the Accounts property. This is the default value if AccountFilterType is not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note that UNION is not supported for CreateStackInstances operations.
    • NONE: Performs stack operations on all accounts in the specified organizational units (OUs).
    *)
  2. organizational_unit_ids : organizational_unit_id_list option;
    (*

    The organization root ID or organizational unit (OU) IDs where you want to perform stack operations. CloudFormation will perform operations on accounts within these OUs and their child OUs.

    *)
  3. accounts_url : accounts_url option;
    (*

    The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either .csv or .txt, and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).

    This property serves the same purpose as Accounts but allows you to specify a large number of accounts.

    *)
  4. accounts : account_list option;
    (*

    The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the AccountFilterType property.

    If you have many account numbers, you can provide those accounts using the AccountsUrl property instead.

    *)
}

Specifies the Organizations accounts where you want to create, update, or delete stack instances. You can target either your entire organization or specific accounts using organizational units (OUs) and account filter options.

CloudFormation doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.

When performing create operations, if you specify both OrganizationalUnitIds and Accounts, you must also specify the AccountFilterType property.

type nonrec permission_models =
  1. | SELF_MANAGED
  2. | SERVICE_MANAGED
type nonrec auto_deployment_nullable = bool
type nonrec retain_stacks_on_account_removal_nullable = bool
type nonrec stack_set_ar_n = string
type nonrec stack_set_arn_list = stack_set_ar_n list
type nonrec auto_deployment = {
  1. depends_on : stack_set_arn_list option;
    (*

    A list of StackSet ARNs that this StackSet depends on for auto-deployment operations. When auto-deployment is triggered, operations will be sequenced to ensure all dependencies complete successfully before this StackSet's operation begins.

    *)
  2. retain_stacks_on_account_removal : retain_stacks_on_account_removal_nullable option;
    (*

    If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

    *)
  3. enabled : auto_deployment_nullable option;
    (*

    If set to true, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

    *)
}

Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide.

type nonrec call_as =
  1. | DELEGATED_ADMIN
  2. | SELF
type nonrec managed_execution_nullable = bool
type nonrec managed_execution = {
  1. active : managed_execution_nullable option;
    (*

    When true, CloudFormation performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, CloudFormation starts queued operations in request order.

    If there are already running or queued operations, CloudFormation queues all incoming operations even if they are non-conflicting.

    You can't modify your StackSet's execution configuration while there are running or queued operations for that StackSet.

    When false (default), StackSets performs one operation at a time in request order.

    *)
}

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

type nonrec update_stack_set_input = {
  1. managed_execution : managed_execution option;
    (*

    Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.

    *)
  2. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  3. regions : region_list option;
    (*

    The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update StackSet instances.

    To update all the stack instances associated with this StackSet, do not specify the Accounts or Regions properties.

    If the StackSet update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the StackSet update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

    *)
  4. accounts : account_list option;
    (*

    [Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update StackSet instances.

    To update all the stack instances associated with this StackSet, don't specify the Accounts or Regions properties.

    If the StackSet update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the StackSet update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.

    *)
  5. operation_id : client_request_token option;
    (*

    The unique ID for this StackSet operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.

    If you don't specify an operation ID, CloudFormation generates one automatically.

    Repeating this StackSet operation with a new operation ID retries all stack instances whose status is OUTDATED.

    *)
  6. auto_deployment : auto_deployment option;
    (*

    [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide.

    If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

    *)
  7. permission_model : permission_models option;
    (*

    Describes how the IAM roles required for StackSet operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

    *)
  8. deployment_targets : deployment_targets option;
    (*

    [Service-managed permissions] The Organizations accounts in which to update associated stack instances.

    To update all the stack instances associated with this StackSet, do not specify DeploymentTargets or Regions.

    If the StackSet update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the StackSet update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

    *)
  9. execution_role_name : execution_role_name option;
    (*

    [Self-managed permissions] The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.

    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.

    If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the StackSet, so long as you have permissions to perform operations on the StackSet.

    *)
  10. administration_role_ar_n : role_ar_n option;
    (*

    [Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to update this StackSet.

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

    If you specified a customized administrator role when you created the StackSet, you must specify a customized administrator role, even if it is the same customized administrator role used with this StackSet previously.

    *)
  11. operation_preferences : stack_set_operation_preferences option;
    (*

    Preferences for how CloudFormation performs this StackSet operation.

    *)
  12. tags : tags option;
    (*

    The key-value pairs to associate with this StackSet and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this StackSet. This means:

    • If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
    • If you specify any tags using this parameter, you must specify all the tags that you want associated with this StackSet, even tags you've specified before (for example, when creating the StackSet or during a previous update of the StackSet.). Any tags that you don't include in the updated list of tags are removed from the StackSet, and therefore from the stacks and resources as well.
    • If you specify an empty value, CloudFormation removes all currently associated tags.

    If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the StackSet from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the StackSet, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the StackSet is not updated.

    *)
  13. capabilities : capabilities option;
    (*

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the StackSet and its associated stack instances.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

      • If you have IAM resources, you can specify either capability.
      • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

      For more information, see Acknowledging IAM resources in CloudFormation templates.

    • CAPABILITY_AUTO_EXPAND

      Some templates reference macros. If your StackSet template references one or more macros, you must update the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To update the StackSet directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros.

      StackSets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.

    *)
  14. parameters : parameters option;
    (*

    A list of input parameters for the StackSet template.

    *)
  15. use_previous_template : use_previous_template option;
    (*

    Use the existing template that's associated with the StackSet that you're updating.

    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

    *)
  16. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. S3 static website URLs are not supported.

    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

    *)
  17. template_body : template_body option;
    (*

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

    *)
  18. description : description option;
    (*

    A brief description of updates that you are making.

    *)
  19. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to update.

    *)
}
type nonrec error_message = string
type nonrec stale_request_exception = {
  1. message : error_message option;
}

Another operation has been performed on this StackSet since the specified operation was performed.

type nonrec stack_set_not_found_exception = {
  1. message : error_message option;
}

The specified StackSet doesn't exist.

type nonrec stack_instance_not_found_exception = {
  1. message : error_message option;
}

The specified stack instance doesn't exist.

type nonrec operation_in_progress_exception = {
  1. message : error_message option;
}

Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.

type nonrec operation_id_already_exists_exception = {
  1. message : error_message option;
}

The specified operation ID already exists.

type nonrec invalid_operation_exception = {
  1. message : error_message option;
}

The specified operation isn't valid.

type nonrec operation_id = string
type nonrec update_stack_output = {
  1. operation_id : operation_id option;
    (*

    A unique identifier for this update operation that can be used to track the operation's progress and events.

    *)
  2. stack_id : stack_id option;
    (*

    Unique identifier of the stack.

    *)
}

The output for an UpdateStack action.

type nonrec update_stack_instances_output = {
  1. operation_id : client_request_token option;
    (*

    The unique identifier for this StackSet operation.

    *)
}
type nonrec stack_set_name_or_id = string
type nonrec update_stack_instances_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token option;
    (*

    The unique identifier for this StackSet operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.

    If you don't specify an operation ID, the SDK generates one automatically.

    *)
  3. operation_preferences : stack_set_operation_preferences option;
    (*

    Preferences for how CloudFormation performs this StackSet operation.

    *)
  4. parameter_overrides : parameters option;
    (*

    A list of input parameters whose values you want to update for the specified stack instances.

    Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

    • To override the current value for a parameter, include the parameter and specify its value.
    • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
    • To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don't include the parameter in the list.
    • To leave all parameters set to their present values, don't specify this property at all.

    During StackSet updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

    You can only override the parameter values that are specified in the StackSet. To add or delete a parameter itself, use UpdateStackSet to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

    *)
  5. regions : region_list;
    (*

    The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

    *)
  6. deployment_targets : deployment_targets option;
    (*

    [Service-managed permissions] The Organizations accounts in which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

    You can specify Accounts or DeploymentTargets, but not both.

    *)
  7. accounts : account_list option;
    (*

    [Self-managed permissions] The account IDs of one or more Amazon Web Services accounts in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

    You can specify Accounts or DeploymentTargets, but not both.

    *)
  8. stack_set_name : stack_set_name_or_id;
    (*

    The name or unique ID of the StackSet associated with the stack instances.

    *)
}
type nonrec stack_name = string
type nonrec stack_policy_during_update_body = string
type nonrec stack_policy_during_update_ur_l = string
type nonrec arn = string
type nonrec type_ = string
type nonrec rollback_trigger = {
  1. type_ : type_;
    (*

    The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

    *)
  2. arn : arn;
    (*

    The Amazon Resource Name (ARN) of the rollback trigger.

    If a specified trigger is missing, the entire stack operation fails and is rolled back.

    *)
}

A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

type nonrec rollback_triggers = rollback_trigger list
type nonrec monitoring_time_in_minutes = int
type nonrec rollback_configuration = {
  1. monitoring_time_in_minutes : monitoring_time_in_minutes option;
    (*

    The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

    The default is 0 minutes.

    If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

    If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

    *)
  2. rollback_triggers : rollback_triggers option;
    (*

    The triggers to monitor during stack creation or update actions.

    By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

    • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
    • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.
    • To remove all currently specified triggers, specify an empty list for this parameter.

    If a specified trigger is missing, the entire stack operation fails and is rolled back.

    *)
}

Structure that contains the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.

type nonrec stack_policy_body = string
type nonrec stack_policy_ur_l = string
type nonrec notification_ar_n = string
type nonrec notification_ar_ns = notification_ar_n list
type nonrec disable_rollback = bool
type nonrec retain_except_on_create = bool
type nonrec deployment_config_mode =
  1. | EXPRESS
  2. | STANDARD
type nonrec deployment_config = {
  1. disable_rollback : disable_rollback option;
    (*

    Specifies whether to disable rollback of the stack if the stack operation fails.

    Default: false

    *)
  2. mode : deployment_config_mode option;
    (*

    Specifies the deployment mode for the stack operation. Possible values are:

    • STANDARD - Use the standard deployment behavior, ensuring resources are ready to serve traffic before completing the operation. This is the default. You do not need to specify this value explicitly.
    • EXPRESS - Complete the stack operation when resource configuration is applied, without waiting for resources to become ready to serve traffic. Resources continue becoming ready in the background.
    *)
}

The deployment configuration for a stack operation, including the deployment mode.

type nonrec disable_validation = bool
type nonrec update_stack_input = {
  1. disable_validation : disable_validation option;
    (*

    Set to true to disable pre-deployment validations in changeset or stack operations.

    Default: false

    *)
  2. deployment_config : deployment_config option;
    (*

    The deployment configuration for this stack operation, including the deployment mode.

    *)
  3. retain_except_on_create : retain_except_on_create option;
    (*

    When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

    Default: false

    *)
  4. client_request_token : client_request_token option;
    (*

    A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that CloudFormation successfully received them.

    All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

    In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

    *)
  5. disable_rollback : disable_rollback option;
    (*

    Preserve the state of previously provisioned resources when an operation fails.

    Default: False

    *)
  6. tags : tags option;
    (*

    Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

    If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

    *)
  7. notification_ar_ns : notification_ar_ns option;
    (*

    Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

    *)
  8. stack_policy_ur_l : stack_policy_ur_l option;
    (*

    Location of a file that contains the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

    *)
  9. stack_policy_body : stack_policy_body option;
    (*

    Structure that contains a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.

    *)
  10. rollback_configuration : rollback_configuration option;
    (*

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

    *)
  11. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

    If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

    *)
  12. resource_types : resource_types option;
    (*

    Specifies which resource types you can work with, such as AWS::EC2::Instance or Custom::MyCustomInstance.

    If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control CloudFormation access with Identity and Access Management.

    Only one of the Capabilities and ResourceType parameters can be specified.

    *)
  13. capabilities : capabilities option;
    (*

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

      • If you have IAM resources, you can specify either capability.
      • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

      If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

      For more information, see Acknowledging IAM resources in CloudFormation templates.

    • CAPABILITY_AUTO_EXPAND

      Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

      If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

      You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

      Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

      For more information, see Perform custom processing on CloudFormation templates with template macros.

    Only one of the Capabilities and ResourceType parameters can be specified.

    *)
  14. parameters : parameters option;
    (*

    A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

    *)
  15. stack_policy_during_update_ur_l : stack_policy_during_update_ur_l option;
    (*

    Location of a file that contains the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

    If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.

    *)
  16. stack_policy_during_update_body : stack_policy_during_update_body option;
    (*

    Structure that contains the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

    If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.

    *)
  17. use_previous_template : use_previous_template option;
    (*

    Reuse the existing template that is associated with the stack that you are updating.

    When using templates with the AWS::LanguageExtensions transform, provide the template instead of using UsePreviousTemplate to ensure new parameter values and Systems Manager parameter updates are applied correctly. For more information, see AWS::LanguageExtensions transform.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    *)
  18. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    *)
  19. template_body : template_body option;
    (*

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    *)
  20. stack_name : stack_name;
    (*

    The name or unique stack ID of the stack to update.

    *)
}

The input for an UpdateStack action.

type nonrec token_already_exists_exception = {
  1. message : error_message option;
}

A client request token already exists.

type nonrec insufficient_capabilities_exception = {
  1. message : error_message option;
}

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

type nonrec generated_template_id = string
type nonrec update_generated_template_output = {
  1. generated_template_id : generated_template_id option;
    (*

    The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,

    arn:aws:cloudformation:{i us-east-1}:{i 123456789012}:generatedtemplate/{i 2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc}

    .

    *)
}
type nonrec generated_template_name = string
type nonrec logical_resource_id = string
type nonrec resource_identifier_property_value = string
type nonrec resource_identifier_property_key = string
type nonrec resource_identifier_properties = (resource_identifier_property_key * resource_identifier_property_value) list
type nonrec resource_definition = {
  1. resource_identifier : resource_identifier_properties;
    (*

    A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

    *)
  2. logical_resource_id : logical_resource_id option;
    (*

    The logical resource id for this resource in the generated template.

    *)
  3. resource_type : resource_type;
    (*

    The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection in the CloudFormation User Guide

    *)
}

A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.

type nonrec resource_definitions = resource_definition list
type nonrec jazz_logical_resource_ids = logical_resource_id list
type nonrec refresh_all_resources = bool
type nonrec generated_template_deletion_policy =
  1. | RETAIN
  2. | DELETE
type nonrec generated_template_update_replace_policy =
  1. | RETAIN
  2. | DELETE
type nonrec template_configuration = {
  1. update_replace_policy : generated_template_update_replace_policy option;
    (*

    The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

    • DELETE - delete all resources when the resource is replaced during an update operation.
    • RETAIN - retain all resources when the resource is replaced during an update operation.

    For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

    *)
  2. deletion_policy : generated_template_deletion_policy option;
    (*

    The DeletionPolicy assigned to resources in the generated template. Supported values are:

    • DELETE - delete all resources when the stack is deleted.
    • RETAIN - retain all resources when the stack is deleted.

    For more information, see DeletionPolicy attribute in the CloudFormation User Guide.

    *)
}

The configuration details of a generated template.

type nonrec update_generated_template_input = {
  1. template_configuration : template_configuration option;
    (*

    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

    *)
  2. refresh_all_resources : refresh_all_resources option;
    (*

    If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.

    *)
  3. remove_resources : jazz_logical_resource_ids option;
    (*

    A list of logical ids for resources to remove from the generated template.

    *)
  4. add_resources : resource_definitions option;
    (*

    An optional list of resources to be added to the generated template.

    *)
  5. new_generated_template_name : generated_template_name option;
    (*

    An optional new name to assign to the generated template.

    *)
  6. generated_template_name : generated_template_name;
    (*

    The name or Amazon Resource Name (ARN) of a generated template.

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : error_message option;
}

The quota for the resource has already been reached.

For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.

type nonrec generated_template_not_found_exception = {
  1. message : error_message option;
}

The generated template was not found.

type nonrec already_exists_exception = {
  1. message : error_message option;
}

The resource with the name requested already exists.

type nonrec type_arn = string
type nonrec type_configuration_alias = string
type nonrec type_configuration_arn = string
type nonrec third_party_type =
  1. | HOOK
  2. | MODULE
  3. | RESOURCE
type nonrec type_name = string
type nonrec type_configuration_identifier = {
  1. type_name : type_name option;
    (*

    The name of the extension type to which this configuration applies.

    *)
  2. type_ : third_party_type option;
    (*

    The type of extension.

    *)
  3. type_configuration_arn : type_configuration_arn option;
    (*

    The ARN for the configuration, in this account and Region.

    *)
  4. type_configuration_alias : type_configuration_alias option;
    (*

    The alias specified for this configuration, if one was specified when the configuration was set.

    *)
  5. type_arn : type_arn option;
    (*

    The ARN for the extension, in this account and Region.

    For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

    *)
}

Identifying information for the configuration of a CloudFormation extension.

type nonrec unprocessed_type_configurations = type_configuration_identifier list
type nonrec registry_type =
  1. | HOOK
  2. | MODULE
  3. | RESOURCE
type nonrec type_version_id = string
type nonrec is_default_version = bool
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec public_version_number = string
type nonrec type_version_summary = {
  1. public_version_number : public_version_number option;
    (*

    For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-party extensions, CloudFormation returns null.

    How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.

    *)
  2. description : description option;
    (*

    The description of the extension version.

    *)
  3. time_created : timestamp option;
    (*

    When the version was registered.

    *)
  4. arn : type_arn option;
    (*

    The ARN of the extension version.

    *)
  5. is_default_version : is_default_version option;
    (*

    Whether the specified extension version is set as the default version.

    This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, CloudFormation returns null.

    *)
  6. version_id : type_version_id option;
    (*

    The ID of a specific version of the extension. The version ID is the value at the end of the ARN assigned to the extension version when it's registered.

    *)
  7. type_name : type_name option;
    (*

    The name of the extension.

    *)
  8. type_ : registry_type option;
    (*

    The kind of extension.

    *)
}

Contains summary information about a specific version of a CloudFormation extension.

type nonrec type_version_summaries = type_version_summary list
type nonrec type_tests_status_description = string
type nonrec type_tests_status =
  1. | NOT_TESTED
  2. | IN_PROGRESS
  3. | FAILED
  4. | PASSED
type nonrec publisher_id = string
type nonrec identity_provider =
  1. | Bitbucket
  2. | GitHub
  3. | AWS_Marketplace
type nonrec publisher_name = string
type nonrec is_activated = bool
type nonrec type_summary = {
  1. is_activated : is_activated option;
    (*

    Whether the extension is activated for this account and Region.

    This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

    *)
  2. publisher_name : publisher_name option;
    (*

    The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

    *)
  3. publisher_identity : identity_provider option;
    (*

    The service used to verify the publisher identity.

    For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

    *)
  4. latest_public_version : public_version_number option;
    (*

    For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-party extensions, CloudFormation returns null.

    How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.

    *)
  5. public_version_number : public_version_number option;
    (*

    For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.

    How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.

    *)
  6. original_type_name : type_name option;
    (*

    For public extensions that have been activated for this account and Region, the type name of the public extension.

    If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.

    *)
  7. publisher_id : publisher_id option;
    (*

    The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.

    *)
  8. description : description option;
    (*

    The description of the extension.

    *)
  9. last_updated : timestamp option;
    (*

    When the specified extension version was registered. This applies only to:

    • Private extensions you have registered in your account. For more information, see RegisterType.
    • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

    For all other extension types, CloudFormation returns null.

    *)
  10. type_arn : type_arn option;
    (*

    The ARN of the extension.

    *)
  11. default_version_id : type_version_id option;
    (*

    The ID of the default version of the extension. The default version is used when the extension version isn't specified.

    This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

    To set the default version of an extension, use SetTypeDefaultVersion.

    *)
  12. type_name : type_name option;
    (*

    The name of the extension.

    If you specified a TypeNameAlias when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.

    *)
  13. type_ : registry_type option;
    (*

    The kind of extension.

    *)
}

Contains summary information about the specified CloudFormation extension.

type nonrec type_summaries = type_summary list
type nonrec type_schema = string
type nonrec type_not_found_exception = {
  1. message : error_message option;
    (*

    A message with details about the error that occurred.

    *)
}

The specified extension doesn't exist in the CloudFormation registry.

type nonrec type_name_prefix = string
type nonrec type_hierarchy = string
type nonrec category =
  1. | AWS_TYPES
  2. | THIRD_PARTY
  3. | ACTIVATED
  4. | REGISTERED
type nonrec type_filters = {
  1. type_name_prefix : type_name_prefix option;
    (*

    A prefix to use as a filter for results.

    *)
  2. publisher_id : publisher_id option;
    (*

    The id of the publisher of the extension.

    Extensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to specify a list of types published by Amazon.

    *)
  3. category : category option;
    (*

    The category of extensions to return.

    • REGISTERED: Private extensions that have been registered for this account and Region.
    • ACTIVATED: Public extensions that have been activated for this account and Region.

    • THIRD_PARTY: Extensions available for use from publishers other than Amazon. This includes:

      • Private extensions registered in the account.
      • Public extensions from publishers other than Amazon, whether activated or not.
    • AWS_TYPES: Extensions available for use from Amazon.
    *)
}

Filter criteria to use in determining which extensions to return.

type nonrec type_configuration_not_found_exception = {
  1. message : error_message option;
    (*

    A message with details about the error that occurred.

    *)
}

The specified extension configuration can't be found.

type nonrec type_configuration_identifiers = type_configuration_identifier list
type nonrec type_configuration = string
type nonrec is_default_configuration = bool
type nonrec type_configuration_details = {
  1. is_default_configuration : is_default_configuration option;
    (*

    Whether this configuration data is the default configuration for the extension.

    *)
  2. type_name : type_name option;
    (*

    The name of the extension.

    *)
  3. type_arn : type_arn option;
    (*

    The ARN for the extension, in this account and Region.

    For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

    *)
  4. last_updated : timestamp option;
    (*

    When the configuration data was last updated for this extension.

    If a configuration hasn't been set for a specified extension, CloudFormation returns null.

    *)
  5. configuration : type_configuration option;
    (*

    A JSON string specifying the configuration data for the extension, in this account and Region.

    If a configuration hasn't been set for a specified extension, CloudFormation returns {}.

    *)
  6. alias : type_configuration_alias option;
    (*

    The alias specified for this configuration, if one was specified when the configuration was set.

    *)
  7. arn : type_configuration_arn option;
    (*

    The ARN for the configuration data, in this account and Region.

    *)
}

Detailed information concerning the specification of a CloudFormation extension in a given account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

type nonrec type_configuration_details_list = type_configuration_details list
type nonrec treat_unrecognized_resource_types_as_warnings = bool
type nonrec total_warnings = int
type nonrec total_stack_instances_count = int
type nonrec timeout_minutes = int
type nonrec third_party_type_arn = string
type nonrec test_type_output = {
  1. type_version_arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    *)
}
type nonrec s3_bucket = string
type nonrec test_type_input = {
  1. log_delivery_bucket : s3_bucket option;
    (*

    The S3 bucket to which CloudFormation delivers the contract test execution logs.

    CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

    The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

    • GetObject
    • PutObject

    For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

    *)
  2. version_id : type_version_id option;
    (*

    The version of the extension to test.

    You can specify the version id with either Arn, or with TypeName and Type.

    If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.

    *)
  3. type_name : type_name option;
    (*

    The name of the extension to test.

    Conditional: You must specify Arn, or TypeName and Type.

    *)
  4. type_ : third_party_type option;
    (*

    The type of the extension to test.

    Conditional: You must specify Arn, or TypeName and Type.

    *)
  5. arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    *)
}
type nonrec cfn_registry_exception = {
  1. message : error_message option;
    (*

    A message with details about the error that occurred.

    *)
}

An error occurred during a CloudFormation registry operation.

type nonrec template_summary_config = {
  1. treat_unrecognized_resource_types_as_warnings : treat_unrecognized_resource_types_as_warnings option;
    (*

    If set to True, any unrecognized resource types generate warnings and not an error. Any unrecognized resource types are returned in the Warnings output parameter.

    *)
}

Options for the GetTemplateSummary API action.

type nonrec generated_template_status =
  1. | COMPLETE
  2. | FAILED
  3. | DELETE_IN_PROGRESS
  4. | UPDATE_IN_PROGRESS
  5. | CREATE_IN_PROGRESS
  6. | DELETE_PENDING
  7. | UPDATE_PENDING
  8. | CREATE_PENDING
type nonrec template_status_reason = string
type nonrec creation_time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec last_updated_time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec number_of_resources = int
type nonrec template_summary = {
  1. number_of_resources : number_of_resources option;
    (*

    The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.

    *)
  2. last_updated_time : last_updated_time option;
    (*

    The time the generated template was last updated.

    *)
  3. creation_time : creation_time option;
    (*

    The time the generated template was created.

    *)
  4. status_reason : template_status_reason option;
    (*

    The reason for the current template generation status. This will provide more details if a failure happened.

    *)
  5. status : generated_template_status option;
    (*

    The status of the template generation. Supported values are:

    • CreatePending - the creation of the template is pending.
    • CreateInProgress - the creation of the template is in progress.
    • DeletePending - the deletion of the template is pending.
    • DeleteInProgress - the deletion of the template is in progress.
    • UpdatePending - the update of the template is pending.
    • UpdateInProgress - the update of the template is in progress.
    • Failed - the template operation failed.
    • Complete - the template operation is complete.
    *)
  6. generated_template_name : generated_template_name option;
    (*

    The name of the generated template.

    *)
  7. generated_template_id : generated_template_id option;
    (*

    The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,

    arn:aws:cloudformation:{i us-east-1}:{i 123456789012}:generatedtemplate/{i 2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc}

    .

    *)
}

The summary of a generated template.

type nonrec template_summaries = template_summary list
type nonrec template_stage =
  1. | Processed
  2. | Original
type nonrec resources_succeeded = int
type nonrec resources_failed = int
type nonrec resources_processing = int
type nonrec resources_pending = int
type nonrec template_progress = {
  1. resources_pending : resources_pending option;
    (*

    The number of resources that are still pending the template generation.

    *)
  2. resources_processing : resources_processing option;
    (*

    The number of resources that are in-process for the template generation.

    *)
  3. resources_failed : resources_failed option;
    (*

    The number of resources that failed the template generation.

    *)
  4. resources_succeeded : resources_succeeded option;
    (*

    The number of resources that succeeded the template generation.

    *)
}

A summary of the progress of the template generation.

type nonrec template_format =
  1. | YAML
  2. | JSON
type nonrec template_description = string
type nonrec supported_major_version = int
type nonrec supported_major_versions = supported_major_version list
type nonrec stop_stack_set_operation_output = unit
type nonrec stop_stack_set_operation_input = {
  1. call_as : call_as option;
    (*

    Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token;
    (*

    The ID of the stack operation.

    *)
  3. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to stop the operation for.

    *)
}
type nonrec operation_not_found_exception = {
  1. message : error_message option;
}

The specified ID refers to an operation that doesn't exist.

type nonrec status_message = string
type nonrec resource_scan_id = string
type nonrec start_resource_scan_output = {
  1. resource_scan_id : resource_scan_id option;
    (*

    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is

    arn:aws:cloudformation:{i us-east-1}:{i 123456789012}:resourceScan/{i f5b490f7-7ed4-428a-aa06-31ff25db0772}

    .

    *)
}
type nonrec resource_type_filter = string
type nonrec resource_type_filters = resource_type_filter list
type nonrec scan_filter = {
  1. types : resource_type_filters option;
    (*

    An array of strings where each string represents an Amazon Web Services resource type you want to scan. Each string defines the resource type using the format AWS::ServiceName::ResourceType, for example, AWS::DynamoDB::Table. For the full list of supported resource types, see the Resource type support table in the CloudFormation User Guide.

    To scan all resource types within a service, you can use a wildcard, represented by an asterisk (*). You can place an asterisk at only the end of the string, for example, AWS::S3::*.

    *)
}

A filter that is used to specify which resource types to scan.

type nonrec scan_filters = scan_filter list
type nonrec start_resource_scan_input = {
  1. scan_filters : scan_filters option;
    (*

    The scan filters to use.

    *)
  2. client_request_token : client_request_token option;
    (*

    A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.

    *)
}
type nonrec resource_scan_limit_exceeded_exception = {
  1. message : error_message option;
}

The limit on resource scans has been exceeded. Reasons include:

  • Exceeded the daily quota for resource scans.
  • A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
  • The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.
type nonrec resource_scan_in_progress_exception = {
  1. message : error_message option;
}

A resource scan is currently in progress. Only one can be run at a time for an account in a Region.

type nonrec stage_list = template_stage list
type nonrec change_set_id = string
type nonrec deletion_time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec stack_status =
  1. | IMPORT_ROLLBACK_COMPLETE
  2. | IMPORT_ROLLBACK_FAILED
  3. | IMPORT_ROLLBACK_IN_PROGRESS
  4. | IMPORT_COMPLETE
  5. | IMPORT_IN_PROGRESS
  6. | REVIEW_IN_PROGRESS
  7. | UPDATE_ROLLBACK_COMPLETE
  8. | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
  9. | UPDATE_ROLLBACK_FAILED
  10. | UPDATE_ROLLBACK_IN_PROGRESS
  11. | UPDATE_FAILED
  12. | UPDATE_COMPLETE
  13. | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
  14. | UPDATE_IN_PROGRESS
  15. | DELETE_COMPLETE
  16. | DELETE_FAILED
  17. | DELETE_IN_PROGRESS
  18. | ROLLBACK_COMPLETE
  19. | ROLLBACK_FAILED
  20. | ROLLBACK_IN_PROGRESS
  21. | CREATE_COMPLETE
  22. | CREATE_FAILED
  23. | CREATE_IN_PROGRESS
type nonrec stack_status_reason = string
type nonrec output_key = string
type nonrec output_value = string
type nonrec export_name = string
type nonrec output = {
  1. export_name : export_name option;
    (*

    The name of the export associated with the output.

    *)
  2. description : description option;
    (*

    User defined description associated with the output.

    *)
  3. output_value : output_value option;
    (*

    The value associated with the output.

    *)
  4. output_key : output_key option;
    (*

    The key associated with the output.

    *)
}

The Output data type.

type nonrec outputs = output list
type nonrec stack_drift_status =
  1. | NOT_CHECKED
  2. | UNKNOWN
  3. | IN_SYNC
  4. | DRIFTED
type nonrec stack_drift_information = {
  1. last_check_timestamp : timestamp option;
    (*

    Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

    *)
  2. stack_drift_status : stack_drift_status;
    (*

    Status of the stack's actual configuration compared to its expected template configuration.

    • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.
    • IN_SYNC: The stack's actual configuration matches its expected template configuration.
    • UNKNOWN: CloudFormation could not run drift detection for a resource in the stack.
    *)
}

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

type nonrec deletion_mode =
  1. | FORCE_DELETE_STACK
  2. | STANDARD
type nonrec detailed_status =
  1. | VALIDATION_FAILED
  2. | CONFIGURATION_COMPLETE
type nonrec operation_type =
  1. | CREATE_CHANGESET
  2. | ROLLBACK
  3. | CONTINUE_ROLLBACK
  4. | DELETE_STACK
  5. | UPDATE_STACK
  6. | CREATE_STACK
type nonrec operation_entry = {
  1. operation_id : operation_id option;
    (*

    The unique identifier for the operation.

    *)
  2. operation_type : operation_type option;
    (*

    The type of operation.

    *)
}

Contains information about a CloudFormation operation.

type nonrec last_operations = operation_entry list
type nonrec stack = {
  1. last_operations : last_operations option;
    (*

    Information about the most recent operations performed on this stack.

    *)
  2. detailed_status : detailed_status option;
    (*

    The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The StackSets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.

    *)
  3. deletion_mode : deletion_mode option;
    (*

    Specifies the deletion mode for the stack. Possible values are:

    • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    *)
  4. retain_except_on_create : retain_except_on_create option;
    (*

    When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

    Default: false

    *)
  5. drift_information : stack_drift_information option;
    (*

    Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

    *)
  6. root_id : stack_id option;
    (*

    For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.

    For more information, see Nested stacks in the CloudFormation User Guide.

    *)
  7. parent_id : stack_id option;
    (*

    For nested stacks, the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

    For more information, see Nested stacks in the CloudFormation User Guide.

    *)
  8. enable_termination_protection : enable_termination_protection option;
    (*

    Whether termination protection is enabled for the stack.

    For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.

    *)
  9. tags : tags option;
    (*

    A list of Tags that specify information about the stack.

    *)
  10. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

    *)
  11. outputs : outputs option;
    (*

    A list of output structures.

    *)
  12. capabilities : capabilities option;
    (*

    The capabilities allowed in the stack.

    *)
  13. timeout_in_minutes : timeout_minutes option;
    (*

    The amount of time within which stack creation should complete.

    *)
  14. notification_ar_ns : notification_ar_ns option;
    (*

    Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

    *)
  15. deployment_config : deployment_config option;
    (*

    The deployment configuration for the stack, including the deployment mode used for stack operations.

    *)
  16. disable_rollback : disable_rollback option;
    (*

    Boolean to enable or disable rollback on stack creation failures:

    • true: disable rollback.
    • false: enable rollback.
    *)
  17. stack_status_reason : stack_status_reason option;
    (*

    Success/failure message associated with the stack status.

    *)
  18. stack_status : stack_status;
    (*

    Current status of the stack.

    *)
  19. rollback_configuration : rollback_configuration option;
    (*

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

    *)
  20. last_updated_time : last_updated_time option;
    (*

    The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

    *)
  21. deletion_time : deletion_time option;
    (*

    The time the stack was deleted.

    *)
  22. creation_time : creation_time;
    (*

    The time at which the stack was created.

    *)
  23. parameters : parameters option;
    (*

    A list of Parameter structures.

    *)
  24. description : description option;
    (*

    A user-defined description associated with the stack.

    *)
  25. change_set_id : change_set_id option;
    (*

    The unique ID of the change set.

    *)
  26. stack_name : stack_name;
    (*

    The name associated with the stack.

    *)
  27. stack_id : stack_id option;
    (*

    Unique identifier of the stack.

    *)
}

The Stack data type.

type nonrec stacks = stack list
type nonrec stack_drift_information_summary = {
  1. last_check_timestamp : timestamp option;
    (*

    Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

    *)
  2. stack_drift_status : stack_drift_status;
    (*

    Status of the stack's actual configuration compared to its expected template configuration.

    • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.
    • IN_SYNC: The stack's actual configuration matches its expected template configuration.
    • UNKNOWN: CloudFormation could not run drift detection for a resource in the stack.
    *)
}

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

type nonrec stack_summary = {
  1. last_operations : last_operations option;
    (*

    Information about the most recent operations performed on this stack.

    *)
  2. drift_information : stack_drift_information_summary option;
    (*

    Summarizes information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

    *)
  3. root_id : stack_id option;
    (*

    For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.

    For more information, see Nested stacks in the CloudFormation User Guide.

    *)
  4. parent_id : stack_id option;
    (*

    For nested stacks, the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

    For more information, see Nested stacks in the CloudFormation User Guide.

    *)
  5. stack_status_reason : stack_status_reason option;
    (*

    Success/Failure message associated with the stack status.

    *)
  6. stack_status : stack_status;
    (*

    The current status of the stack.

    *)
  7. deletion_time : deletion_time option;
    (*

    The time the stack was deleted.

    *)
  8. last_updated_time : last_updated_time option;
    (*

    The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

    *)
  9. creation_time : creation_time;
    (*

    The time the stack was created.

    *)
  10. template_description : template_description option;
    (*

    The template description of the template used to create the stack.

    *)
  11. stack_name : stack_name;
    (*

    The name associated with the stack.

    *)
  12. stack_id : stack_id option;
    (*

    Unique stack identifier.

    *)
}

The StackSummary Data Type

type nonrec stack_summaries = stack_summary list
type nonrec stack_status_filter = stack_status list
type nonrec stack_set_id = string
type nonrec stack_set_status =
  1. | DELETED
  2. | ACTIVE
type nonrec stack_set_summary = {
  1. managed_execution : managed_execution option;
    (*

    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    *)
  2. last_drift_check_timestamp : timestamp option;
    (*

    Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn't yet been performed on.

    *)
  3. drift_status : stack_drift_status option;
    (*

    Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

    • DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.
    • IN_SYNC: All the stack instances belonging to the StackSet match the expected template and parameter configuration.
    • UNKNOWN: This value is reserved for future use.
    *)
  4. permission_model : permission_models option;
    (*

    Describes how the IAM roles required for StackSet operations are created.

    *)
  5. auto_deployment : auto_deployment option;
    (*

    [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).

    *)
  6. status : stack_set_status option;
    (*

    The status of the StackSet.

    *)
  7. description : description option;
    (*

    A description of the StackSet that you specify when the StackSet is created or updated.

    *)
  8. stack_set_id : stack_set_id option;
    (*

    The ID of the StackSet.

    *)
  9. stack_set_name : stack_set_name option;
    (*

    The name of the StackSet.

    *)
}

The structures that contain summary information about the specified StackSet.

type nonrec stack_set_summaries = stack_set_summary list
type nonrec stack_set_operation_action =
  1. | DETECT_DRIFT
  2. | DELETE
  3. | UPDATE
  4. | CREATE
type nonrec stack_set_operation_status =
  1. | QUEUED
  2. | STOPPED
  3. | STOPPING
  4. | FAILED
  5. | SUCCEEDED
  6. | RUNNING
type nonrec stack_set_operation_status_reason = string
type nonrec failed_stack_instances_count = int
type nonrec stack_set_operation_status_details = {
  1. failed_stack_instances_count : failed_stack_instances_count option;
    (*

    The number of stack instances for which the StackSet operation failed.

    *)
}

Detailed information about the StackSet operation.

type nonrec stack_set_operation_summary = {
  1. operation_preferences : stack_set_operation_preferences option;
    (*

    The user-specified preferences for how CloudFormation performs a StackSet operation.

    For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.

    *)
  2. status_details : stack_set_operation_status_details option;
    (*

    Detailed information about the StackSet operation.

    *)
  3. status_reason : stack_set_operation_status_reason option;
    (*

    The status of the operation in details.

    *)
  4. end_timestamp : timestamp option;
    (*

    The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.

    *)
  5. creation_timestamp : timestamp option;
    (*

    The time at which the operation was initiated. Note that the creation times for the StackSet operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

    *)
  6. status : stack_set_operation_status option;
    (*

    The overall status of the operation.

    • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
    • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSet status codes in the CloudFormation User Guide.
    • RUNNING: The operation is currently being performed.
    • STOPPED: The user has canceled the operation.
    • STOPPING: The operation is in the process of stopping, at user request.
    • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
    *)
  7. action : stack_set_operation_action option;
    (*

    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.

    *)
  8. operation_id : client_request_token option;
    (*

    The unique ID of the StackSet operation.

    *)
}

The structures that contain summary information about the specified operation.

type nonrec stack_set_operation_summaries = stack_set_operation_summary list
type nonrec stack_set_operation_result_status =
  1. | CANCELLED
  2. | FAILED
  3. | SUCCEEDED
  4. | RUNNING
  5. | PENDING
type nonrec reason = string
type nonrec account_gate_status =
  1. | SKIPPED
  2. | FAILED
  3. | SUCCEEDED
type nonrec account_gate_status_reason = string
type nonrec account_gate_result = {
  1. status_reason : account_gate_status_reason option;
    (*

    The reason for the account gate status assigned to this account and Region for the StackSet operation.

    *)
  2. status : account_gate_status option;
    (*

    The status of the account gate function.

    • SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.
    • FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

    • SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

      • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.
      • The AWSCloudFormationStackSetExecutionRole of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.
      • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.
    *)
}

Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a StackSet operation in an account and Region.

For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a StackSet operation in that account and Region. CloudFormation invokes the function each time a StackSet operation is requested for that account and Region; if the function returns FAILED, CloudFormation cancels the operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

For more information, see Prevent failed StackSets deployments using target account gates in the CloudFormation User Guide.

type nonrec stack_set_operation_result_summary = {
  1. organizational_unit_id : organizational_unit_id option;
    (*

    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

    *)
  2. account_gate_result : account_gate_result option;
    (*

    The results of the account gate function CloudFormation invokes, if present, before proceeding with StackSet operations in an account.

    *)
  3. status_reason : reason option;
    (*

    The reason for the assigned result status.

    *)
  4. status : stack_set_operation_result_status option;
    (*

    The result status of the StackSet operation for the given account in the given Region.

    • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the StackSet operation, or because the failure tolerance of the StackSet operation has been exceeded.

    • FAILED: The operation in the specified account and Region failed.

      If the StackSet operation fails in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded.

    • RUNNING: The operation in the specified account and Region is currently in progress.
    • PENDING: The operation in the specified account and Region has yet to start.
    • SUCCEEDED: The operation in the specified account and Region completed successfully.
    *)
  5. region : region option;
    (*

    The name of the Amazon Web Services Region for this operation result.

    *)
  6. account : account option;
    (*

    [Self-managed permissions] The name of the Amazon Web Services account for this operation result.

    *)
}

The structure that contains information about a specified operation's results for a given account in a given Region.

type nonrec stack_set_operation_result_summaries = stack_set_operation_result_summary list
type nonrec retain_stacks_nullable = bool
type nonrec stack_set_drift_status =
  1. | NOT_CHECKED
  2. | IN_SYNC
  3. | DRIFTED
type nonrec stack_set_drift_detection_status =
  1. | STOPPED
  2. | IN_PROGRESS
  3. | PARTIAL_SUCCESS
  4. | FAILED
  5. | COMPLETED
type nonrec drifted_stack_instances_count = int
type nonrec in_sync_stack_instances_count = int
type nonrec in_progress_stack_instances_count = int
type nonrec stack_set_drift_detection_details = {
  1. failed_stack_instances_count : failed_stack_instances_count option;
    (*

    The number of stack instances for which the drift detection operation failed.

    *)
  2. in_progress_stack_instances_count : in_progress_stack_instances_count option;
    (*

    The number of stack instances that are currently being checked for drift.

    *)
  3. in_sync_stack_instances_count : in_sync_stack_instances_count option;
    (*

    The number of stack instances which match the expected template and parameter configuration of the StackSet.

    *)
  4. drifted_stack_instances_count : drifted_stack_instances_count option;
    (*

    The number of stack instances that have drifted from the expected template and parameter configuration of the StackSet. A stack instance is considered to have drifted if one or more of the resources in the associated stack don't match their expected configuration.

    *)
  5. total_stack_instances_count : total_stack_instances_count option;
    (*

    The total number of stack instances belonging to this StackSet.

    The total number of stack instances is equal to the total of:

    • Stack instances that match the StackSet configuration.
    • Stack instances that have drifted from the StackSet configuration.
    • Stack instances where the drift detection operation has failed.
    • Stack instances currently being checked for drift.
    *)
  6. last_drift_check_timestamp : timestamp option;
    (*

    Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be NULL for any StackSet that drift detection hasn't yet been performed on.

    *)
  7. drift_detection_status : stack_set_drift_detection_status option;
    (*

    The status of the StackSet drift detection operation.

    • COMPLETED: The drift detection operation completed without failing on any stack instances.
    • FAILED: The drift detection operation exceeded the specified failure tolerance.
    • PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation.
    • IN_PROGRESS: The drift detection operation is currently being performed.
    • STOPPED: The user has canceled the drift detection operation.
    *)
  8. drift_status : stack_set_drift_status option;
    (*

    Status of the StackSet's actual configuration compared to its expected template and parameter configuration.

    • DRIFTED: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.
    • IN_SYNC: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.
    *)
}

Detailed information about the drift status of the StackSet.

For StackSets, contains information about the last completed drift operation performed on the StackSet. Information about drift operations in-progress isn't included.

For StackSet operations, includes information about drift operations currently being performed on the StackSet.

For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.

type nonrec stack_set_operation = {
  1. status_details : stack_set_operation_status_details option;
    (*

    Detailed information about the StackSet operation.

    *)
  2. status_reason : stack_set_operation_status_reason option;
    (*

    The status of the operation in details.

    *)
  3. stack_set_drift_detection_details : stack_set_drift_detection_details option;
    (*

    Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.

    This information will only be present for StackSet operations whose Action type is DETECT_DRIFT.

    For more information, see Performing drift detection on CloudFormation StackSets in the CloudFormation User Guide.

    *)
  4. deployment_targets : deployment_targets option;
    (*

    The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.

    *)
  5. end_timestamp : timestamp option;
    (*

    The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.

    *)
  6. creation_timestamp : timestamp option;
    (*

    The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

    *)
  7. execution_role_name : execution_role_name option;
    (*

    The name of the IAM execution role used to create or update the StackSet.

    Use customized execution roles to control which stack resources users and groups can include in their StackSets.

    *)
  8. administration_role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.

    Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

    *)
  9. retain_stacks : retain_stacks_nullable option;
    (*

    For StackSet operations of action type DELETE, specifies whether to remove the stack instances from the specified StackSet, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new StackSet.

    *)
  10. operation_preferences : stack_set_operation_preferences option;
    (*

    The preferences for how CloudFormation performs this StackSet operation.

    *)
  11. status : stack_set_operation_status option;
    (*

    The status of the operation.

    • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
    • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSets status codes in the CloudFormation User Guide.
    • RUNNING: The operation is currently being performed.
    • STOPPED: The user has canceled the operation.
    • STOPPING: The operation is in the process of stopping, at user request.
    • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
    *)
  12. action : stack_set_operation_action option;
    (*

    The type of StackSet operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to all associated stack instances.

    *)
  13. stack_set_id : stack_set_id option;
    (*

    The ID of the StackSet.

    *)
  14. operation_id : client_request_token option;
    (*

    The unique ID of a StackSet operation.

    *)
}

The structure that contains information about a StackSet operation.

type nonrec stack_set_not_empty_exception = {
  1. message : error_message option;
}

You can't yet delete this StackSet, because it still contains one or more stack instances. Delete all stack instances from the StackSet before deleting the StackSet.

type nonrec stack_set_auto_deployment_target_summary = {
  1. regions : region_list option;
    (*

    The list of Regions targeted for this organization or OU.

    *)
  2. organizational_unit_id : organizational_unit_id option;
    (*

    The organization root ID or organizational unit (OU) IDs where the StackSet is targeted.

    *)
}

One of the targets for the StackSet. Returned by the ListStackSetAutoDeploymentTargets API operation.

type nonrec stack_set_auto_deployment_target_summaries = stack_set_auto_deployment_target_summary list
type nonrec stack_set = {
  1. regions : region_list option;
    (*

    Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

    *)
  2. managed_execution : managed_execution option;
    (*

    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    *)
  3. organizational_unit_ids : organizational_unit_id_list option;
    (*

    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

    *)
  4. permission_model : permission_models option;
    (*

    Describes how the IAM roles required for StackSet operations are created.

    *)
  5. auto_deployment : auto_deployment option;
    (*

    Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). Valid only if the StackSet uses service-managed permissions.

    *)
  6. stack_set_drift_detection_details : stack_set_drift_detection_details option;
    (*

    Detailed information about the drift status of the StackSet.

    For StackSets, contains information about the last completed drift operation performed on the StackSet. Information about drift operations currently in progress isn't included.

    *)
  7. execution_role_name : execution_role_name option;
    (*

    The name of the IAM execution role used to create or update the StackSet.

    Use customized execution roles to control which stack resources users and groups can include in their StackSets.

    *)
  8. administration_role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

    Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the CloudFormation User Guide.

    *)
  9. stack_set_ar_n : stack_set_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the StackSet.

    *)
  10. tags : tags option;
    (*

    A list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.

    *)
  11. capabilities : capabilities option;
    (*

    The capabilities that are allowed in the StackSet. Some StackSet templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in CloudFormation templates.

    *)
  12. parameters : parameters option;
    (*

    A list of input parameters for a StackSet.

    *)
  13. template_body : template_body option;
    (*

    The structure that contains the body of the template that was used to create or update the StackSet.

    *)
  14. status : stack_set_status option;
    (*

    The status of the StackSet.

    *)
  15. description : description option;
    (*

    A description of the StackSet that you specify when the StackSet is created or updated.

    *)
  16. stack_set_id : stack_set_id option;
    (*

    The ID of the StackSet.

    *)
  17. stack_set_name : stack_set_name option;
    (*

    The name that's associated with the StackSet.

    *)
}

A structure that contains information about a StackSet. With StackSets, you can provision stacks across Amazon Web Services accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

type nonrec physical_resource_id = string
type nonrec resource_status =
  1. | ROLLBACK_FAILED
  2. | ROLLBACK_COMPLETE
  3. | ROLLBACK_IN_PROGRESS
  4. | UPDATE_ROLLBACK_FAILED
  5. | UPDATE_ROLLBACK_COMPLETE
  6. | UPDATE_ROLLBACK_IN_PROGRESS
  7. | EXPORT_ROLLBACK_COMPLETE
  8. | EXPORT_ROLLBACK_FAILED
  9. | EXPORT_ROLLBACK_IN_PROGRESS
  10. | EXPORT_IN_PROGRESS
  11. | EXPORT_COMPLETE
  12. | EXPORT_FAILED
  13. | IMPORT_ROLLBACK_COMPLETE
  14. | IMPORT_ROLLBACK_FAILED
  15. | IMPORT_ROLLBACK_IN_PROGRESS
  16. | IMPORT_IN_PROGRESS
  17. | IMPORT_COMPLETE
  18. | IMPORT_FAILED
  19. | UPDATE_COMPLETE
  20. | UPDATE_FAILED
  21. | UPDATE_IN_PROGRESS
  22. | DELETE_SKIPPED
  23. | DELETE_COMPLETE
  24. | DELETE_FAILED
  25. | DELETE_IN_PROGRESS
  26. | CREATE_COMPLETE
  27. | CREATE_FAILED
  28. | CREATE_IN_PROGRESS
type nonrec resource_status_reason = string
type nonrec stack_resource_drift_status =
  1. | UNSUPPORTED
  2. | UNKNOWN
  3. | NOT_CHECKED
  4. | DELETED
  5. | MODIFIED
  6. | IN_SYNC
type nonrec stack_resource_drift_information = {
  1. last_check_timestamp : timestamp option;
    (*

    When CloudFormation last checked if the resource had drifted from its expected configuration.

    *)
  2. stack_resource_drift_status : stack_resource_drift_status;
    (*

    Status of the resource's actual configuration compared to its expected configuration

    • DELETED: The resource differs from its expected configuration in that it has been deleted.
    • MODIFIED: The resource differs from its expected configuration.

    • NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected configuration.

      Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection.

    • IN_SYNC: The resource's actual configuration matches its expected configuration.
    *)
}

Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

type nonrec logical_id_hierarchy = string
type nonrec module_info = {
  1. logical_id_hierarchy : logical_id_hierarchy option;
    (*

    A concatenated list of the logical IDs of the module or modules that contains the resource. Modules are listed starting with the inner-most nested module, and separated by /.

    In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.

    moduleA/moduleB

    For more information, see Reference module resources in CloudFormation templates in the CloudFormation User Guide.

    *)
  2. type_hierarchy : type_hierarchy option;
    (*

    A concatenated list of the module type or types that contains the resource. Module types are listed starting with the inner-most nested module, and separated by /.

    In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that's nested inside a parent module of type AWS::Second::Example::MODULE.

    AWS::First::Example::MODULE/AWS::Second::Example::MODULE

    *)
}

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

For more information about modules, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide.

type nonrec stack_resource = {
  1. module_info : module_info option;
    (*

    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    *)
  2. drift_information : stack_resource_drift_information option;
    (*

    Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

    *)
  3. description : description option;
    (*

    User defined description associated with the resource.

    *)
  4. resource_status_reason : resource_status_reason option;
    (*

    Success/failure message associated with the resource.

    *)
  5. resource_status : resource_status;
    (*

    Current status of the resource.

    *)
  6. timestamp : timestamp;
    (*

    Time the status was updated.

    *)
  7. resource_type : resource_type;
    (*

    Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    *)
  8. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    *)
  9. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource specified in the template.

    *)
  10. stack_id : stack_id option;
    (*

    Unique identifier of the stack.

    *)
  11. stack_name : stack_name option;
    (*

    The name associated with the stack.

    *)
}

The StackResource data type.

type nonrec stack_resources = stack_resource list
type nonrec stack_resource_drift_information_summary = {
  1. last_check_timestamp : timestamp option;
    (*

    When CloudFormation last checked if the resource had drifted from its expected configuration.

    *)
  2. stack_resource_drift_status : stack_resource_drift_status;
    (*

    Status of the resource's actual configuration compared to its expected configuration.

    • DELETED: The resource differs from its expected configuration in that it has been deleted.
    • MODIFIED: The resource differs from its expected configuration.

    • NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.

      Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more information, see Resource type support for imports and drift detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information about skipping resources during rollback operations, see Continue rolling back an update in the CloudFormation User Guide.

    • IN_SYNC: The resource's actual configuration matches its expected configuration.
    *)
}

Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

type nonrec stack_resource_summary = {
  1. module_info : module_info option;
    (*

    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    *)
  2. drift_information : stack_resource_drift_information_summary option;
    (*

    Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

    *)
  3. resource_status_reason : resource_status_reason option;
    (*

    Success/failure message associated with the resource.

    *)
  4. resource_status : resource_status;
    (*

    Current status of the resource.

    *)
  5. last_updated_timestamp : timestamp;
    (*

    Time the status was updated.

    *)
  6. resource_type : resource_type;
    (*

    Type of resource. (For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.)

    *)
  7. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of the resource.

    *)
  8. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource specified in the template.

    *)
}

Contains high-level information about the specified stack resource.

type nonrec stack_resource_summaries = stack_resource_summary list
type nonrec key = string
type nonrec physical_resource_id_context_key_value_pair = {
  1. value : value;
    (*

    The resource context value.

    *)
  2. key : key;
    (*

    The resource context key.

    *)
}

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.

type nonrec physical_resource_id_context = physical_resource_id_context_key_value_pair list
type nonrec properties = string
type nonrec property_value = string
type nonrec difference_type =
  1. | NOT_EQUAL
  2. | REMOVE
  3. | ADD
type nonrec property_difference = {
  1. difference_type : difference_type;
    (*

    The type of property difference.

    • ADD: A value has been added to a resource property that's an array or list data type.
    • REMOVE: The property has been removed from the current resource configuration.
    • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).
    *)
  2. actual_value : property_value;
    (*

    The actual property value of the resource property.

    *)
  3. expected_value : property_value;
    (*

    The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

    *)
  4. property_path : property_path;
    (*

    The fully-qualified path to the resource property.

    *)
}

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

type nonrec property_differences = property_difference list
type nonrec stack_resource_drift_status_reason = string
type nonrec stack_resource_drift = {
  1. drift_status_reason : stack_resource_drift_status_reason option;
    (*

    The reason for the drift status.

    *)
  2. module_info : module_info option;
    (*

    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    *)
  3. timestamp : timestamp;
    (*

    Time at which CloudFormation performed drift detection on the stack resource.

    *)
  4. stack_resource_drift_status : stack_resource_drift_status;
    (*

    Status of the resource's actual configuration compared to its expected configuration.

    • DELETED: The resource differs from its expected template configuration because the resource has been deleted.
    • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).
    • IN_SYNC: The resource's actual configuration matches its expected template configuration.
    • NOT_CHECKED: CloudFormation does not currently return this value.
    • UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.
    *)
  5. property_differences : property_differences option;
    (*

    A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

    *)
  6. actual_properties : properties option;
    (*

    A JSON structure that contains the actual property values of the stack resource.

    For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

    *)
  7. expected_properties : properties option;
    (*

    A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

    For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

    *)
  8. resource_type : resource_type;
    (*

    The type of the resource.

    *)
  9. physical_resource_id_context : physical_resource_id_context option;
    (*

    Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

    *)
  10. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    *)
  11. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource specified in the template.

    *)
  12. stack_id : stack_id;
    (*

    The ID of the stack.

    *)
}

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

type nonrec stack_resource_drifts = stack_resource_drift list
type nonrec stack_resource_drift_status_filters = stack_resource_drift_status list
type nonrec metadata = string
type nonrec stack_resource_detail = {
  1. module_info : module_info option;
    (*

    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    *)
  2. drift_information : stack_resource_drift_information option;
    (*

    Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

    *)
  3. metadata : metadata option;
    (*

    The content of the Metadata attribute declared for the resource. For more information, see Metadata attribute in the CloudFormation User Guide.

    *)
  4. description : description option;
    (*

    User defined description associated with the resource.

    *)
  5. resource_status_reason : resource_status_reason option;
    (*

    Success/failure message associated with the resource.

    *)
  6. resource_status : resource_status;
    (*

    Current status of the resource.

    *)
  7. last_updated_timestamp : timestamp;
    (*

    Time the status was updated.

    *)
  8. resource_type : resource_type;
    (*

    Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    *)
  9. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    *)
  10. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource specified in the template.

    *)
  11. stack_id : stack_id option;
    (*

    Unique identifier of the stack.

    *)
  12. stack_name : stack_name option;
    (*

    The name associated with the stack.

    *)
}

Contains detailed information about the specified stack resource.

type nonrec stack_refactor_untag_resources = tag_key list
type nonrec stack_refactor_tag_resources = tag list
type nonrec stack_refactor_id = string
type nonrec stack_refactor_execution_status =
  1. | ROLLBACK_FAILED
  2. | ROLLBACK_COMPLETE
  3. | ROLLBACK_IN_PROGRESS
  4. | EXECUTE_FAILED
  5. | EXECUTE_COMPLETE
  6. | EXECUTE_IN_PROGRESS
  7. | OBSOLETE
  8. | AVAILABLE
  9. | UNAVAILABLE
type nonrec execution_status_reason = string
type nonrec stack_refactor_status =
  1. | DELETE_FAILED
  2. | DELETE_COMPLETE
  3. | DELETE_IN_PROGRESS
  4. | CREATE_FAILED
  5. | CREATE_COMPLETE
  6. | CREATE_IN_PROGRESS
type nonrec stack_refactor_status_reason = string
type nonrec stack_refactor_summary = {
  1. status_reason : stack_refactor_status_reason option;
    (*

    A detailed explanation for the stack refactor Status.

    *)
  2. status : stack_refactor_status option;
    (*

    The stack refactor operation status that's provided after calling the CreateStackRefactor action.

    *)
  3. execution_status_reason : execution_status_reason option;
    (*

    A detailed explanation for the stack refactor ExecutionStatus.

    *)
  4. execution_status : stack_refactor_execution_status option;
    (*

    The operation status that's provided after calling the ExecuteStackRefactor action.

    *)
  5. description : description option;
    (*

    A description to help you identify the refactor.

    *)
  6. stack_refactor_id : stack_refactor_id option;
    (*

    The ID associated with the stack refactor created from the CreateStackRefactor action.

    *)
}

The summary of a stack refactor operation.

type nonrec stack_refactor_summaries = stack_refactor_summary list
type nonrec stack_refactor_resource_identifier = string
type nonrec stack_refactor_not_found_exception = {
  1. message : error_message option;
}

The specified stack refactor can't be found.

type nonrec stack_refactor_execution_status_filter = stack_refactor_execution_status list
type nonrec stack_refactor_detection =
  1. | MANUAL
  2. | AUTO
type nonrec stack_refactor_action_type =
  1. | CREATE
  2. | MOVE
type nonrec stack_refactor_action_entity =
  1. | STACK
  2. | RESOURCE
type nonrec detection_reason = string
type nonrec resource_location = {
  1. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource specified in the template.

    *)
  2. stack_name : stack_name;
    (*

    The name associated with the stack.

    *)
}

The location of the resource in a stack template.

type nonrec resource_mapping = {
  1. destination : resource_location;
    (*

    The destination stack StackName and LogicalResourceId for the resource being refactored.

    *)
  2. source : resource_location;
    (*

    The source stack StackName and LogicalResourceId for the resource being refactored.

    *)
}

Specifies the current source of the resource and the destination of where it will be moved to.

type nonrec stack_refactor_action = {
  1. resource_mapping : resource_mapping option;
    (*

    The mapping for the stack resource Source and stack resource Destination.

    *)
  2. untag_resources : stack_refactor_untag_resources option;
    (*

    Removes one or more tags to specified resources.

    *)
  3. tag_resources : stack_refactor_tag_resources option;
    (*

    Assigns one or more tags to specified resources.

    *)
  4. detection_reason : detection_reason option;
    (*

    The description of the detection type.

    *)
  5. detection : stack_refactor_detection option;
    (*

    The detection type is one of the following:

    • Auto: CloudFormation figured out the mapping on its own.
    • Manual: The customer provided the mapping in the ResourceMapping parameter.
    *)
  6. description : description option;
    (*

    A description to help you identify the refactor.

    *)
  7. resource_identifier : stack_refactor_resource_identifier option;
    (*

    A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

    *)
  8. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier associated with the physical instance of the resource.

    *)
  9. entity : stack_refactor_action_entity option;
    (*

    The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

    • Stack
    • Resource
    *)
  10. action : stack_refactor_action_type option;
    (*

    The action that CloudFormation takes on the stack.

    *)
}

Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.

type nonrec stack_refactor_actions = stack_refactor_action list
type nonrec stack_not_found_exception = {
  1. message : error_message option;
}

The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.

type nonrec stack_instance_status =
  1. | INOPERABLE
  2. | OUTDATED
  3. | CURRENT
type nonrec stack_instance_detailed_status =
  1. | FAILED_IMPORT
  2. | SKIPPED_SUSPENDED_ACCOUNT
  3. | INOPERABLE
  4. | CANCELLED
  5. | FAILED
  6. | SUCCEEDED
  7. | RUNNING
  8. | PENDING
type nonrec stack_instance_comprehensive_status = {
  1. detailed_status : stack_instance_detailed_status option;
    (*
    • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the StackSet operation, or because the failure tolerance of the StackSet operation has been exceeded.
    • FAILED: The operation in the specified account and Region failed. If the StackSet operation fails in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded.
    • FAILED_IMPORT: The import of the stack instance in the specified account and Region failed and left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be retried. If enough StackSet operations fail in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded.
    • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
    • PENDING: The operation in the specified account and Region has yet to start.
    • RUNNING: The operation in the specified account and Region is currently in progress.
    • SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.
    • SUCCEEDED: The operation in the specified account and Region completed successfully.
    *)
}

The detailed status of the stack instance.

type nonrec stack_instance_summary = {
  1. last_operation_id : client_request_token option;
    (*

    The last unique ID of a StackSet operation performed on a stack instance.

    *)
  2. last_drift_check_timestamp : timestamp option;
    (*

    Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.

    *)
  3. drift_status : stack_drift_status option;
    (*

    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.

    • DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.
    • IN_SYNC: The stack instance's actual configuration matches its expected StackSet configuration.
    • UNKNOWN: This value is reserved for future use.
    *)
  4. organizational_unit_id : organizational_unit_id option;
    (*

    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

    *)
  5. stack_instance_status : stack_instance_comprehensive_status option;
    (*

    The detailed status of the stack instance.

    *)
  6. status_reason : reason option;
    (*

    The explanation for the specific status code assigned to this stack instance.

    *)
  7. status : stack_instance_status option;
    (*

    The status of the stack instance, in terms of its synchronization with its associated stack set.

    • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance API operation, look at the DetailedStatus member returned in the StackInstanceSummary member.

    • OUTDATED: The stack isn't currently up to date with the StackSet because:

      • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
      • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
    • CURRENT: The stack is currently up to date with the StackSet.
    *)
  8. stack_id : stack_id option;
    (*

    The ID of the stack instance.

    *)
  9. account : account option;
    (*

    [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

    *)
  10. region : region option;
    (*

    The name of the Amazon Web Services Region that the stack instance is associated with.

    *)
  11. stack_set_id : stack_set_id option;
    (*

    The name or unique ID of the StackSet that the stack instance is associated with.

    *)
}

The structure that contains summary information about a stack instance.

type nonrec stack_instance_summaries = stack_instance_summary list
type nonrec stack_instance_resource_drifts_summary = {
  1. timestamp : timestamp;
    (*

    Time at which the stack instance drift detection operation was initiated.

    *)
  2. stack_resource_drift_status : stack_resource_drift_status;
    (*

    The drift status of the resource in a stack instance.

    • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
    • MODIFIED: One or more resource properties differ from their expected template values.
    • IN_SYNC: The resource's actual configuration matches its expected template configuration.
    • NOT_CHECKED: CloudFormation doesn't currently return this value.
    *)
  3. property_differences : property_differences option;
    (*

    Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose StackInstanceResourceDriftStatus is MODIFIED.

    *)
  4. resource_type : resource_type;
    (*

    Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    *)
  5. physical_resource_id_context : physical_resource_id_context option;
    (*

    Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

    *)
  6. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    *)
  7. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource specified in the template.

    *)
  8. stack_id : stack_id;
    (*

    The ID of the stack instance.

    *)
}

The structure containing summary information about resource drifts for a stack instance.

type nonrec stack_instance_resource_drifts_summaries = stack_instance_resource_drifts_summary list
type nonrec stack_instance_filter_name =
  1. | DRIFT_STATUS
  2. | LAST_OPERATION_ID
  3. | DETAILED_STATUS
type nonrec stack_instance_filter_values = string
type nonrec stack_instance_filter = {
  1. values : stack_instance_filter_values option;
    (*

    The status to filter by.

    *)
  2. name : stack_instance_filter_name option;
    (*

    The type of filter to apply.

    *)
}

The filter to apply to stack instances

type nonrec stack_instance_filters = stack_instance_filter list
type nonrec stack_instance = {
  1. last_operation_id : client_request_token option;
    (*

    The last unique ID of a StackSet operation performed on a stack instance.

    *)
  2. last_drift_check_timestamp : timestamp option;
    (*

    Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance that drift detection hasn't yet been performed on.

    *)
  3. drift_status : stack_drift_status option;
    (*

    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.

    • DRIFTED: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected StackSet configuration.
    • IN_SYNC: The stack instance's actual configuration matches its expected StackSset configuration.
    • UNKNOWN: This value is reserved for future use.
    *)
  4. organizational_unit_id : organizational_unit_id option;
    (*

    [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

    *)
  5. status_reason : reason option;
    (*

    The explanation for the specific status code that's assigned to this stack instance.

    *)
  6. stack_instance_status : stack_instance_comprehensive_status option;
    (*

    The detailed status of the stack instance.

    *)
  7. status : stack_instance_status option;
    (*

    The status of the stack instance, in terms of its synchronization with its associated stack set.

    • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. INOPERABLE can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at the DetailedStatus member in the StackInstanceSummary member that is a peer to this Status member.

    • OUTDATED: The stack isn't currently up to date with the StackSet because:

      • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
      • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
    • CURRENT: The stack is currently up to date with the StackSet.
    *)
  8. parameter_overrides : parameters option;
    (*

    A list of parameters from the StackSet template whose values have been overridden in this stack instance.

    *)
  9. stack_id : stack_id option;
    (*

    The ID of the stack instance.

    *)
  10. account : account option;
    (*

    [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

    *)
  11. region : region option;
    (*

    The name of the Amazon Web Services Region that the stack instance is associated with.

    *)
  12. stack_set_id : stack_set_id option;
    (*

    The name or unique ID of the StackSet that the stack instance is associated with.

    *)
}

A CloudFormation stack, in a specific account and Region, that's part of a StackSet operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one StackSet. Each stack instance contains the ID of its associated StackSet, in addition to the ID of the actual stack and the stack status.

type nonrec stack_ids_url = string
type nonrec stack_ids = stack_id list
type nonrec stack_id_list = stack_id list
type nonrec event_id = string
type nonrec resource_properties = string
type nonrec hook_type = string
type nonrec hook_status =
  1. | HOOK_FAILED
  2. | HOOK_COMPLETE_FAILED
  3. | HOOK_COMPLETE_SUCCEEDED
  4. | HOOK_IN_PROGRESS
type nonrec hook_status_reason = string
type nonrec hook_invocation_point =
  1. | PRE_PROVISION
type nonrec hook_invocation_id = string
type nonrec hook_failure_mode =
  1. | WARN
  2. | FAIL
type nonrec stack_event = {
  1. detailed_status : detailed_status option;
    (*

    An optional field that contains information about the detailed status of the stack event.

    • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.
    *)
  2. hook_failure_mode : hook_failure_mode option;
    (*

    Specify the Hook failure mode for non-compliant resources in the followings ways.

    • FAIL Stops provisioning resources.
    • WARN Allows provisioning to continue with a warning message.
    *)
  3. hook_invocation_id : hook_invocation_id option;
    (*

    The unique identifier of the Hook invocation.

    *)
  4. hook_invocation_point : hook_invocation_point option;
    (*

    The specific point in the provisioning process where the Hook is invoked.

    *)
  5. hook_status_reason : hook_status_reason option;
    (*

    Provides the reason for the Hook status.

    *)
  6. hook_status : hook_status option;
    (*

    Provides the status of the change set Hook.

    *)
  7. hook_type : hook_type option;
    (*

    The name of the Hook.

    *)
  8. client_request_token : client_request_token option;
    (*

    The token passed to the operation that generated this event.

    All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

    In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

    *)
  9. resource_properties : resource_properties option;
    (*

    BLOB of the properties used to create the resource.

    *)
  10. resource_status_reason : resource_status_reason option;
    (*

    Success/failure message associated with the resource.

    *)
  11. resource_status : resource_status option;
    (*

    Current status of the resource.

    *)
  12. timestamp : timestamp;
    (*

    Time the status was updated.

    *)
  13. resource_type : resource_type option;
    (*

    Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    *)
  14. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier associated with the physical instance of the resource.

    *)
  15. logical_resource_id : logical_resource_id option;
    (*

    The logical name of the resource specified in the template.

    *)
  16. operation_id : operation_id option;
    (*

    The unique identifier of the operation that generated this stack event.

    *)
  17. stack_name : stack_name;
    (*

    The name associated with a stack.

    *)
  18. event_id : event_id;
    (*

    The unique identifier of this event.

    *)
  19. stack_id : stack_id;
    (*

    The unique ID name of the instance of the stack.

    *)
}

The StackEvent data type.

type nonrec stack_events = stack_event list
type nonrec stack_drift_detection_status_reason = string
type nonrec stack_drift_detection_status =
  1. | DETECTION_COMPLETE
  2. | DETECTION_FAILED
  3. | DETECTION_IN_PROGRESS
type nonrec stack_drift_detection_id = string
type nonrec stack_definition = {
  1. template_ur_l : template_ur_l option;
    (*

    The desired final state of the stack template.

    *)
  2. template_body : template_body option;
    (*

    The file path for the stack template file.

    *)
  3. stack_name : stack_name option;
    (*

    The name associated with the stack.

    *)
}

Describes the stack and the template used by the stack.

type nonrec stack_definitions = stack_definition list
type nonrec resource_signal_unique_id = string
type nonrec resource_signal_status =
  1. | FAILURE
  2. | SUCCESS
type nonrec signal_resource_input = {
  1. status : resource_signal_status;
    (*

    The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.

    *)
  2. unique_id : resource_signal_unique_id;
    (*

    A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

    *)
  3. logical_resource_id : logical_resource_id;
    (*

    The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

    *)
  4. stack_name : stack_name_or_id;
    (*

    The stack name or unique stack ID that includes the resource that you want to signal.

    *)
}

The input for the SignalResource action.

type nonrec set_type_default_version_output = unit
type nonrec private_type_arn = string
type nonrec set_type_default_version_input = {
  1. version_id : type_version_id option;
    (*

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

    *)
  2. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  3. type_ : registry_type option;
    (*

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  4. arn : private_type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension for which you want version summary information.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
}
type nonrec set_type_configuration_output = {
  1. configuration_arn : type_configuration_arn option;
    (*

    The Amazon Resource Name (ARN) for the configuration data in this account and Region.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

    *)
}
type nonrec set_type_configuration_input = {
  1. type_ : third_party_type option;
    (*

    The type of extension.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

    *)
  2. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

    *)
  3. configuration_alias : type_configuration_alias option;
    (*

    An alias by which to refer to this extension configuration data.

    Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

    *)
  4. configuration : type_configuration;
    (*

    The configuration data for the extension in this account and Region.

    The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

    *)
  5. type_arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) for the extension in this account and Region.

    For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

    Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

    *)
}
type nonrec set_stack_policy_input = {
  1. stack_policy_ur_l : stack_policy_ur_l option;
    (*

    Location of a file that contains the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    *)
  2. stack_policy_body : stack_policy_body option;
    (*

    Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    *)
  3. stack_name : stack_name;
    (*

    The name or unique stack ID that you want to associate a policy with.

    *)
}

The input for the SetStackPolicy action.

type nonrec resource_attribute =
  1. | Tags
  2. | UpdateReplacePolicy
  3. | DeletionPolicy
  4. | UpdatePolicy
  5. | CreationPolicy
  6. | Metadata
  7. | Properties
type nonrec scope = resource_attribute list
type nonrec jazz_resource_identifier_property_value = string
type nonrec jazz_resource_identifier_property_key = string
type nonrec jazz_resource_identifier_properties = (jazz_resource_identifier_property_key * jazz_resource_identifier_property_value) list
type nonrec managed_by_stack = bool
type nonrec scanned_resource = {
  1. managed_by_stack : managed_by_stack option;
    (*

    If true, the resource is managed by a CloudFormation stack.

    *)
  2. resource_identifier : jazz_resource_identifier_properties option;
    (*

    A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

    *)
  3. resource_type : resource_type option;
    (*

    The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide

    *)
}

A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources.

type nonrec scanned_resources = scanned_resource list
type nonrec scanned_resource_identifier = {
  1. resource_identifier : jazz_resource_identifier_properties;
    (*

    A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

    *)
  2. resource_type : resource_type;
    (*

    The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide.

    *)
}

Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.

type nonrec scanned_resource_identifiers = scanned_resource_identifier list
type nonrec scan_type =
  1. | PARTIAL
  2. | FULL
type nonrec s3_url = string
type nonrec rollback_stack_output = {
  1. operation_id : operation_id option;
    (*

    A unique identifier for this rollback operation that can be used to track the operation's progress and events.

    *)
  2. stack_id : stack_id option;
    (*

    Unique identifier of the stack.

    *)
}
type nonrec rollback_stack_input = {
  1. deployment_config : deployment_config option;
    (*

    The deployment configuration for this stack operation, including the deployment mode.

    *)
  2. retain_except_on_create : retain_except_on_create option;
    (*

    When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

    Default: false

    *)
  3. client_request_token : client_request_token option;
    (*

    A unique identifier for this RollbackStack request.

    *)
  4. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.

    *)
  5. stack_name : stack_name_or_id;
    (*

    The name that's associated with the stack.

    *)
}
type nonrec role_ar_n2 = string
type nonrec retain_stacks = bool
type nonrec retain_resources = logical_resource_id list
type nonrec resource_to_skip = string
type nonrec resources_to_skip = resource_to_skip list
type nonrec resource_to_import = {
  1. resource_identifier : resource_identifier_properties;
    (*

    A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

    *)
  2. logical_resource_id : logical_resource_id;
    (*

    The logical ID of the target resource as specified in the template.

    *)
  3. resource_type : resource_type;
    (*

    The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resource type support for imports and drift detection in the CloudFormation User Guide.

    *)
}

Describes the target resource of an import operation.

type nonrec resources_to_import = resource_to_import list
type nonrec resources_scanned = int
type nonrec resources_read = int
type nonrec resource_type_prefix = string
type nonrec property_name = string
type nonrec requires_recreation =
  1. | Always
  2. | Conditionally
  3. | Never
type nonrec resource_property_path = string
type nonrec before_value = string
type nonrec after_value = string
type nonrec before_value_from =
  1. | ACTUAL_STATE
  2. | PREVIOUS_DEPLOYMENT_STATE
type nonrec after_value_from =
  1. | TEMPLATE
type nonrec resource_drift_previous_value = string
type nonrec resource_drift_actual_value = string
type nonrec live_resource_drift = {
  1. drift_detection_timestamp : timestamp option;
    (*

    The timestamp when drift was detected for this resource property.

    *)
  2. actual_value : resource_drift_actual_value option;
    (*

    The current live configuration value of the resource property.

    *)
  3. previous_value : resource_drift_previous_value option;
    (*

    The configuration value from the previous CloudFormation deployment.

    *)
}

Contains drift information for a resource property, including actual value, previous deployment value, and drift detection timestamp.

type nonrec attribute_change_type =
  1. | SyncWithActual
  2. | Modify
  3. | Remove
  4. | Add
type nonrec resource_target_definition = {
  1. attribute_change_type : attribute_change_type option;
    (*

    The type of change to be made to the property if the change is executed.

    • Add The item will be added.
    • Remove The item will be removed.
    • Modify The item will be modified.
    • SyncWithActual The drift status of this item will be reset but the item will not be modified.
    *)
  2. drift : live_resource_drift option;
    (*

    Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.

    *)
  3. after_value_from : after_value_from option;
    (*

    Indicates the source of the after value. Valid value:

    • TEMPLATE – The after value comes from the new template.

    Only present for drift-aware change sets.

    *)
  4. before_value_from : before_value_from option;
    (*

    Indicates the source of the before value. Valid values:

    • ACTUAL_STATE – The before value represents current actual state.
    • PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

    Only present for drift-aware change sets.

    *)
  5. after_value : after_value option;
    (*

    The value of the property after the change is executed. Large values can be truncated.

    *)
  6. before_value : before_value option;
    (*

    The value of the property before the change is executed. Large values can be truncated.

    *)
  7. path : resource_property_path option;
    (*

    The property path of the property.

    *)
  8. requires_recreation : requires_recreation option;
    (*

    If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    *)
  9. name : property_name option;
    (*

    If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

    *)
  10. attribute : resource_attribute option;
    (*

    Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

    *)
}

The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

type nonrec resource_scanner_max_results = int
type nonrec resource_scan_status =
  1. | EXPIRED
  2. | COMPLETE
  3. | FAILED
  4. | IN_PROGRESS
type nonrec resource_scan_status_reason = string
type nonrec percentage_completed = float
type nonrec resource_scan_summary = {
  1. scan_type : scan_type option;
    (*

    The scan type that has been completed.

    *)
  2. percentage_completed : percentage_completed option;
    (*

    The percentage of the resource scan that has been completed.

    *)
  3. end_time : timestamp option;
    (*

    The time that the resource scan was finished.

    *)
  4. start_time : timestamp option;
    (*

    The time that the resource scan was started.

    *)
  5. status_reason : resource_scan_status_reason option;
    (*

    The reason for the resource scan status, providing more information if a failure happened.

    *)
  6. status : resource_scan_status option;
    (*

    Status of the resource scan.

    IN_PROGRESS The resource scan is still in progress.

    COMPLETE The resource scan is complete.

    EXPIRED The resource scan has expired.

    FAILED The resource scan has failed.

    *)
  7. resource_scan_id : resource_scan_id option;
    (*

    The Amazon Resource Name (ARN) of the resource scan.

    *)
}

A summary of the resource scan. This is returned by the ListResourceScan API action.

type nonrec resource_scan_summaries = resource_scan_summary list
type nonrec resource_scan_not_found_exception = {
  1. message : error_message option;
}

The resource scan was not found.

type nonrec resource_model = string
type nonrec resource_mappings = resource_mapping list
type nonrec resource_identifiers = resource_identifier_property_key list
type nonrec logical_resource_ids = logical_resource_id list
type nonrec resource_identifier_summary = {
  1. resource_identifiers : resource_identifiers option;
    (*

    The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.

    *)
  2. logical_resource_ids : logical_resource_ids option;
    (*

    The logical IDs of the target resources of the specified ResourceType, as defined in the import template.

    *)
  3. resource_type : resource_type option;
    (*

    The template resource type of the target resources, such as AWS::S3::Bucket.

    *)
}

Describes the target resources of a specific type in your import template (for example, all AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of that type.

type nonrec resource_identifier_summaries = resource_identifier_summary list
type nonrec resource_identifier = string
type nonrec drift_ignored_reason =
  1. | WRITE_ONLY_PROPERTY
  2. | MANAGED_BY_AWS
type nonrec resource_drift_ignored_attribute = {
  1. reason : drift_ignored_reason option;
    (*

    Reason why drift was ignored for the attribute, can have 2 possible values:

    • WRITE_ONLY_PROPERTY - Property is not included in read response for the resource’s live state.
    • MANAGED_BY_AWS - Property is managed by an Amazon Web Services service and is expected to be dynamically modified.
    *)
  2. path : resource_property_path option;
    (*

    Path of the resource attribute for which drift was ignored.

    *)
}

The ResourceDriftIgnoredAttribute data type.

type nonrec resource_drift_ignored_attributes = resource_drift_ignored_attribute list
type nonrec generated_template_resource_status =
  1. | COMPLETE
  2. | FAILED
  3. | IN_PROGRESS
  4. | PENDING
type nonrec resource_detail = {
  1. warnings : warning_details option;
    (*

    The warnings generated for this resource.

    *)
  2. resource_status_reason : resource_status_reason option;
    (*

    The reason for the resource detail, providing more information if a failure happened.

    *)
  3. resource_status : generated_template_resource_status option;
    (*

    Status of the processing of a resource in a generated template.

    InProgress The resource processing is still in progress.

    Complete The resource processing is complete.

    Pending The resource processing is pending.

    Failed The resource processing has failed.

    *)
  4. resource_identifier : resource_identifier_properties option;
    (*

    A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

    *)
  5. logical_resource_id : logical_resource_id option;
    (*

    The logical id for this resource in the final generated template.

    *)
  6. resource_type : resource_type option;
    (*

    The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide

    *)
}

Details about a resource in a generated template

type nonrec resource_details = resource_detail list
type nonrec evaluation_type =
  1. | Dynamic
  2. | Static
type nonrec change_source =
  1. | NoModification
  2. | Automatic
  3. | DirectModification
  4. | ResourceAttribute
  5. | ParameterReference
  6. | ResourceReference
type nonrec causing_entity = string
type nonrec resource_change_detail = {
  1. causing_entity : causing_entity option;
    (*

    The identity of the entity that triggered this change. This entity is a member of the group that's specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

    If the ChangeSource value is DirectModification, no value is given for CausingEntity.

    *)
  2. change_source : change_source option;
    (*

    The group to which the CausingEntity value belongs. There are five entity groups:

    • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
    • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.
    • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
    • DirectModification entities are changes that are made directly to the template.
    • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.
    • NoModification entities are changes made to the template that matches the actual state of the resource.
    *)
  3. evaluation : evaluation_type option;
    (*

    Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

    For Static evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

    For Dynamic evaluations, can't determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

    *)
  4. target : resource_target_definition option;
    (*

    A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.

    *)
}

For a resource with Modify as the action, the ResourceChange structure describes the changes CloudFormation will make to that resource.

type nonrec resource_change_details = resource_change_detail list
type nonrec policy_action =
  1. | ReplaceAndSnapshot
  2. | ReplaceAndRetain
  3. | ReplaceAndDelete
  4. | Snapshot
  5. | Retain
  6. | Delete
type nonrec change_action =
  1. | SyncWithActual
  2. | Dynamic
  3. | Import
  4. | Remove
  5. | Modify
  6. | Add
type nonrec replacement =
  1. | Conditional
  2. | False
  3. | True
type nonrec before_context = string
type nonrec after_context = string
type nonrec previous_deployment_context = string
type nonrec resource_change = {
  1. previous_deployment_context : previous_deployment_context option;
    (*

    Information about the resource's state from the previous CloudFormation deployment.

    *)
  2. after_context : after_context option;
    (*

    An encoded JSON string that contains the context of the resource after the change is executed.

    *)
  3. before_context : before_context option;
    (*

    An encoded JSON string that contains the context of the resource before the change is executed.

    *)
  4. module_info : module_info option;
    (*

    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

    *)
  5. change_set_id : change_set_id option;
    (*

    The change set ID of the nested change set.

    *)
  6. details : resource_change_details option;
    (*

    For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

    *)
  7. resource_drift_ignored_attributes : resource_drift_ignored_attributes option;
    (*

    List of resource attributes for which drift was ignored.

    *)
  8. resource_drift_status : stack_resource_drift_status option;
    (*

    The drift status of the resource. Valid values:

    • IN_SYNC – The resource matches its template definition.
    • MODIFIED – Resource properties were modified outside CloudFormation.
    • DELETED – The resource was deleted outside CloudFormation.
    • NOT_CHECKED – CloudFormation doesn’t currently return this value.
    • UNKNOWN – Drift status could not be determined.
    • UNSUPPORTED – Resource type does not support actual state comparison.

    Only present for drift-aware change sets.

    *)
  9. scope : scope option;
    (*

    For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

    *)
  10. replacement : replacement option;
    (*

    For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

    If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

    *)
  11. resource_type : resource_type option;
    (*

    The type of CloudFormation resource, such as AWS::S3::Bucket.

    *)
  12. physical_resource_id : physical_resource_id option;
    (*

    The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

    *)
  13. logical_resource_id : logical_resource_id option;
    (*

    The resource's logical ID, which is defined in the stack's template.

    *)
  14. action : change_action option;
    (*

    The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), Dynamic (exact action for the resource can't be determined), or SyncWithActual (resource will not be changed, only CloudFormation metadata will change).

    *)
  15. policy_action : policy_action option;
    (*

    The action that will be taken on the physical resource when the change set is executed.

    • Delete The resource will be deleted.
    • Retain The resource will be retained.
    • Snapshot The resource will have a snapshot taken.
    • ReplaceAndDelete The resource will be replaced and then deleted.
    • ReplaceAndRetain The resource will be replaced and then retained.
    • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.
    *)
}

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.

type nonrec required_activated_type = {
  1. supported_major_versions : supported_major_versions option;
    (*

    A list of the major versions of the extension type that the macro supports.

    *)
  2. publisher_id : publisher_id option;
    (*

    The publisher ID of the extension publisher.

    *)
  3. original_type_name : type_name option;
    (*

    The type name of the public extension.

    If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.

    *)
  4. type_name_alias : type_name option;
    (*

    An alias assigned to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

    *)
}

For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.

For more information, see Requirements for activating third-party public modules in the CloudFormation User Guide.

type nonrec required_activated_types = required_activated_type list
type nonrec request_token = string
type nonrec remediation_message_status_message = string
type nonrec remediation_message_remediation_message = string
type nonrec registration_token = string
type nonrec registration_token_list = registration_token list
type nonrec registration_status =
  1. | FAILED
  2. | IN_PROGRESS
  3. | COMPLETE
type nonrec register_type_output = {
  1. registration_token : registration_token option;
    (*

    The identifier for this registration request.

    Use this registration token when calling DescribeTypeRegistration, which returns information about the status and IDs of the extension registration.

    *)
}
type nonrec log_group_name = string
type nonrec logging_config = {
  1. log_group_name : log_group_name;
    (*

    The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.

    *)
  2. log_role_arn : role_ar_n2;
    (*

    The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

    *)
}

Contains logging configuration information for an extension.

type nonrec register_type_input = {
  1. client_request_token : request_token option;
    (*

    A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times.

    *)
  2. execution_role_arn : role_ar_n2 option;
    (*

    The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

    For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

    If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

    *)
  3. logging_config : logging_config option;
    (*

    Specifies logging configuration information for an extension.

    *)
  4. schema_handler_package : s3_url;
    (*

    A URL to the S3 bucket that contains the extension project package that contains the necessary files for the extension you want to register.

    For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation Command Line Interface (CLI) User Guide.

    The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

    *)
  5. type_name : type_name;
    (*

    The name of the extension being registered.

    We suggest that extension names adhere to the following patterns:

    • For resource types, company_or_organization::service::type.
    • For modules, company_or_organization::service::type::MODULE.
    • For Hooks, MyCompany::Testing::MyTestHook.

    The following organization namespaces are reserved and can't be used in your extension names:

    • Alexa
    • AMZN
    • Amazon
    • AWS
    • Custom
    • Dev
    *)
  6. type_ : registry_type option;
    (*

    The kind of extension.

    *)
}
type nonrec register_publisher_output = {
  1. publisher_id : publisher_id option;
    (*

    The ID assigned this account by CloudFormation for publishing extensions.

    *)
}
type nonrec accept_terms_and_conditions = bool
type nonrec connection_arn = string
type nonrec register_publisher_input = {
  1. connection_arn : connection_arn option;
    (*

    If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

    For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.

    *)
  2. accept_terms_and_conditions : accept_terms_and_conditions option;
    (*

    Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

    The default is false.

    *)
}
type nonrec record_handler_progress_output = unit
type nonrec client_token = string
type nonrec operation_status =
  1. | FAILED
  2. | SUCCESS
  3. | IN_PROGRESS
  4. | PENDING
type nonrec handler_error_code =
  1. | UnsupportedTarget
  2. | Unknown
  3. | NonCompliant
  4. | HandlerInternalFailure
  5. | InvalidTypeConfiguration
  6. | InternalFailure
  7. | NetworkFailure
  8. | ServiceInternalError
  9. | GeneralServiceException
  10. | ServiceTimeout
  11. | ServiceLimitExceeded
  12. | Throttling
  13. | ResourceConflict
  14. | NotFound
  15. | AlreadyExists
  16. | InvalidCredentials
  17. | AccessDenied
  18. | InvalidRequest
  19. | NotUpdatable
type nonrec record_handler_progress_input = {
  1. client_request_token : client_request_token option;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
  2. resource_model : resource_model option;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
  3. error_code : handler_error_code option;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
  4. status_message : status_message option;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
  5. current_operation_status : operation_status option;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
  6. operation_status : operation_status;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
  7. bearer_token : client_token;
    (*

    Reserved for use by the CloudFormation CLI.

    *)
}
type nonrec operation_status_check_failed_exception = {
  1. message : error_message option;
}

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

type nonrec invalid_state_transition_exception = {
  1. message : error_message option;
}

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

type nonrec publisher_status =
  1. | UNVERIFIED
  2. | VERIFIED
type nonrec publisher_profile = string
type nonrec publish_type_output = {
  1. public_type_arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) assigned to the public extension upon publication.

    *)
}
type nonrec publish_type_input = {
  1. public_version_number : public_version_number option;
    (*

    The version number to assign to this version of the extension.

    Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

    MAJOR.MINOR.PATCH

    For more information, see Semantic Versioning 2.0.0.

    If you don't specify a version number, CloudFormation increments the version number by one minor version release.

    You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

    *)
  2. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    *)
  3. arn : private_type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    *)
  4. type_ : third_party_type option;
    (*

    The type of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    *)
}
type nonrec provisioning_type =
  1. | FULLY_MUTABLE
  2. | IMMUTABLE
  3. | NON_PROVISIONABLE
type nonrec parameter_type = string
type nonrec allowed_value = string
type nonrec allowed_values = allowed_value list
type nonrec parameter_constraints = {
  1. allowed_values : allowed_values option;
    (*

    A list of values that are permitted for a parameter.

    *)
}

A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, CloudFormation returns only the AllowedValues property.

type nonrec parameter_declaration = {
  1. parameter_constraints : parameter_constraints option;
    (*

    The criteria that CloudFormation uses to validate parameter values.

    *)
  2. description : description option;
    (*

    The description that's associate with the parameter.

    *)
  3. no_echo : no_echo option;
    (*

    Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.

    *)
  4. parameter_type : parameter_type option;
    (*

    The type of parameter.

    *)
  5. default_value : parameter_value option;
    (*

    The default value of the parameter.

    *)
  6. parameter_key : parameter_key option;
    (*

    The name that's associated with the parameter.

    *)
}

The ParameterDeclaration data type.

type nonrec parameter_declarations = parameter_declaration list
type nonrec organization_status =
  1. | DISABLED_PERMANENTLY
  2. | DISABLED
  3. | ENABLED
type nonrec optional_secure_url = string
type nonrec operation_result_filter_name =
  1. | OPERATION_RESULT_STATUS
type nonrec operation_result_filter_values = string
type nonrec operation_result_filter = {
  1. values : operation_result_filter_values option;
    (*

    The value to filter by.

    *)
  2. name : operation_result_filter_name option;
    (*

    The type of filter to apply.

    *)
}

The status that operation results are filtered by.

type nonrec operation_result_filters = operation_result_filter list
type nonrec beacon_stack_operation_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | IN_PROGRESS
type nonrec event_type =
  1. | HOOK_INVOCATION_ERROR
  2. | PROVISIONING_ERROR
  3. | VALIDATION_ERROR
  4. | PROGRESS_EVENT
  5. | STACK_EVENT
type nonrec operation_event = {
  1. validation_path : validation_path option;
    (*

    The path within the resource where the validation was applied.

    *)
  2. validation_status_reason : validation_status_reason option;
    (*

    Additional information about the validation status.

    *)
  3. validation_status : validation_status option;
    (*

    The status of the validation.

    *)
  4. validation_name : validation_name option;
    (*

    The name of the validation that was performed.

    *)
  5. validation_failure_mode : hook_failure_mode option;
    (*

    Specifies how validation failures are handled.

    *)
  6. detailed_status : detailed_status option;
    (*

    Additional status information about the operation.

    *)
  7. hook_failure_mode : hook_failure_mode option;
    (*

    Specifies how Hook failures are handled.

    *)
  8. hook_invocation_point : hook_invocation_point option;
    (*

    The point in the operation lifecycle when the Hook was invoked.

    *)
  9. hook_status_reason : hook_status_reason option;
    (*

    Additional information about the Hook status.

    *)
  10. hook_status : hook_status option;
    (*

    The status of the Hook invocation.

    *)
  11. hook_type : hook_type option;
    (*

    The type name of the Hook that was invoked.

    *)
  12. client_request_token : client_request_token option;
    (*

    A unique identifier for the request that initiated this operation.

    *)
  13. resource_properties : resource_properties option;
    (*

    The properties used to create the resource.

    *)
  14. resource_status_reason : resource_status_reason option;
    (*

    Success or failure message associated with the resource.

    *)
  15. resource_status : resource_status option;
    (*

    Current status of the resource.

    *)
  16. end_time : timestamp option;
    (*

    The time when the event ended.

    *)
  17. start_time : timestamp option;
    (*

    The time when the event started.

    *)
  18. timestamp : timestamp option;
    (*

    Time the status was updated.

    *)
  19. resource_type : resource_type option;
    (*

    Type of resource.

    *)
  20. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of a resource.

    *)
  21. logical_resource_id : logical_resource_id option;
    (*

    The logical name of the resource as specified in the template.

    *)
  22. event_type : event_type option;
    (*

    The type of event.

    *)
  23. operation_status : beacon_stack_operation_status option;
    (*

    The current status of the operation.

    *)
  24. operation_type : operation_type option;
    (*

    The type of operation.

    *)
  25. operation_id : operation_id option;
    (*

    The unique identifier of the operation this event belongs to.

    *)
  26. stack_id : stack_id option;
    (*

    The unique ID name of the instance of the stack.

    *)
  27. event_id : event_id option;
    (*

    A unique identifier for this event.

    *)
}

Contains detailed information about an event that occurred during a CloudFormation operation.

type nonrec operation_events = operation_event list
type nonrec on_stack_failure =
  1. | DELETE
  2. | ROLLBACK
  3. | DO_NOTHING
type nonrec on_failure =
  1. | DELETE
  2. | ROLLBACK
  3. | DO_NOTHING
type nonrec next_token = string
type nonrec name_already_exists_exception = {
  1. message : error_message option;
}

The specified name is already in use.

type nonrec max_results = int
type nonrec major_version = Smaws_Lib.CoreTypes.Int64.t
type nonrec list_types_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. type_summaries : type_summaries option;
    (*

    A list of TypeSummary structures that contain information about the specified extensions.

    *)
}
type nonrec deprecated_status =
  1. | DEPRECATED
  2. | LIVE
type nonrec list_types_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  3. filters : type_filters option;
    (*

    Filter criteria to use in determining which extensions to return.

    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

    *)
  4. type_ : registry_type option;
    (*

    The type of extension.

    *)
  5. deprecated_status : deprecated_status option;
    (*

    The deprecation status of the extension that you want to get summary information about.

    Valid values include:

    • LIVE: The extension is registered for use in CloudFormation operations.
    • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
    *)
  6. provisioning_type : provisioning_type option;
    (*

    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

    Valid values include:

    • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
    • NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.

    The default is FULLY_MUTABLE.

    *)
  7. visibility : visibility option;
    (*

    The scope at which the extensions are visible and usable in CloudFormation operations.

    Valid values include:

    • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

      • Private extensions you have registered in this account and Region.
      • Public extensions that you have activated in this account and Region.
    • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party publishers.

    The default is PRIVATE.

    *)
}
type nonrec list_type_versions_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. type_version_summaries : type_version_summaries option;
    (*

    A list of TypeVersionSummary structures that contain information about the specified extension's versions.

    *)
}
type nonrec list_type_versions_input = {
  1. publisher_id : publisher_id option;
    (*

    The publisher ID of the extension publisher.

    Extensions published by Amazon aren't assigned a publisher ID.

    *)
  2. deprecated_status : deprecated_status option;
    (*

    The deprecation status of the extension versions that you want to get summary information about.

    Valid values include:

    • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
    • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

    The default is LIVE.

    *)
  3. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  4. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  5. arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension for which you want version summary information.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  6. type_name : type_name option;
    (*

    The name of the extension for which you want version summary information.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  7. type_ : registry_type option;
    (*

    The kind of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
}
type nonrec list_type_registrations_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. registration_token_list : registration_token_list option;
    (*

    A list of extension registration tokens.

    Use DescribeTypeRegistration to return detailed information about a type registration request.

    *)
}
type nonrec list_type_registrations_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  3. registration_status_filter : registration_status option;
    (*

    The current status of the extension registration request.

    The default is IN_PROGRESS.

    *)
  4. type_arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  5. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  6. type_ : registry_type option;
    (*

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
}
type nonrec list_stacks_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

    *)
  2. stack_summaries : stack_summaries option;
    (*

    A list of StackSummary structures that contains information about the specified stacks.

    *)
}

The output for ListStacks action.

type nonrec list_stacks_input = {
  1. stack_status_filter : stack_status_filter option;
    (*

    Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
}

The input for ListStacks action.

type nonrec list_stack_sets_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. summaries : stack_set_summaries option;
    (*

    A list of StackSetSummary structures that contain information about the user's StackSets.

    *)
}
type nonrec list_stack_sets_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. status : stack_set_status option;
    (*

    The status of the StackSets that you want to get summary information about.

    *)
  3. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  4. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
}
type nonrec list_stack_set_operations_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

    *)
  2. summaries : stack_set_operation_summaries option;
    (*

    A list of StackSetOperationSummary structures that contain summary information about operations for the specified StackSet.

    *)
}
type nonrec list_stack_set_operations_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  3. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  4. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to get operation summaries for.

    *)
}
type nonrec list_stack_set_operation_results_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

    *)
  2. summaries : stack_set_operation_result_summaries option;
    (*

    A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

    *)
}
type nonrec list_stack_set_operation_results_input = {
  1. filters : operation_result_filters option;
    (*

    The filter to apply to operation results.

    *)
  2. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  3. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  4. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  5. operation_id : client_request_token;
    (*

    The ID of the StackSet operation.

    *)
  6. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to get operation results for.

    *)
}
type nonrec list_stack_set_auto_deployment_targets_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

    *)
  2. summaries : stack_set_auto_deployment_target_summaries option;
    (*

    An array of summaries of the deployment targets for the StackSet.

    *)
}
type nonrec list_stack_set_auto_deployment_targets_input = {
  1. call_as : call_as option;
    (*

    Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  3. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  4. stack_set_name : stack_set_name_or_id;
    (*

    The name or unique ID of the StackSet that you want to get automatic deployment targets for.

    *)
}
type nonrec list_stack_resources_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

    *)
  2. stack_resource_summaries : stack_resource_summaries option;
    (*

    A list of StackResourceSummary structures.

    *)
}

The output for a ListStackResources action.

type nonrec list_stack_resources_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. stack_name : stack_name;
    (*

    The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.
    *)
}

The input for the ListStackResource action.

type nonrec list_stack_refactors_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. stack_refactor_summaries : stack_refactor_summaries;
    (*

    Provides a summary of a stack refactor, including the following:

    • StackRefactorId
    • Status
    • StatusReason
    • ExecutionStatus
    • ExecutionStatusReason
    • Description
    *)
}
type nonrec list_stack_refactors_input = {
  1. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  3. execution_status_filter : stack_refactor_execution_status_filter option;
    (*

    Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.

    *)
}
type nonrec list_stack_refactor_actions_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. stack_refactor_actions : stack_refactor_actions;
    (*

    The stack refactor actions.

    *)
}
type nonrec list_stack_refactor_actions_input = {
  1. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  3. stack_refactor_id : stack_refactor_id;
    (*

    The ID associated with the stack refactor created from the CreateStackRefactor action.

    *)
}
type nonrec list_stack_instances_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. summaries : stack_instance_summaries option;
    (*

    A list of StackInstanceSummary structures that contain information about the specified stack instances.

    *)
}
type nonrec list_stack_instances_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. stack_instance_region : region option;
    (*

    The name of the Region where you want to list stack instances.

    *)
  3. stack_instance_account : account option;
    (*

    The name of the Amazon Web Services account that you want to list stack instances for.

    *)
  4. filters : stack_instance_filters option;
    (*

    The filter to apply to stack instances

    *)
  5. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  6. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  7. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to list stack instances for.

    *)
}
type nonrec list_stack_instance_resource_drifts_output = {
  1. next_token : next_token option;
    (*

    If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    *)
  2. summaries : stack_instance_resource_drifts_summaries option;
    (*

    A list of StackInstanceResourceDriftsSummary structures that contain information about the specified stack instances.

    *)
}
type nonrec list_stack_instance_resource_drifts_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token;
    (*

    The unique ID of the drift operation.

    *)
  3. stack_instance_region : region;
    (*

    The name of the Region where you want to list resource drifts.

    *)
  4. stack_instance_account : account;
    (*

    The name of the Amazon Web Services account that you want to list resource drifts for.

    *)
  5. stack_instance_resource_drift_statuses : stack_resource_drift_status_filters option;
    (*

    The resource drift status of the stack instance.

    • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
    • MODIFIED: One or more resource properties differ from their expected template values.
    • IN_SYNC: The resource's actual configuration matches its expected template configuration.
    • NOT_CHECKED: CloudFormation doesn't currently return this value.
    *)
  6. max_results : max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  7. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  8. stack_set_name : stack_set_name_or_id;
    (*

    The name or unique ID of the StackSet that you want to list drifted resources for.

    *)
}
type nonrec list_resource_scans_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

    *)
  2. resource_scan_summaries : resource_scan_summaries option;
    (*

    The list of scans returned.

    *)
}
type nonrec list_resource_scans_input = {
  1. scan_type_filter : scan_type option;
    (*

    The scan type that you want to get summary information about. The default is FULL.

    *)
  2. max_results : resource_scanner_max_results option;
    (*

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.

    *)
  3. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
}
type nonrec list_resource_scan_resources_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

    *)
  2. resources : scanned_resources option;
    (*

    List of up to MaxResults resources in the specified resource scan that match all of the specified filters.

    *)
}
type nonrec list_resource_scan_resources_input = {
  1. max_results : resource_scanner_max_results option;
    (*

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanResources API action will return at most 100 results in each response. The maximum value is 100.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  3. tag_value : tag_value option;
    (*

    If specified, the returned resources will have a matching tag value.

    *)
  4. tag_key : tag_key option;
    (*

    If specified, the returned resources will have a matching tag key.

    *)
  5. resource_type_prefix : resource_type_prefix option;
    (*

    If specified, the returned resources will be of any of the resource types with the specified prefix.

    *)
  6. resource_identifier : resource_identifier option;
    (*

    If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).

    *)
  7. resource_scan_id : resource_scan_id;
    (*

    The Amazon Resource Name (ARN) of the resource scan.

    *)
}
type nonrec boxed_max_results = int
type nonrec imports = stack_name list
type nonrec list_imports_output = {
  1. next_token : next_token option;
    (*

    A string that identifies the next page of exports. If there is no additional page, this value is null.

    *)
  2. imports : imports option;
    (*

    A list of stack names that are importing the specified exported output value.

    *)
}
type nonrec list_imports_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. export_name : export_name;
    (*

    The name of the exported output value. CloudFormation returns the stack names that are importing this value.

    *)
}
type nonrec list_hook_results_target_type =
  1. | CLOUD_CONTROL
  2. | RESOURCE
  3. | STACK
  4. | CHANGE_SET
type nonrec hook_result_id = string
type nonrec hook_type_name = string
type nonrec hook_type_version_id = string
type nonrec hook_type_configuration_version_id = string
type nonrec hook_type_arn = string
type nonrec hook_result_summary = {
  1. hook_execution_target : hook_result_id option;
    (*

    The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.

    Only shown in responses when the request does not specify TargetType and TargetId filters.

    *)
  2. type_arn : hook_type_arn option;
    (*

    The ARN of the Hook that was invoked.

    *)
  3. target_id : hook_result_id option;
    (*

    The unique identifier of the Hook invocation target.

    *)
  4. target_type : list_hook_results_target_type option;
    (*

    The target type that the Hook was invoked against.

    *)
  5. invoked_at : timestamp option;
    (*

    The timestamp when the Hook was invoked.

    Only shown in responses when the request does not specify TargetType and TargetId filters.

    *)
  6. hook_status_reason : hook_status_reason option;
    (*

    A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.

    *)
  7. status : hook_status option;
    (*

    The status of the Hook invocation. The following statuses are possible:

    • HOOK_IN_PROGRESS: The Hook is currently running.
    • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
    • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
    • HOOK_FAILED: The Hook encountered an error during execution.
    *)
  8. type_configuration_version_id : hook_type_configuration_version_id option;
    (*

    The version of the Hook configuration.

    *)
  9. type_version_id : hook_type_version_id option;
    (*

    The version of the Hook that was invoked.

    *)
  10. type_name : hook_type_name option;
    (*

    The name of the Hook that was invoked.

    *)
  11. failure_mode : hook_failure_mode option;
    (*

    The failure mode of the invocation.

    *)
  12. invocation_point : hook_invocation_point option;
    (*

    The specific point in the provisioning process where the Hook is invoked.

    *)
  13. hook_result_id : hook_invocation_id option;
    (*

    The unique identifier for this Hook invocation result.

    *)
}

A ListHookResults call returns a summary of a Hook invocation.

type nonrec hook_result_summaries = hook_result_summary list
type nonrec list_hook_results_output = {
  1. next_token : next_token option;
    (*

    Pagination token, null or empty if no more results.

    *)
  2. hook_results : hook_result_summaries option;
    (*

    A list of HookResultSummary structures that provides the status and Hook status reason for each Hook invocation for the specified target.

    *)
  3. target_id : hook_result_id option;
    (*

    The unique identifier of the Hook invocation target.

    *)
  4. target_type : list_hook_results_target_type option;
    (*

    The target type.

    *)
}
type nonrec list_hook_results_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. status : hook_status option;
    (*

    Filters results by the status of Hook invocations. Can only be used in combination with TypeArn. Valid values are:

    • HOOK_IN_PROGRESS: The Hook is currently running.
    • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
    • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
    • HOOK_FAILED: The Hook encountered an error during execution.
    *)
  3. type_arn : hook_type_arn option;
    (*

    Filters results by the ARN of the Hook. Can be used alone or in combination with Status.

    *)
  4. target_id : hook_result_id option;
    (*

    Filters results by the unique identifier of the target the Hook was invoked against.

    For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the HookRequestToken returned by the Cloud Control API request. For more information on the HookRequestToken, see ProgressEvent.

    Required when TargetType is specified and cannot be used otherwise.

    *)
  5. target_type : list_hook_results_target_type option;
    (*

    Filters results by target type. Currently, only CHANGE_SET and CLOUD_CONTROL are supported filter options.

    Required when TargetId is specified and cannot be used otherwise.

    *)
}
type nonrec hook_result_not_found_exception = {
  1. message : error_message option;
}

The specified target doesn't have any requested Hook invocations.

type nonrec list_generated_templates_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

    *)
  2. summaries : template_summaries option;
    (*

    A list of summaries of the generated templates.

    *)
}
type nonrec list_generated_templates_input = {
  1. max_results : max_results option;
    (*

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
}
type nonrec export_value = string
type nonrec export_ = {
  1. value : export_value option;
    (*

    The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.

    *)
  2. name : export_name option;
    (*

    The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.

    *)
  3. exporting_stack_id : stack_id option;
    (*

    The stack that contains the exported output name and value.

    *)
}

The Export structure describes the exported output values for a stack.

For more information, see Get exported outputs from a deployed CloudFormation stack.

type nonrec exports = export_ list
type nonrec list_exports_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

    *)
  2. exports : exports option;
    (*

    The output for the ListExports action.

    *)
}
type nonrec list_exports_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
}
type nonrec change_set_name = string
type nonrec execution_status =
  1. | OBSOLETE
  2. | EXECUTE_FAILED
  3. | EXECUTE_COMPLETE
  4. | EXECUTE_IN_PROGRESS
  5. | AVAILABLE
  6. | UNAVAILABLE
type nonrec change_set_status =
  1. | FAILED
  2. | DELETE_FAILED
  3. | DELETE_COMPLETE
  4. | DELETE_IN_PROGRESS
  5. | DELETE_PENDING
  6. | CREATE_COMPLETE
  7. | CREATE_IN_PROGRESS
  8. | CREATE_PENDING
type nonrec change_set_status_reason = string
type nonrec include_nested_stacks = bool
type nonrec import_existing_resources = bool
type nonrec change_set_summary = {
  1. import_existing_resources : import_existing_resources option;
    (*

    Indicates if the change set imports resources that already exist.

    *)
  2. root_change_set_id : change_set_id option;
    (*

    The root change set ID.

    *)
  3. parent_change_set_id : change_set_id option;
    (*

    The parent change set ID.

    *)
  4. include_nested_stacks : include_nested_stacks option;
    (*

    Specifies the current setting of IncludeNestedStacks for the change set.

    *)
  5. description : description option;
    (*

    Descriptive information about the change set.

    *)
  6. creation_time : creation_time option;
    (*

    The start time when the change set was created, in UTC.

    *)
  7. status_reason : change_set_status_reason option;
    (*

    A description of the change set's status. For example, if your change set is in the FAILED state, CloudFormation shows the error message.

    *)
  8. status : change_set_status option;
    (*

    The state of the change set, such as CREATE_PENDING, CREATE_COMPLETE, or FAILED.

    *)
  9. execution_status : execution_status option;
    (*

    If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

    *)
  10. change_set_name : change_set_name option;
    (*

    The name of the change set.

    *)
  11. change_set_id : change_set_id option;
    (*

    The ID of the change set.

    *)
  12. stack_name : stack_name option;
    (*

    The name of the stack with which the change set is associated.

    *)
  13. stack_id : stack_id option;
    (*

    The ID of the stack with which the change set is associated.

    *)
}

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

type nonrec change_set_summaries = change_set_summary list
type nonrec list_change_sets_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

    *)
  2. summaries : change_set_summaries option;
    (*

    A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

    *)
}

The output for the ListChangeSets action.

type nonrec list_change_sets_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. stack_name : stack_name_or_id;
    (*

    The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

    *)
}

The input for the ListChangeSets action.

type nonrec limit_value = int
type nonrec limit_name = string
type nonrec invalid_change_set_status_exception = {
  1. message : error_message option;
}

The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.

type nonrec include_property_values = bool
type nonrec import_stacks_to_stack_set_output = {
  1. operation_id : client_request_token option;
    (*

    The unique identifier for the StackSet operation.

    *)
}
type nonrec import_stacks_to_stack_set_input = {
  1. call_as : call_as option;
    (*

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.
    • For service managed StackSets, specify DELEGATED_ADMIN.
    *)
  2. operation_id : client_request_token option;
    (*

    A unique, user defined, identifier for the StackSet operation.

    *)
  3. operation_preferences : stack_set_operation_preferences option;
    (*

    The user-specified preferences for how CloudFormation performs a StackSet operation.

    For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.

    *)
  4. organizational_unit_ids : organizational_unit_id_list option;
    (*

    The list of OU ID's to which the imported stacks must be mapped as deployment targets.

    *)
  5. stack_ids_url : stack_ids_url option;
    (*

    The Amazon S3 URL which contains list of stack ids to be inputted.

    Specify either StackIds or StackIdsUrl.

    *)
  6. stack_ids : stack_id_list option;
    (*

    The IDs of the stacks you are importing into a StackSet. You import up to 10 stacks per StackSet at a time.

    Specify either StackIds or StackIdsUrl.

    *)
  7. stack_set_name : stack_set_name_or_id;
    (*

    The name of the StackSet. The name must be unique in the Region where you create your StackSet.

    *)
}
type nonrec hook_target_type_name = string
type nonrec hook_target_type =
  1. | RESOURCE
type nonrec hook_target_id = string
type nonrec hook_target_action =
  1. | IMPORT
  2. | DELETE
  3. | UPDATE
  4. | CREATE
type nonrec hook_target = {
  1. action : hook_target_action;
    (*

    The action that invoked the Hook.

    *)
  2. target_id : hook_target_id;
    (*

    The unique identifier of the Hook invocation target.

    *)
  3. target_type_name : hook_target_type_name;
    (*

    The target name, for example, AWS::S3::Bucket.

    *)
  4. target_type : hook_target_type;
    (*

    The target type.

    *)
}

The HookTarget data type.

type nonrec hook_invocation_count = int
type nonrec get_template_summary_output = {
  1. warnings : warnings option;
    (*

    An object that contains any warnings returned.

    *)
  2. resource_identifier_summaries : resource_identifier_summaries option;
    (*

    A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

    *)
  3. declared_transforms : transforms_list option;
    (*

    A list of the transforms that are declared in the template.

    *)
  4. metadata : metadata option;
    (*

    The value that's defined for the Metadata property of the template.

    *)
  5. version : version option;
    (*

    The Amazon Web Services template format version, which identifies the capabilities of the template.

    *)
  6. resource_types : resource_types option;
    (*

    A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

    *)
  7. capabilities_reason : capabilities_reason option;
    (*

    The list of resources that generated the values in the Capabilities response element.

    *)
  8. capabilities : capabilities option;
    (*

    The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    *)
  9. description : description option;
    (*

    The value that's defined in the Description property of the template.

    *)
  10. parameters : parameter_declarations option;
    (*

    A list of parameter declarations that describe various properties for each parameter.

    *)
}

The output for the GetTemplateSummary action.

type nonrec get_template_summary_input = {
  1. template_summary_config : template_summary_config option;
    (*

    Specifies options for the GetTemplateSummary API action.

    *)
  2. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  3. stack_set_name : stack_set_name_or_id option;
    (*

    The name or unique ID of the StackSet from which the stack was created.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    *)
  4. stack_name : stack_name_or_id option;
    (*

    The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    *)
  5. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    *)
  6. template_body : template_body option;
    (*

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    *)
}

The input for the GetTemplateSummary action.

type nonrec get_template_output = {
  1. stages_available : stage_list option;
    (*

    The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

    *)
  2. template_body : template_body option;
    (*

    Structure that contains the template body.

    CloudFormation returns the same template that was used when the stack was created.

    *)
}

The output for GetTemplate action.

type nonrec change_set_name_or_id = string
type nonrec get_template_input = {
  1. template_stage : template_stage option;
    (*

    For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

    If the template doesn't include transforms, Original and Processed return the same template. By default, CloudFormation specifies Processed.

    *)
  2. change_set_name : change_set_name_or_id option;
    (*

    The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

    *)
  3. stack_name : stack_name option;
    (*

    The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.
    *)
}

The input for a GetTemplate action.

type nonrec change_set_not_found_exception = {
  1. message : error_message option;
}

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.

type nonrec get_stack_policy_output = {
  1. stack_policy_body : stack_policy_body option;
    (*

    Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.

    *)
}

The output for the GetStackPolicy action.

type nonrec get_stack_policy_input = {
  1. stack_name : stack_name;
    (*

    The name or unique stack ID that's associated with the stack whose policy you want to get.

    *)
}

The input for the GetStackPolicy action.

type nonrec annotation_name = string
type nonrec annotation_status =
  1. | SKIPPED
  2. | FAILED
  3. | PASSED
type nonrec annotation_severity_level =
  1. | CRITICAL
  2. | HIGH
  3. | MEDIUM
  4. | LOW
  5. | INFORMATIONAL
type nonrec annotation = {
  1. severity_level : annotation_severity_level option;
    (*

    The relative risk associated with any violations of this type.

    *)
  2. remediation_message : remediation_message_remediation_message option;
    (*

    Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".

    *)
  3. status_message : remediation_message_status_message option;
    (*

    The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".

    *)
  4. status : annotation_status option;
    (*

    The status of the Hook invocation from the downstream service.

    *)
  5. annotation_name : annotation_name option;
    (*

    An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.

    *)
}

The Annotation data type.

A GetHookResult call returns detailed information and remediation guidance from Control Tower, Guard, Lambda, or custom Hooks for a Hook invocation result.

type nonrec annotation_list = annotation list
type nonrec get_hook_result_output = {
  1. annotations : annotation_list option;
    (*

    A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.

    *)
  2. target : hook_target option;
    (*

    Information about the target of the Hook invocation.

    *)
  3. invoked_at : timestamp option;
    (*

    The timestamp when the Hook was invoked.

    *)
  4. hook_status_reason : hook_status_reason option;
    (*

    A message that provides additional details about the Hook invocation status.

    *)
  5. status : hook_status option;
    (*

    The status of the Hook invocation. The following statuses are possible:

    • HOOK_IN_PROGRESS: The Hook is currently running.
    • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
    • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
    • HOOK_FAILED: The Hook encountered an error during execution.
    *)
  6. type_arn : hook_type_arn option;
    (*

    The Amazon Resource Name (ARN) of the Hook.

    *)
  7. type_configuration_version_id : hook_type_configuration_version_id option;
    (*

    The version identifier of the Hook configuration data that was used during invocation.

    *)
  8. type_version_id : hook_type_version_id option;
    (*

    The version identifier of the Hook that was invoked.

    *)
  9. original_type_name : hook_type_name option;
    (*

    The original public type name of the Hook when an alias is used.

    For example, if you activate AWS::Hooks::GuardHook with alias MyCompany::Custom::GuardHook, then TypeName will be MyCompany::Custom::GuardHook and OriginalTypeName will be AWS::Hooks::GuardHook.

    *)
  10. type_name : hook_type_name option;
    (*

    The name of the Hook that was invoked.

    *)
  11. failure_mode : hook_failure_mode option;
    (*

    The failure mode of the invocation.

    *)
  12. invocation_point : hook_invocation_point option;
    (*

    The specific point in the provisioning process where the Hook is invoked.

    *)
  13. hook_result_id : hook_invocation_id option;
    (*

    The unique identifier of the Hook result.

    *)
}
type nonrec get_hook_result_input = {
  1. hook_result_id : hook_invocation_id option;
    (*

    The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the ListHookResults operation.

    *)
}
type nonrec get_generated_template_output = {
  1. template_body : template_body option;
    (*

    The template body of the generated template, in the language specified by the Language parameter.

    *)
  2. status : generated_template_status option;
    (*

    The status of the template generation. Supported values are:

    • CreatePending - the creation of the template is pending.
    • CreateInProgress - the creation of the template is in progress.
    • DeletePending - the deletion of the template is pending.
    • DeleteInProgress - the deletion of the template is in progress.
    • UpdatePending - the update of the template is pending.
    • UpdateInProgress - the update of the template is in progress.
    • Failed - the template operation failed.
    • Complete - the template operation is complete.
    *)
}
type nonrec get_generated_template_input = {
  1. generated_template_name : generated_template_name;
    (*

    The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,

    arn:aws:cloudformation:{i us-east-1}:{i 123456789012}:generatedtemplate/{i 2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc}

    .

    *)
  2. format : template_format option;
    (*

    The language to use to retrieve for the generated template. Supported values are:

    • JSON
    • YAML
    *)
}
type nonrec failed_events_filter = bool
type nonrec execute_stack_refactor_input = {
  1. stack_refactor_id : stack_refactor_id;
    (*

    The ID associated with the stack refactor created from the CreateStackRefactor action.

    *)
}
type nonrec execute_change_set_output = unit
type nonrec execute_change_set_input = {
  1. retain_except_on_create : retain_except_on_create option;
    (*

    When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

    Default: false

    *)
  2. disable_rollback : disable_rollback option;
    (*

    Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

    • True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
    • False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

    Default: True

    *)
  3. client_request_token : client_request_token option;
    (*

    A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

    *)
  4. stack_name : stack_name_or_id option;
    (*

    If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.

    *)
  5. change_set_name : change_set_name_or_id;
    (*

    The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

    *)
}

The input for the ExecuteChangeSet action.

type nonrec event_filter = {
  1. failed_events : failed_events_filter option;
    (*

    When set to true, only returns failed events within the operation. This helps quickly identify root causes for a failed operation.

    *)
}

Event filter allows you to focus on specific events in an operation.

type nonrec estimate_template_cost_output = {
  1. url : url option;
    (*

    An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

    *)
}

The output for a EstimateTemplateCost action.

type nonrec estimate_template_cost_input = {
  1. parameters : parameters option;
    (*

    A list of Parameter structures that specify input parameters.

    *)
  2. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    *)
  3. template_body : template_body option;
    (*

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

    *)
}

The input for an EstimateTemplateCost action.

type nonrec error_code = string
type nonrec enable_stack_creation = bool
type nonrec detect_stack_set_drift_output = {
  1. operation_id : client_request_token option;
    (*

    The ID of the drift detection StackSet operation.

    You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

    *)
}
type nonrec detect_stack_set_drift_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token option;
    (*

    The ID of the StackSet operation.

    *)
  3. operation_preferences : stack_set_operation_preferences option;
    (*

    The user-specified preferences for how CloudFormation performs a StackSet operation.

    For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.

    *)
  4. stack_set_name : stack_set_name_or_id;
    (*

    The name of the StackSet on which to perform the drift detection operation.

    *)
}
type nonrec detect_stack_resource_drift_output = {
  1. stack_resource_drift : stack_resource_drift;
    (*

    Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

    *)
}
type nonrec detect_stack_resource_drift_input = {
  1. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource for which to return drift information.

    *)
  2. stack_name : stack_name_or_id;
    (*

    The name of the stack to which the resource belongs.

    *)
}
type nonrec detect_stack_drift_output = {
  1. stack_drift_detection_id : stack_drift_detection_id;
    (*

    The ID of the drift detection results of this operation.

    CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

    *)
}
type nonrec detect_stack_drift_input = {
  1. logical_resource_ids : logical_resource_ids option;
    (*

    The logical names of any resources you want to use as filters.

    *)
  2. stack_name : stack_name_or_id;
    (*

    The name of the stack for which you want to detect drift.

    *)
}
type nonrec describe_type_registration_output = {
  1. type_version_arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of this specific version of the extension being registered.

    For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

    *)
  2. type_arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension being registered.

    For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

    *)
  3. description : description option;
    (*

    The description of the extension registration request.

    *)
  4. progress_status : registration_status option;
    (*

    The current status of the extension registration request.

    *)
}
type nonrec describe_type_registration_input = {
  1. registration_token : registration_token;
    (*

    The identifier for this registration request.

    This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.

    *)
}
type nonrec configuration_schema = string
type nonrec auto_update = bool
type nonrec describe_type_output = {
  1. auto_update : auto_update option;
    (*

    Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.

    *)
  2. is_activated : is_activated option;
    (*

    Whether the extension is activated in the account and Region.

    This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

    *)
  3. latest_public_version : public_version_number option;
    (*

    The latest version of a public extension that is available for use.

    This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null.

    *)
  4. public_version_number : public_version_number option;
    (*

    The version number of a public third-party extension.

    This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

    *)
  5. original_type_arn : type_arn option;
    (*

    For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

    *)
  6. original_type_name : type_name option;
    (*

    For public extensions that have been activated for this account and Region, the type name of the public extension.

    If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.

    *)
  7. publisher_id : publisher_id option;
    (*

    The publisher ID of the extension publisher.

    This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

    *)
  8. configuration_schema : configuration_schema option;
    (*

    A JSON string that represent the current configuration data for the extension in this account and Region.

    To set the configuration data for an extension, use SetTypeConfiguration.

    *)
  9. time_created : timestamp option;
    (*

    When the specified private extension version was registered or activated in your account.

    *)
  10. last_updated : timestamp option;
    (*

    When the specified extension version was registered. This applies only to:

    • Private extensions you have registered in your account. For more information, see RegisterType.
    • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
    *)
  11. documentation_url : optional_secure_url option;
    (*

    The URL of a page providing detailed documentation for this extension.

    *)
  12. source_url : optional_secure_url option;
    (*

    The URL of the source code for the extension.

    *)
  13. visibility : visibility option;
    (*

    The scope at which the extension is visible and usable in CloudFormation operations.

    Valid values include:

    • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.
    • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.
    *)
  14. execution_role_arn : role_ar_n2 option;
    (*

    The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

    If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

    *)
  15. required_activated_types : required_activated_types option;
    (*

    For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

    *)
  16. logging_config : logging_config option;
    (*

    Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

    *)
  17. deprecated_status : deprecated_status option;
    (*

    The deprecation status of the extension version.

    Valid values include:

    • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
    • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

    For public third-party extensions, CloudFormation returns null.

    *)
  18. provisioning_type : provisioning_type option;
    (*

    For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

    Valid values include:

    • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.
    • IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.

    • NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.

      • create
      • read
      • delete
    *)
  19. schema : type_schema option;
    (*

    The schema that defines the extension.

    For more information, see Resource type schema in the CloudFormation Command Line Interface (CLI) User Guide and the CloudFormation Hooks User Guide.

    *)
  20. description : description option;
    (*

    The description of the extension.

    *)
  21. type_tests_status_description : type_tests_status_description option;
    (*

    The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

    This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

    *)
  22. type_tests_status : type_tests_status option;
    (*

    The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

    This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.

    • PASSED: The extension has passed all its contract tests.

      An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

    • FAILED: The extension has failed one or more contract tests.
    • IN_PROGRESS: Contract tests are currently being performed on the extension.
    • NOT_TESTED: Contract tests haven't been performed on the extension.
    *)
  23. is_default_version : is_default_version option;
    (*

    Whether the specified extension version is set as the default version.

    This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

    *)
  24. default_version_id : type_version_id option;
    (*

    The ID of the default version of the extension. The default version is used when the extension version isn't specified.

    This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

    To set the default version of an extension, use SetTypeDefaultVersion.

    *)
  25. type_name : type_name option;
    (*

    The name of the extension.

    If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

    *)
  26. type_ : registry_type option;
    (*

    The kind of extension.

    *)
  27. arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    *)
}
type nonrec describe_type_input = {
  1. public_version_number : public_version_number option;
    (*

    The version number of a public third-party extension.

    *)
  2. publisher_id : publisher_id option;
    (*

    The publisher ID of the extension publisher.

    Extensions provided by Amazon Web Services are not assigned a publisher ID.

    *)
  3. version_id : type_version_id option;
    (*

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

    If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

    *)
  4. arn : type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  5. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  6. type_ : registry_type option;
    (*

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
}
type nonrec describe_stacks_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

    *)
  2. stacks : stacks option;
    (*

    A list of stack structures.

    *)
}

The output for a DescribeStacks action.

type nonrec describe_stacks_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. stack_name : stack_name option;
    (*

    If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.

    Consider using the ListStacks API if you're not passing a parameter to StackName.

    The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

    { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

    The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.
    *)
}

The input for DescribeStacks action.

type nonrec describe_stack_set_output = {
  1. stack_set : stack_set option;
    (*

    The specified StackSet.

    *)
}
type nonrec describe_stack_set_operation_output = {
  1. stack_set_operation : stack_set_operation option;
    (*

    The specified StackSet operation.

    *)
}
type nonrec describe_stack_set_operation_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token;
    (*

    The unique ID of the StackSet operation.

    *)
  3. stack_set_name : stack_set_name;
    (*

    The name or the unique stack ID of the StackSet for the stack operation.

    *)
}
type nonrec describe_stack_set_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet whose description you want.

    *)
}
type nonrec describe_stack_resources_output = {
  1. stack_resources : stack_resources option;
    (*

    A list of StackResource structures.

    *)
}

The output for a DescribeStackResources action.

type nonrec describe_stack_resources_input = {
  1. physical_resource_id : physical_resource_id option;
    (*

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

    Required: Conditional. If you don't specify PhysicalResourceId, you must specify StackName.

    *)
  2. logical_resource_id : logical_resource_id option;
    (*

    The logical name of the resource as specified in the template.

    *)
  3. stack_name : stack_name option;
    (*

    The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.

    Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.

    *)
}

The input for DescribeStackResources action.

type nonrec describe_stack_resource_output = {
  1. stack_resource_detail : stack_resource_detail option;
    (*

    A StackResourceDetail structure that contains the description of the specified resource in the specified stack.

    *)
}

The output for a DescribeStackResource action.

type nonrec describe_stack_resource_input = {
  1. logical_resource_id : logical_resource_id;
    (*

    The logical name of the resource as specified in the template.

    *)
  2. stack_name : stack_name;
    (*

    The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.
    *)
}

The input for DescribeStackResource action.

type nonrec describe_stack_resource_drifts_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. stack_resource_drifts : stack_resource_drifts;
    (*

    Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

    For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

    *)
}
type nonrec describe_stack_resource_drifts_input = {
  1. max_results : boxed_max_results option;
    (*

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  3. stack_resource_drift_status_filters : stack_resource_drift_status_filters option;
    (*

    The resource drift status values to use as filters for the resource drift results returned.

    • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
    • MODIFIED: One or more resource properties differ from their expected template values.
    • IN_SYNC: The resource's actual configuration matches its expected template configuration.
    • NOT_CHECKED: CloudFormation doesn't currently return this value.
    • UNKNOWN: CloudFormation could not run drift detection for the resource.
    *)
  4. stack_name : stack_name_or_id;
    (*

    The name of the stack for which you want drift information.

    *)
}
type nonrec describe_stack_refactor_output = {
  1. status_reason : stack_refactor_status_reason option;
    (*

    A detailed explanation for the stack refactor operation Status.

    *)
  2. status : stack_refactor_status option;
    (*

    The stack refactor operation status that's provided after calling the CreateStackRefactor action.

    *)
  3. execution_status_reason : execution_status_reason option;
    (*

    A detailed explanation for the stack refactor ExecutionStatus.

    *)
  4. execution_status : stack_refactor_execution_status option;
    (*

    The stack refactor execution operation status that's provided after calling the ExecuteStackRefactor action.

    *)
  5. stack_ids : stack_ids option;
    (*

    The unique ID for each stack.

    *)
  6. stack_refactor_id : stack_refactor_id option;
    (*

    The ID associated with the stack refactor created from the CreateStackRefactor action.

    *)
  7. description : description option;
    (*

    A description to help you identify the refactor.

    *)
}
type nonrec describe_stack_refactor_input = {
  1. stack_refactor_id : stack_refactor_id;
    (*

    The ID associated with the stack refactor created from the CreateStackRefactor action.

    *)
}
type nonrec describe_stack_instance_output = {
  1. stack_instance : stack_instance option;
    (*

    The stack instance that matches the specified request parameters.

    *)
}
type nonrec describe_stack_instance_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. stack_instance_region : region;
    (*

    The name of a Region that's associated with this stack instance.

    *)
  3. stack_instance_account : account;
    (*

    The ID of an Amazon Web Services account that's associated with this stack instance.

    *)
  4. stack_set_name : stack_set_name;
    (*

    The name or the unique stack ID of the StackSet that you want to get stack instance information for.

    *)
}
type nonrec describe_stack_events_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

    *)
  2. stack_events : stack_events option;
    (*

    A list of StackEvents structures.

    *)
}

The output for a DescribeStackEvents action.

type nonrec describe_stack_events_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. stack_name : stack_name;
    (*

    The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.
    *)
}

The input for DescribeStackEvents action.

type nonrec boxed_integer = int
type nonrec describe_stack_drift_detection_status_output = {
  1. timestamp : timestamp;
    (*

    Time at which the stack drift detection operation was initiated.

    *)
  2. drifted_stack_resource_count : boxed_integer option;
    (*

    Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

    *)
  3. detection_status_reason : stack_drift_detection_status_reason option;
    (*

    The reason the stack drift detection operation has its current status.

    *)
  4. detection_status : stack_drift_detection_status;
    (*

    The status of the stack drift detection operation.

    • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

      If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

    • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
    • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
    *)
  5. stack_drift_status : stack_drift_status option;
    (*

    Status of the stack's actual configuration compared to its expected configuration.

    • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.
    • IN_SYNC: The stack's actual configuration matches its expected template configuration.
    • UNKNOWN: CloudFormation could not run drift detection for a resource in the stack. See the DetectionStatusReason for details.
    *)
  6. stack_drift_detection_id : stack_drift_detection_id;
    (*

    The ID of the drift detection results of this operation.

    CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

    *)
  7. stack_id : stack_id;
    (*

    The ID of the stack.

    *)
}
type nonrec describe_stack_drift_detection_status_input = {
  1. stack_drift_detection_id : stack_drift_detection_id;
    (*

    The ID of the drift detection results of this operation.

    CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

    *)
}
type nonrec describe_resource_scan_output = {
  1. scan_filters : scan_filters option;
    (*

    The scan filters that were used.

    *)
  2. resources_read : resources_read option;
    (*

    The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED.

    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

    *)
  3. resources_scanned : resources_scanned option;
    (*

    The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

    *)
  4. resource_types : resource_types option;
    (*

    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

    *)
  5. percentage_completed : percentage_completed option;
    (*

    The percentage of the resource scan that has been completed.

    *)
  6. end_time : timestamp option;
    (*

    The time that the resource scan was finished.

    *)
  7. start_time : timestamp option;
    (*

    The time that the resource scan was started.

    *)
  8. status_reason : resource_scan_status_reason option;
    (*

    The reason for the resource scan status, providing more information if a failure happened.

    *)
  9. status : resource_scan_status option;
    (*

    Status of the resource scan.

    IN_PROGRESS The resource scan is still in progress.

    COMPLETE The resource scan is complete.

    EXPIRED The resource scan has expired.

    FAILED The resource scan has failed.

    *)
  10. resource_scan_id : resource_scan_id option;
    (*

    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is

    arn:aws:cloudformation:{i us-east-1}:{i 123456789012}:resourceScan/{i f5b490f7-7ed4-428a-aa06-31ff25db0772}

    .

    *)
}
type nonrec describe_resource_scan_input = {
  1. resource_scan_id : resource_scan_id;
    (*

    The Amazon Resource Name (ARN) of the resource scan.

    *)
}
type nonrec describe_publisher_output = {
  1. publisher_profile : publisher_profile option;
    (*

    The URL to the publisher's profile with the identity provider.

    *)
  2. identity_provider : identity_provider option;
    (*

    The type of account used as the identity provider when registering this publisher with CloudFormation.

    *)
  3. publisher_status : publisher_status option;
    (*

    Whether the publisher is verified. Currently, all registered publishers are verified.

    *)
  4. publisher_id : publisher_id option;
    (*

    The ID of the extension publisher.

    *)
}
type nonrec describe_publisher_input = {
  1. publisher_id : publisher_id option;
    (*

    The ID of the extension publisher.

    If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

    *)
}
type nonrec describe_organizations_access_output = {
  1. status : organization_status option;
    (*

    Presents the status of the OrganizationAccess.

    *)
}
type nonrec describe_organizations_access_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
}
type nonrec describe_generated_template_output = {
  1. total_warnings : total_warnings option;
    (*

    The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

    *)
  2. template_configuration : template_configuration option;
    (*

    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

    *)
  3. stack_id : stack_id option;
    (*

    The stack ARN of the base stack if a base stack was provided when generating the template.

    *)
  4. progress : template_progress option;
    (*

    An object describing the progress of the template generation.

    *)
  5. last_updated_time : last_updated_time option;
    (*

    The time the generated template was last updated.

    *)
  6. creation_time : creation_time option;
    (*

    The time the generated template was created.

    *)
  7. status_reason : template_status_reason option;
    (*

    The reason for the current template generation status. This will provide more details if a failure happened.

    *)
  8. status : generated_template_status option;
    (*

    The status of the template generation. Supported values are:

    • CreatePending - the creation of the template is pending.
    • CreateInProgress - the creation of the template is in progress.
    • DeletePending - the deletion of the template is pending.
    • DeleteInProgress - the deletion of the template is in progress.
    • UpdatePending - the update of the template is pending.
    • UpdateInProgress - the update of the template is in progress.
    • Failed - the template operation failed.
    • Complete - the template operation is complete.
    *)
  9. resources : resource_details option;
    (*

    A list of objects describing the details of the resources in the template generation.

    *)
  10. generated_template_name : generated_template_name option;
    (*

    The name of the generated template.

    *)
  11. generated_template_id : generated_template_id option;
    (*

    The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,

    arn:aws:cloudformation:{i us-east-1}:{i 123456789012}:generatedtemplate/{i 2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc}

    .

    *)
}
type nonrec describe_generated_template_input = {
  1. generated_template_name : generated_template_name;
    (*

    The name or Amazon Resource Name (ARN) of a generated template.

    *)
}
type nonrec describe_events_output = {
  1. next_token : next_token option;
    (*

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeEvents again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

    *)
  2. operation_events : operation_events option;
    (*

    A list of operation events that match the specified criteria.

    *)
}
type nonrec describe_events_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  2. filters : event_filter option;
    (*

    Filters to apply when retrieving events.

    *)
  3. operation_id : operation_id option;
    (*

    The unique identifier of the operation for which you want to retrieve events.

    *)
  4. change_set_name : change_set_name_or_id option;
    (*

    The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.

    *)
  5. stack_name : stack_name_or_id option;
    (*

    The name or unique stack ID for which you want to retrieve events. If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

    *)
}
type nonrec change_type =
  1. | Resource
type nonrec change = {
  1. resource_change : resource_change option;
    (*

    A ResourceChange structure that describes the resource and action that CloudFormation will perform.

    *)
  2. hook_invocation_count : hook_invocation_count option;
    (*

    Is either null, if no Hooks invoke for the resource, or contains the number of Hooks that will invoke for the resource.

    *)
  3. type_ : change_type option;
    (*

    The type of entity that CloudFormation changes.

    • Resource This change is for a resource.
    *)
}

The Change structure describes the changes CloudFormation will perform if you execute the change set.

type nonrec changes = change list
type nonrec deployment_mode =
  1. | REVERT_DRIFT
type nonrec describe_change_set_output = {
  1. deployment_config : deployment_config option;
    (*

    The deployment configuration specified when the change set was created.

    *)
  2. deployment_mode : deployment_mode option;
    (*

    The deployment mode specified when the change set was created. Valid value is REVERT_DRIFT. Only present for drift-aware change sets.

    *)
  3. import_existing_resources : import_existing_resources option;
    (*

    Indicates if the change set imports resources that already exist.

    This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

    *)
  4. on_stack_failure : on_stack_failure option;
    (*

    Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

    • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
    • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
    • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
    *)
  5. root_change_set_id : change_set_id option;
    (*

    Specifies the change set ID of the root change set in the current nested change set hierarchy.

    *)
  6. parent_change_set_id : change_set_id option;
    (*

    Specifies the change set ID of the parent change set in the current nested change set hierarchy.

    *)
  7. include_nested_stacks : include_nested_stacks option;
    (*

    Verifies if IncludeNestedStacks is set to True.

    *)
  8. next_token : next_token option;
    (*

    If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

    *)
  9. changes : changes option;
    (*

    A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

    *)
  10. tags : tags option;
    (*

    If you execute the change set, the tags that will be associated with the stack.

    *)
  11. capabilities : capabilities option;
    (*

    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

    *)
  12. rollback_configuration : rollback_configuration option;
    (*

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

    *)
  13. notification_ar_ns : notification_ar_ns option;
    (*

    The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.

    *)
  14. stack_drift_status : stack_drift_status option;
    (*

    The drift status of the stack when the change set was created. Valid values:

    • DRIFTED – The stack has drifted from its last deployment.
    • IN_SYNC – The stack is in sync with its last deployment.
    • NOT_CHECKED – CloudFormation doesn’t currently return this value.
    • UNKNOWN – The drift status could not be determined.

    Only present for drift-aware change sets.

    *)
  15. status_reason : change_set_status_reason option;
    (*

    A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

    *)
  16. status : change_set_status option;
    (*

    The current status of the change set, such as CREATE_PENDING, CREATE_COMPLETE, or FAILED.

    *)
  17. execution_status : execution_status option;
    (*

    If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

    *)
  18. creation_time : creation_time option;
    (*

    The start time when the change set was created, in UTC.

    *)
  19. parameters : parameters option;
    (*

    A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

    *)
  20. description : description option;
    (*

    Information about the change set.

    *)
  21. stack_name : stack_name option;
    (*

    The name of the stack that's associated with the change set.

    *)
  22. stack_id : stack_id option;
    (*

    The Amazon Resource Name (ARN) of the stack that's associated with the change set.

    *)
  23. change_set_id : change_set_id option;
    (*

    The Amazon Resource Name (ARN) of the change set.

    *)
  24. change_set_name : change_set_name option;
    (*

    The name of the change set.

    *)
}

The output for the DescribeChangeSet action.

type nonrec describe_change_set_input = {
  1. include_property_values : include_property_values option;
    (*

    If true, the returned changes include detailed changes in the property values.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  3. stack_name : stack_name_or_id option;
    (*

    If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

    *)
  4. change_set_name : change_set_name_or_id;
    (*

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    *)
}

The input for the DescribeChangeSet action.

type nonrec change_set_hook_resource_target_details = {
  1. resource_action : change_action option;
    (*

    Specifies the action of the resource.

    *)
  2. resource_type : hook_target_type_name option;
    (*

    The type of CloudFormation resource, such as AWS::S3::Bucket.

    *)
  3. logical_resource_id : logical_resource_id option;
    (*

    The resource's logical ID, which is defined in the stack's template.

    *)
}

Specifies RESOURCE type target details for activated Hooks.

type nonrec change_set_hook_target_details = {
  1. resource_target_details : change_set_hook_resource_target_details option;
    (*

    Required if TargetType is RESOURCE.

    *)
  2. target_type : hook_target_type option;
    (*

    The Hook target type.

    *)
}

Specifies target details for an activated Hook.

type nonrec change_set_hook = {
  1. target_details : change_set_hook_target_details option;
    (*

    Specifies details about the target that the Hook will run against.

    *)
  2. type_configuration_version_id : hook_type_configuration_version_id option;
    (*

    The version ID of the type configuration.

    *)
  3. type_version_id : hook_type_version_id option;
    (*

    The version ID of the type specified.

    *)
  4. type_name : hook_type_name option;
    (*

    The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of Organization::Service::Hook.

    The following organization namespaces are reserved and can't be used in your Hook type names:

    • Alexa
    • AMZN
    • Amazon
    • ASK
    • AWS
    • Custom
    • Dev
    *)
  5. failure_mode : hook_failure_mode option;
    (*

    Specify the Hook failure mode for non-compliant resources in the followings ways.

    • FAIL Stops provisioning resources.
    • WARN Allows provisioning to continue with a warning message.
    *)
  6. invocation_point : hook_invocation_point option;
    (*

    The specific point in the provisioning process where the Hook is invoked.

    *)
}

Specifies the resource, the Hook, and the Hook version to be invoked.

type nonrec change_set_hooks = change_set_hook list
type nonrec change_set_hooks_status =
  1. | UNAVAILABLE
  2. | PLANNED
  3. | PLANNING
type nonrec describe_change_set_hooks_output = {
  1. stack_name : stack_name option;
    (*

    The stack name.

    *)
  2. stack_id : stack_id option;
    (*

    The stack identifier (stack ID).

    *)
  3. next_token : next_token option;
    (*

    Pagination token, null or empty if no more results.

    *)
  4. status : change_set_hooks_status option;
    (*

    Provides the status of the change set Hook.

    *)
  5. hooks : change_set_hooks option;
    (*

    List of Hook objects.

    *)
  6. change_set_name : change_set_name option;
    (*

    The change set name.

    *)
  7. change_set_id : change_set_id option;
    (*

    The change set identifier (stack ID).

    *)
}
type nonrec describe_change_set_hooks_input = {
  1. logical_resource_id : logical_resource_id option;
    (*

    If specified, lists only the Hooks related to the specified LogicalResourceId.

    *)
  2. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
  3. stack_name : stack_name_or_id option;
    (*

    If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

    *)
  4. change_set_name : change_set_name_or_id;
    (*

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    *)
}
type nonrec account_limit = {
  1. value : limit_value option;
    (*

    The value that's associated with the account limit name.

    *)
  2. name : limit_name option;
    (*

    The name of the account limit.

    Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit

    *)
}

Describes the current CloudFormation limits for your account.

CloudFormation has the following limits per account:

  • Number of concurrent resources
  • Number of stacks
  • Number of stack outputs

For more information, see Understand CloudFormation quotas in the CloudFormation User Guide.

type nonrec account_limit_list = account_limit list
type nonrec describe_account_limits_output = {
  1. next_token : next_token option;
    (*

    If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

    *)
  2. account_limits : account_limit_list option;
    (*

    An account limit structure that contain a list of CloudFormation account limits and their values.

    *)
}

The output for the DescribeAccountLimits action.

type nonrec describe_account_limits_input = {
  1. next_token : next_token option;
    (*

    The token for the next set of items to return. (You received this token from a previous call.)

    *)
}

The input for the DescribeAccountLimits action.

type nonrec deregister_type_output = unit
type nonrec deregister_type_input = {
  1. version_id : type_version_id option;
    (*

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

    *)
  2. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  3. type_ : registry_type option;
    (*

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
  4. arn : private_type_arn option;
    (*

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    *)
}
type nonrec delete_stack_set_output = unit
type nonrec delete_stack_set_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you're deleting. You can obtain this value by running ListStackSets.

    *)
}
type nonrec delete_stack_instances_output = {
  1. operation_id : client_request_token option;
    (*

    The unique identifier for this StackSet operation.

    *)
}
type nonrec delete_stack_instances_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token option;
    (*

    The unique identifier for this StackSet operation.

    If you don't specify an operation ID, the SDK generates one automatically.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

    Repeating this StackSet operation with a new operation ID retries all stack instances whose status is OUTDATED.

    *)
  3. retain_stacks : retain_stacks;
    (*

    Removes the stack instances from the specified StackSet, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

    For more information, see StackSet operation options.

    *)
  4. operation_preferences : stack_set_operation_preferences option;
    (*

    Preferences for how CloudFormation performs this StackSet operation.

    *)
  5. regions : region_list;
    (*

    The Amazon Web Services Regions where you want to delete StackSet instances.

    *)
  6. deployment_targets : deployment_targets option;
    (*

    [Service-managed permissions] The Organizations accounts from which to delete stack instances.

    You can specify Accounts or DeploymentTargets, but not both.

    *)
  7. accounts : account_list option;
    (*

    [Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.

    You can specify Accounts or DeploymentTargets, but not both.

    *)
  8. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to delete stack instances for.

    *)
}
type nonrec delete_stack_input = {
  1. deployment_config : deployment_config option;
    (*

    The deployment configuration for this stack operation, including the deployment mode.

    *)
  2. deletion_mode : deletion_mode option;
    (*

    Specifies the deletion mode for the stack. Possible values are:

    • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    *)
  3. client_request_token : client_request_token option;
    (*

    A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that CloudFormation successfully received them.

    All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

    In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

    *)
  4. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

    If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

    *)
  5. retain_resources : retain_resources option;
    (*

    For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.

    Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

    *)
  6. stack_name : stack_name;
    (*

    The name or the unique stack ID that's associated with the stack.

    *)
}

The input for DeleteStack action.

type nonrec delete_generated_template_input = {
  1. generated_template_name : generated_template_name;
    (*

    The name or Amazon Resource Name (ARN) of a generated template.

    *)
}
type nonrec concurrent_resources_limit_exceeded_exception = {
  1. message : error_message option;
}

No more than 5 generated templates can be in an InProgress or Pending status at one time. This error is also returned if a generated template that is in an InProgress or Pending status is attempted to be updated or deleted.

type nonrec delete_change_set_output = unit
type nonrec delete_change_set_input = {
  1. stack_name : stack_name_or_id option;
    (*

    If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's associated with it.

    *)
  2. change_set_name : change_set_name_or_id;
    (*

    The name or Amazon Resource Name (ARN) of the change set that you want to delete.

    *)
}

The input for the DeleteChangeSet action.

type nonrec deactivate_type_output = unit
type nonrec deactivate_type_input = {
  1. arn : private_type_arn option;
    (*

    The Amazon Resource Name (ARN) for the extension in this account and Region.

    Conditional: You must specify either Arn, or TypeName and Type.

    *)
  2. type_ : third_party_type option;
    (*

    The extension type.

    Conditional: You must specify either Arn, or TypeName and Type.

    *)
  3. type_name : type_name option;
    (*

    The type name of the extension in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.

    Conditional: You must specify either Arn, or TypeName and Type.

    *)
}
type nonrec deactivate_organizations_access_output = unit
type nonrec deactivate_organizations_access_input = unit
type nonrec created_but_modified_exception = {
  1. message : error_message option;
}

The specified resource exists, but has been changed.

type nonrec create_stack_set_output = {
  1. stack_set_id : stack_set_id option;
    (*

    The ID of the StackSet that you're creating.

    *)
}
type nonrec create_stack_set_input = {
  1. managed_execution : managed_execution option;
    (*

    Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.

    *)
  2. client_request_token : client_request_token option;
    (*

    A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another StackSet with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

    If you don't specify an operation ID, the SDK generates one automatically.

    *)
  3. call_as : call_as option;
    (*

    Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • To create a StackSet with service-managed permissions while signed in to the management account, specify SELF.

    • To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.

    Valid only if the permissions model is SERVICE_MANAGED.

    *)
  4. auto_deployment : auto_deployment option;
    (*

    Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide.

    Required if the permissions model is SERVICE_MANAGED. (Not used with self-managed permissions.)

    *)
  5. permission_model : permission_models option;
    (*

    Describes how the IAM roles required for StackSet operations are created. By default, SELF-MANAGED is specified.

    *)
  6. execution_role_name : execution_role_name option;
    (*

    The name of the IAM execution role to use to create the StackSet. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.

    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.

    Valid only if the permissions model is SELF_MANAGED.

    *)
  7. administration_role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of the IAM role to use to create this StackSet.

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

    Valid only if the permissions model is SELF_MANAGED.

    *)
  8. tags : tags option;
    (*

    The key-value pairs to associate with this StackSet and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

    If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the StackSet is not created.

    *)
  9. capabilities : capabilities option;
    (*

    In some cases, you must explicitly acknowledge that your StackSet template contains certain capabilities in order for CloudFormation to create the StackSet and related stack instances.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those StackSets, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

      • If you have IAM resources, you can specify either capability.
      • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

      For more information, see Acknowledging IAM resources in CloudFormation templates.

    • CAPABILITY_AUTO_EXPAND

      Some templates reference macros. If your StackSet template references one or more macros, you must create the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To create the StackSet directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros.

      StackSets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.

    *)
  10. parameters : parameters option;
    (*

    The input parameters for the StackSet template.

    *)
  11. stack_id : stack_id option;
    (*

    The stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN) of the stack.

    *)
  12. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. S3 static website URLs are not supported.

    Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    *)
  13. template_body : template_body option;
    (*

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    *)
  14. description : description option;
    (*

    A description of the StackSet. You can use the description to identify the StackSet's purpose or other important information.

    *)
  15. stack_set_name : stack_set_name;
    (*

    The name to associate with the StackSet. The name must be unique in the Region where you create your StackSet.

    A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

    *)
}
type nonrec create_stack_refactor_output = {
  1. stack_refactor_id : stack_refactor_id;
    (*

    The ID associated with the stack refactor created from the CreateStackRefactor action.

    *)
}
type nonrec create_stack_refactor_input = {
  1. stack_definitions : stack_definitions;
    (*

    The stacks being refactored.

    *)
  2. resource_mappings : resource_mappings option;
    (*

    The mappings for the stack resource Source and stack resource Destination.

    *)
  3. enable_stack_creation : enable_stack_creation option;
    (*

    Determines if a new stack is created with the refactor.

    *)
  4. description : description option;
    (*

    A description to help you identify the stack refactor.

    *)
}
type nonrec create_stack_output = {
  1. operation_id : operation_id option;
    (*

    A unique identifier for this stack operation that can be used to track the operation's progress and events.

    *)
  2. stack_id : stack_id option;
    (*

    Unique identifier of the stack.

    *)
}

The output for a CreateStack action.

type nonrec create_stack_instances_output = {
  1. operation_id : client_request_token option;
    (*

    The unique identifier for this StackSet operation.

    *)
}
type nonrec create_stack_instances_input = {
  1. call_as : call_as option;
    (*

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    *)
  2. operation_id : client_request_token option;
    (*

    The unique identifier for this StackSet operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.

    If you don't specify an operation ID, the SDK generates one automatically.

    Repeating this StackSet operation with a new operation ID retries all stack instances whose status is OUTDATED.

    *)
  3. operation_preferences : stack_set_operation_preferences option;
    (*

    Preferences for how CloudFormation performs this StackSet operation.

    *)
  4. parameter_overrides : parameters option;
    (*

    A list of StackSet parameters whose values you want to override in the selected stack instances.

    Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

    • To override the current value for a parameter, include the parameter and specify its value.
    • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
    • To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don't include the parameter in the list.
    • To leave all parameters set to their present values, don't specify this property at all.

    During StackSet updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

    You can only override the parameter values that are specified in the StackSet; to add or delete a parameter itself, use UpdateStackSet to update the StackSet template.

    *)
  5. regions : region_list;
    (*

    The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

    *)
  6. deployment_targets : deployment_targets option;
    (*

    [Service-managed permissions] The Organizations accounts in which to create stack instances in the specified Amazon Web Services Regions.

    You can specify Accounts or DeploymentTargets, but not both.

    *)
  7. accounts : account_list option;
    (*

    [Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

    You can specify Accounts or DeploymentTargets, but not both.

    *)
  8. stack_set_name : stack_set_name;
    (*

    The name or unique ID of the StackSet that you want to create stack instances from.

    *)
}
type nonrec create_stack_input = {
  1. disable_validation : disable_validation option;
    (*

    Set to true to disable pre-deployment validations in changeset or stack operations.

    Default: false

    *)
  2. deployment_config : deployment_config option;
    (*

    The deployment configuration for this stack operation, including the deployment mode.

    *)
  3. retain_except_on_create : retain_except_on_create option;
    (*

    When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

    Default: false

    *)
  4. enable_termination_protection : enable_termination_protection option;
    (*

    Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect CloudFormation stacks from being deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.

    For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.

    *)
  5. client_request_token : client_request_token option;
    (*

    A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that CloudFormation successfully received them.

    All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

    In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

    *)
  6. tags : tags option;
    (*

    Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

    *)
  7. stack_policy_ur_l : stack_policy_ur_l option;
    (*

    Location of a file that contains the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    *)
  8. stack_policy_body : stack_policy_body option;
    (*

    Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    *)
  9. on_failure : on_failure option;
    (*

    Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

    Although the default setting is ROLLBACK, there is one exception. This exception occurs when a StackSet attempts to deploy a stack instance and the stack instance fails to create successfully. In this case, the CreateStack call overrides the default setting and sets the value of OnFailure to DELETE.

    Default: ROLLBACK

    *)
  10. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

    If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

    *)
  11. resource_types : resource_types option;
    (*

    Specifies which resource types you can work with, such as AWS::EC2::Instance or Custom::MyCustomInstance.

    If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control CloudFormation access with Identity and Access Management.

    Only one of the Capabilities and ResourceType parameters can be specified.

    *)
  12. capabilities : capabilities option;
    (*

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

      • If you have IAM resources, you can specify either capability.
      • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

      If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

      For more information, see Acknowledging IAM resources in CloudFormation templates.

    • CAPABILITY_AUTO_EXPAND

      Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

      If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

      You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

      Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

      For more information, see Perform custom processing on CloudFormation templates with template macros.

    Only one of the Capabilities and ResourceType parameters can be specified.

    *)
  13. notification_ar_ns : notification_ar_ns option;
    (*

    The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

    *)
  14. timeout_in_minutes : timeout_minutes option;
    (*

    The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

    *)
  15. rollback_configuration : rollback_configuration option;
    (*

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

    *)
  16. disable_rollback : disable_rollback option;
    (*

    Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

    Default: false

    *)
  17. parameters : parameters option;
    (*

    A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

    *)
  18. template_ur_l : template_ur_l option;
    (*

    The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    *)
  19. template_body : template_body option;
    (*

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    Conditional: You must specify either TemplateBody or TemplateURL, but not both.

    *)
  20. stack_name : stack_name;
    (*

    The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.

    A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.

    *)
}

The input for CreateStack action.

type nonrec create_generated_template_output = {
  1. generated_template_id : generated_template_id option;
    (*

    The ID of the generated template.

    *)
}
type nonrec create_generated_template_input = {
  1. template_configuration : template_configuration option;
    (*

    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

    *)
  2. stack_name : stack_name option;
    (*

    An optional name or ARN of a stack to use as the base stack for the generated template.

    *)
  3. generated_template_name : generated_template_name;
    (*

    The name assigned to the generated template.

    *)
  4. resources : resource_definitions option;
    (*

    An optional list of resources to be included in the generated template.

    If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.

    *)
}
type nonrec create_change_set_output = {
  1. stack_id : stack_id option;
    (*

    The unique ID of the stack.

    *)
  2. id : change_set_id option;
    (*

    The Amazon Resource Name (ARN) of the change set.

    *)
}

The output for the CreateChangeSet action.

type nonrec change_set_type =
  1. | IMPORT
  2. | UPDATE
  3. | CREATE
type nonrec create_change_set_input = {
  1. disable_validation : disable_validation option;
    (*

    Set to true to disable pre-deployment validations in changeset or stack operations.

    Default: false

    *)
  2. deployment_config : deployment_config option;
    (*

    The deployment configuration for this stack operation, including the deployment mode.

    *)
  3. deployment_mode : deployment_mode option;
    (*

    Determines how CloudFormation handles configuration drift during deployment.

    • REVERT_DRIFT – Creates a drift-aware change set that brings actual resource states in line with template definitions. Provides a three-way comparison between actual state, previous deployment state, and desired state.

    For more information, see Using drift-aware change sets in the CloudFormation User Guide.

    *)
  4. import_existing_resources : import_existing_resources option;
    (*

    Indicates if the change set auto-imports resources that already exist. For more information, see Import Amazon Web Services resources into a CloudFormation stack automatically in the CloudFormation User Guide.

    This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the ResourcesToImport parameter instead.

    *)
  5. on_stack_failure : on_stack_failure option;
    (*

    Determines what action will be taken if stack creation fails. If this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

    • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.
    • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.
    • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

    For nested stacks, when the OnStackFailure parameter is set to DELETE for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.

    *)
  6. include_nested_stacks : include_nested_stacks option;
    (*

    Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

    *)
  7. resources_to_import : resources_to_import option;
    (*

    The resources to import into your stack.

    *)
  8. change_set_type : change_set_type option;
    (*

    The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

    If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

    By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

    *)
  9. description : description option;
    (*

    A description to help you identify this change set.

    *)
  10. client_token : client_token option;
    (*

    A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.

    *)
  11. change_set_name : change_set_name;
    (*

    The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

    A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.

    *)
  12. tags : tags option;
    (*

    Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

    *)
  13. notification_ar_ns : notification_ar_ns option;
    (*

    The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

    *)
  14. rollback_configuration : rollback_configuration option;
    (*

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

    *)
  15. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

    If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

    *)
  16. resource_types : resource_types option;
    (*

    Specifies which resource types you can work with, such as AWS::EC2::Instance or Custom::MyCustomInstance.

    If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Control CloudFormation access with Identity and Access Management in the CloudFormation User Guide.

    Only one of the Capabilities and ResourceType parameters can be specified.

    *)
  17. capabilities : capabilities option;
    (*

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

      Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

      • If you have IAM resources, you can specify either capability.
      • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
      • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

      If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

      For more information, see Acknowledging IAM resources in CloudFormation templates.

    • CAPABILITY_AUTO_EXPAND

      Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

      This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.

      If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

      For more information about macros, see Perform custom processing on CloudFormation templates with template macros.

    Only one of the Capabilities and ResourceType parameters can be specified.

    *)
  18. parameters : parameters option;
    (*

    A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

    *)
  19. use_previous_template : use_previous_template option;
    (*

    Whether to reuse the template that's associated with the stack to create the change set.

    When using templates with the AWS::LanguageExtensions transform, provide the template instead of using UsePreviousTemplate to ensure new parameter values and Systems Manager parameter updates are applied correctly. For more information, see AWS::LanguageExtensions transform.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    *)
  20. template_ur_l : template_ur_l option;
    (*

    The URL of the file that contains the revised template. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    *)
  21. template_body : template_body option;
    (*

    A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    *)
  22. stack_name : stack_name_or_id;
    (*

    The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

    *)
}

The input for the CreateChangeSet action.

type nonrec continue_update_rollback_output = unit
type nonrec continue_update_rollback_input = {
  1. client_request_token : client_request_token option;
    (*

    A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received them.

    *)
  2. resources_to_skip : resources_to_skip option;
    (*

    A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

    Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

    Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

    To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

    Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Continue rolling back from failed nested stack updates.

    *)
  3. role_ar_n : role_ar_n option;
    (*

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.

    If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

    *)
  4. stack_name : stack_name_or_id;
    (*

    The name or the unique ID of the stack that you want to continue rolling back.

    Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).

    *)
}

The input for the ContinueUpdateRollback action.

type nonrec cancel_update_stack_input = {
  1. client_request_token : client_request_token option;
    (*

    A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

    *)
  2. stack_name : stack_name;
    (*

    If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account.

    The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

    { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

    The name or the unique stack ID that's associated with the stack.

    *)
}

The input for the CancelUpdateStack action.

type nonrec batch_describe_type_configurations_error = {
  1. type_configuration_identifier : type_configuration_identifier option;
    (*

    Identifying information for the configuration of a CloudFormation extension.

    *)
  2. error_message : error_message option;
    (*

    The error message.

    *)
  3. error_code : error_code option;
    (*

    The error code.

    *)
}

Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.

type nonrec batch_describe_type_configurations_errors = batch_describe_type_configurations_error list
type nonrec batch_describe_type_configurations_output = {
  1. type_configurations : type_configuration_details_list option;
    (*

    A list of any of the specified extension configurations from the CloudFormation registry.

    *)
  2. unprocessed_type_configurations : unprocessed_type_configurations option;
    (*

    A list of any of the specified extension configurations that CloudFormation could not process for any reason.

    *)
  3. errors : batch_describe_type_configurations_errors option;
    (*

    A list of information concerning any errors generated during the setting of the specified configurations.

    *)
}
type nonrec batch_describe_type_configurations_input = {
  1. type_configuration_identifiers : type_configuration_identifiers;
    (*

    The list of identifiers for the desired extension configurations.

    *)
}
type nonrec activate_type_output = {
  1. arn : private_type_arn option;
    (*

    The Amazon Resource Name (ARN) of the activated extension in this account and Region.

    *)
}
type nonrec activate_type_input = {
  1. major_version : major_version option;
    (*

    The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

    You can specify MajorVersion or VersionBump, but not both.

    *)
  2. version_bump : version_bump option;
    (*

    Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

    • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
    • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.
    *)
  3. execution_role_arn : role_ar_n2 option;
    (*

    The name of the IAM execution role to use to activate the extension.

    *)
  4. logging_config : logging_config option;
    (*

    Contains logging configuration information for an extension.

    *)
  5. auto_update : auto_update option;
    (*

    Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

    The default is true.

    *)
  6. type_name_alias : type_name option;
    (*

    An alias to assign to the public extension in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

    An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

    *)
  7. type_name : type_name option;
    (*

    The name of the extension.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    *)
  8. publisher_id : publisher_id option;
    (*

    The ID of the extension publisher.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    *)
  9. public_type_arn : third_party_type_arn option;
    (*

    The Amazon Resource Name (ARN) of the public extension.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    *)
  10. type_ : third_party_type option;
    (*

    The extension type.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    *)
}
type nonrec activate_organizations_access_output = unit
type nonrec activate_organizations_access_input = unit