Skip to content

volocloud_tenancy_account_aws

Example Usage

data "volocloud_tenancy_account_aws" "example" {
  tenancy_account_id = "00000000-0000-0000-0000-000000000000"
  tenancy_id         = "00000000-0000-0000-0000-000000000000"
}

Schema

Required

  • tenancy_account_id (String) Volocloud tenancy_account ID.
  • tenancy_id (String) Volocloud tenancy ID associated with this tenancy_account.

Read-Only

  • account_id (String) Volocloud Account ID associated with this tenancy_account.
  • configuration (Attributes) It contains tenancy_account configuration. (see below for nested schema)
  • environment (String) Environment for the tenancy_account. MUST be one of dev, test, qa or prod.
  • id (String) ID of the resource computed from the account_id, tenancy_id and tenancy_account_id separated by ':' .
  • name (String) Volocloud tenancy_account Name.
  • resources (Map of String) These are all the resources created in the tenancy.

Nested Schema for configuration

Required:

Optional:

  • backup (Attributes) AWS Backup configuration settings for the local account. (see below for nested schema)
  • s3_account_public_access_block (Attributes) Manages S3 account-level Public Access Block configuration. (see below for nested schema)

Read-Only:

  • abbreviation (String) This abbreviation will be used to uniquily identify resources created. Only applies to resources that require Azure global uniqueness.
  • aws_account_close_on_delete (Boolean) If true, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
  • ebs_encryption_by_default (Boolean) Whether or not default EBS encryption is enabled. Defaults to true.
  • securityhub (Attributes) Manages the Security Hub Configuration for AWS Account. (see below for nested schema)
  • vpc_template (String) Deployment architecture for the network subnets.

Nested Schema for configuration.alternate_contacts

Required:

  • email (String) An email address for the alternate contact.
  • name (String) Name of the alternate contact.
  • phone (String) Phone number for the alternate contact.
  • title (String) Title for the alternate contact.

Nested Schema for configuration.regions

Required:

Optional:

  • other (Attributes List) A list of Non-Home geographies containing a pair of primary/secondary regions in each geography. (see below for nested schema)

Nested Schema for configuration.regions.home

Required:

Optional:

Nested Schema for configuration.regions.home.primary

Required:

  • location (String) The Aws location of the region. Possible values are [af-south-1 ap-east-1 ap-east-2 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-southeast-1 ap-southeast-2 ap-southeast-3 ap-southeast-4 ap-southeast-5 ap-southeast-6 ap-southeast-7 ap-south-1 ap-south-2 ca-central-1 ca-west-1 cn-north-1 cn-northwest-1 eu-central-1 eu-central-2 eu-north-1 eu-south-1 eu-south-2 eu-west-1 eu-west-2 eu-west-3 il-central-1 me-central-1 me-south-1 mx-central-1 sa-east-1 us-east-1 us-east-2 us-gov-east-1 us-gov-west-1 us-west-1 us-west-2].
  • network (Attributes) This information is used to deploy a network in this tenancy account associated with the landing zone. (see below for nested schema)
  • region (String) The Aws region code of the location. Possible values are [afso1 apea1 apea2 apne1 apne2 apne3 apse1 apse2 apse3 apse4 apse5 apse6 apse7 apso1 apso2 cace1 cawe1 cnno1 cnnw1 euce1 euce2 euno1 euso1 euso2 euwe1 euwe2 euwe3 ilce1 mece1 meso1 mxce1 saea1 usea1 usea2 usge1 usgw1 uswe1 uswe2].

Nested Schema for configuration.regions.home.primary.network

Required:

  • enabled (Boolean) If enabled, it will deploy a network in this tenancy account associated with the landing zone.

Optional:

  • ip_address_mask (Number) The base IP Network Mask for this tenancy account. If provided, it MUST be between 22 and 26. Check the documentation for the VPC template to make sure you create the correct network mask. Defaults to 24.

Warning

Changing this value causes the VPC to be re-created. CANNOT be changed after creation without destroying everything running on top of the VPC.

Nested Schema for configuration.regions.home.secondary

Required:

  • location (String) The Aws location of the region. Possible values are [af-south-1 ap-east-1 ap-east-2 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-southeast-1 ap-southeast-2 ap-southeast-3 ap-southeast-4 ap-southeast-5 ap-southeast-6 ap-southeast-7 ap-south-1 ap-south-2 ca-central-1 ca-west-1 cn-north-1 cn-northwest-1 eu-central-1 eu-central-2 eu-north-1 eu-south-1 eu-south-2 eu-west-1 eu-west-2 eu-west-3 il-central-1 me-central-1 me-south-1 mx-central-1 sa-east-1 us-east-1 us-east-2 us-gov-east-1 us-gov-west-1 us-west-1 us-west-2].
  • network (Attributes) This information is used to deploy a network in this tenancy account associated with the landing zone. (see below for nested schema)
  • region (String) The Aws region code of the location. Possible values are [afso1 apea1 apea2 apne1 apne2 apne3 apse1 apse2 apse3 apse4 apse5 apse6 apse7 apso1 apso2 cace1 cawe1 cnno1 cnnw1 euce1 euce2 euno1 euso1 euso2 euwe1 euwe2 euwe3 ilce1 mece1 meso1 mxce1 saea1 usea1 usea2 usge1 usgw1 uswe1 uswe2].

Nested Schema for configuration.regions.home.secondary.network

Required:

  • enabled (Boolean) If enabled, it will deploy a network in this tenancy account associated with the landing zone.

Optional:

  • ip_address_mask (Number) The base IP Network Mask for this tenancy account. If provided, it MUST be between 22 and 26. Check the documentation for the VPC template to make sure you create the correct network mask. Defaults to 24.

Warning

Changing this value causes the VPC to be re-created. CANNOT be changed after creation without destroying everything running on top of the VPC.

Nested Schema for configuration.regions.other

Required:

Optional:

Nested Schema for configuration.regions.other.primary

Required:

  • location (String) The Aws location of the region. Possible values are [af-south-1 ap-east-1 ap-east-2 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-southeast-1 ap-southeast-2 ap-southeast-3 ap-southeast-4 ap-southeast-5 ap-southeast-6 ap-southeast-7 ap-south-1 ap-south-2 ca-central-1 ca-west-1 cn-north-1 cn-northwest-1 eu-central-1 eu-central-2 eu-north-1 eu-south-1 eu-south-2 eu-west-1 eu-west-2 eu-west-3 il-central-1 me-central-1 me-south-1 mx-central-1 sa-east-1 us-east-1 us-east-2 us-gov-east-1 us-gov-west-1 us-west-1 us-west-2].
  • network (Attributes) This information is used to deploy a network in this tenancy account associated with the landing zone. (see below for nested schema)
  • region (String) The Aws region code of the location. Possible values are [afso1 apea1 apea2 apne1 apne2 apne3 apse1 apse2 apse3 apse4 apse5 apse6 apse7 apso1 apso2 cace1 cawe1 cnno1 cnnw1 euce1 euce2 euno1 euso1 euso2 euwe1 euwe2 euwe3 ilce1 mece1 meso1 mxce1 saea1 usea1 usea2 usge1 usgw1 uswe1 uswe2].

Nested Schema for configuration.regions.other.primary.network

Required:

  • enabled (Boolean) If enabled, it will deploy a network in this tenancy account associated with the landing zone.

Optional:

  • ip_address_mask (Number) The base IP Network Mask for this tenancy account. If provided, it MUST be between 22 and 26. Check the documentation for the VPC template to make sure you create the correct network mask. Defaults to 24.

Warning

Changing this value causes the VPC to be re-created. CANNOT be changed after creation without destroying everything running on top of the VPC.

Nested Schema for configuration.regions.other.secondary

Required:

  • location (String) The Aws location of the region. Possible values are [af-south-1 ap-east-1 ap-east-2 ap-northeast-1 ap-northeast-2 ap-northeast-3 ap-southeast-1 ap-southeast-2 ap-southeast-3 ap-southeast-4 ap-southeast-5 ap-southeast-6 ap-southeast-7 ap-south-1 ap-south-2 ca-central-1 ca-west-1 cn-north-1 cn-northwest-1 eu-central-1 eu-central-2 eu-north-1 eu-south-1 eu-south-2 eu-west-1 eu-west-2 eu-west-3 il-central-1 me-central-1 me-south-1 mx-central-1 sa-east-1 us-east-1 us-east-2 us-gov-east-1 us-gov-west-1 us-west-1 us-west-2].
  • network (Attributes) This information is used to deploy a network in this tenancy account associated with the landing zone. (see below for nested schema)
  • region (String) The Aws region code of the location. Possible values are [afso1 apea1 apea2 apne1 apne2 apne3 apse1 apse2 apse3 apse4 apse5 apse6 apse7 apso1 apso2 cace1 cawe1 cnno1 cnnw1 euce1 euce2 euno1 euso1 euso2 euwe1 euwe2 euwe3 ilce1 mece1 meso1 mxce1 saea1 usea1 usea2 usge1 usgw1 uswe1 uswe2].

Nested Schema for configuration.regions.other.secondary.network

Required:

  • enabled (Boolean) If enabled, it will deploy a network in this tenancy account associated with the landing zone.

Optional:

  • ip_address_mask (Number) The base IP Network Mask for this tenancy account. If provided, it MUST be between 22 and 26. Check the documentation for the VPC template to make sure you create the correct network mask. Defaults to 24.

Warning

Changing this value causes the VPC to be re-created. CANNOT be changed after creation without destroying everything running on top of the VPC.

Nested Schema for configuration.backup

Optional:

  • policies (Attributes) Configuration settings for built-in backup policies. (see below for nested schema)
  • restore_testing (Attributes) If enabled, it will create a restore testing plan with multiple resource type selections. (see below for nested schema)
  • vault_lock (Attributes) Configuration settings for the AWS Organization Backup Vault lock. (see below for nested schema)
  • vault_notifications (Attributes List) Configuration settings for the AWS Organization Backup Vault notifications. (see below for nested schema)

Nested Schema for configuration.backup.policies

Optional:

Nested Schema for configuration.backup.policies.daily

Optional:

  • backup_complete_window_minutes (Number) A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. Defaults to 1 day.
  • backup_start_window_minutes (Number) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. If this value is included, it must be at least 60 minutes to avoid errors. Defaults to 60 minutes.
  • copy_to_region (String) Creates a copy action in the backup plan that will copy the backup to the organization backup vault specified by region. The specified region MUST have been defined in the regions attribute.
  • delete_after_days (Number) Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than move_to_cold_storage_after_days.
  • move_to_cold_storage_after_days (Number) Specifies the number of days after creation that a recovery point is moved to cold storage.
  • opt_in_to_archive_for_supported_resources (Boolean) This setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
  • schedule_expression (String) A cron expression in UTC specifying when AWS Backup initiates a backup job. For more information about AWS cron expressions, see Cron expressions reference for Rules in the Amazon CloudWatch Events User Guide. If not specified, the policy will have a default start time at 11 PM every day.
  • schedule_expression_timezone (String) This is the timezone in which the schedule expression is set. By default, schedule_expression is in UTC. You can modify this to a specified timezone.
  • selection_tag (String) Specifies the tag key name to search for on resources to add to the backup plan. The value of this tag MUST be true.

Nested Schema for configuration.backup.policies.monthly

Optional:

  • backup_complete_window_minutes (Number) A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. Defaults to 1 day.
  • backup_start_window_minutes (Number) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. If this value is included, it must be at least 60 minutes to avoid errors. Defaults to 60 minutes.
  • copy_to_region (String) Creates a copy action in the backup plan that will copy the backup to the organization backup vault specified by region. The specified region MUST have been defined in the regions attribute.
  • delete_after_days (Number) Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than move_to_cold_storage_after_days.
  • move_to_cold_storage_after_days (Number) Specifies the number of days after creation that a recovery point is moved to cold storage.
  • opt_in_to_archive_for_supported_resources (Boolean) This setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
  • schedule_expression (String) A cron expression in UTC specifying when AWS Backup initiates a backup job. For more information about AWS cron expressions, see Cron expressions reference for Rules in the Amazon CloudWatch Events User Guide. If not specified, the policy will have a default start time at 2 AM every first day of month.
  • schedule_expression_timezone (String) This is the timezone in which the schedule expression is set. By default, schedule_expression is in UTC. You can modify this to a specified timezone.
  • selection_tag (String) Specifies the tag key name to search for on resources to add to the backup plan. The value of this tag MUST be true.

Nested Schema for configuration.backup.policies.weekly

Optional:

  • backup_complete_window_minutes (Number) A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. Defaults to 1 day.
  • backup_start_window_minutes (Number) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. If this value is included, it must be at least 60 minutes to avoid errors. Defaults to 60 minutes.
  • copy_to_region (String) Creates a copy action in the backup plan that will copy the backup to the organization backup vault specified by region. The specified region MUST have been defined in the regions attribute.
  • delete_after_days (Number) Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than move_to_cold_storage_after_days.
  • move_to_cold_storage_after_days (Number) Specifies the number of days after creation that a recovery point is moved to cold storage.
  • opt_in_to_archive_for_supported_resources (Boolean) This setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
  • schedule_expression (String) A cron expression in UTC specifying when AWS Backup initiates a backup job. For more information about AWS cron expressions, see Cron expressions reference for Rules in the Amazon CloudWatch Events User Guide. If not specified, the policy will have a default start time at 12 AM every Sunday.
  • schedule_expression_timezone (String) This is the timezone in which the schedule expression is set. By default, schedule_expression is in UTC. You can modify this to a specified timezone.
  • selection_tag (String) Specifies the tag key name to search for on resources to add to the backup plan. The value of this tag MUST be true.

Nested Schema for configuration.backup.policies.yearly

Optional:

  • backup_complete_window_minutes (Number) A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. Defaults to 1 day.
  • backup_start_window_minutes (Number) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. If this value is included, it must be at least 60 minutes to avoid errors. Defaults to 60 minutes.
  • copy_to_region (String) Creates a copy action in the backup plan that will copy the backup to the organization backup vault specified by region. The specified region MUST have been defined in the regions attribute.
  • delete_after_days (Number) Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than move_to_cold_storage_after_days.
  • move_to_cold_storage_after_days (Number) Specifies the number of days after creation that a recovery point is moved to cold storage.
  • opt_in_to_archive_for_supported_resources (Boolean) This setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
  • schedule_expression (String) A cron expression in UTC specifying when AWS Backup initiates a backup job. For more information about AWS cron expressions, see Cron expressions reference for Rules in the Amazon CloudWatch Events User Guide. If not specified, the policy will have a default start time at 4 AM every Jan 1st.
  • schedule_expression_timezone (String) This is the timezone in which the schedule expression is set. By default, schedule_expression is in UTC. You can modify this to a specified timezone.
  • selection_tag (String) Specifies the tag key name to search for on resources to add to the backup plan. The value of this tag MUST be true.

Nested Schema for configuration.backup.restore_testing

Optional:

  • enabled (Boolean) If true, enables the AWS Backup restore testing plan for supported resources. Defaults to true.
  • protected_resource_selection_tags (Attributes List) A list of conditions that you define for resources in your restore testing plan using tags. Filters the values of your tagged resources for only those resources that you tagged with the same value. (see below for nested schema)
  • protected_resource_selection_types (List of String) The type of AWS resource included in a restore testing selection.
  • recovery_point_selection (Attributes) Configuration of recovery points for AWS Backup restore testing plan. (see below for nested schema)
  • schedule_expression (String) A cron expression in UTC specifying when AWS Backup initiates a restore test. For more information about AWS cron expressions, see Cron expressions reference for Rules in the Amazon CloudWatch Events User Guide. If not specified, the policy will have a default start time at 1 AM on the 15th of every month.
  • schedule_expression_timezone (String) This is the timezone in which the schedule expression is set. By default, schedule_expression is in UTC. You can modify this to a specified timezone.

Nested Schema for configuration.backup.restore_testing.protected_resource_selection_tags

Optional:

  • tag_key (String) The selection tag key. Defaults to RestoreTestingEnabled.
  • tag_value (String) The selection tag value. Defaults to true.

Nested Schema for configuration.backup.restore_testing.recovery_point_selection

Optional:

  • algorithm (String) Acceptable values include LATEST_WITHIN_WINDOW or RANDOM_WITHIN_WINDOW.
  • recovery_point_types (List of String) Acceptable values include CONTINUOUS and SNAPSHOT.
  • selection_window_days (Number) Accepted values are integers from 1 to 365.

Nested Schema for configuration.backup.vault_lock

Optional:

  • changeable_for_days (Number) The number of days before the lock date. If omitted creates a vault lock in governance mode, otherwise it will create a vault lock in compliance mode.
  • max_retention_days (Number) The maximum retention period that the vault retains its recovery points. Defaults to 90.

Warning

Changing this value causes the backup vault to be re-created. CANNOT be changed after creation without destroying the backup vault and its data.

  • min_retention_days (Number) The minimum retention period that the vault retains its recovery points. Defaults to 1.

Warning

Changing this value causes the backup vault to be re-created. CANNOT be changed after creation without destroying the backup vault and its data.

Nested Schema for configuration.backup.vault_notifications

Required:

Optional:

  • events (List of String) An array of events that indicate the status of jobs to back up resources to the backup vault.
  • filter_policy (String) JSON String with the filter policy that will be used in the SNS subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.

Nested Schema for configuration.backup.vault_notifications.recipients

Optional:

  • email (List of String) List of email addresses.

Nested Schema for configuration.s3_account_public_access_block

Optional:

  • block_public_acls (Boolean) Optional) Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to true.
  • block_public_policy (Boolean) Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to true.
  • ignore_public_acls (Boolean) Whether Amazon S3 should ignore public ACLs for buckets in this account. Defaults to true.
  • restrict_public_buckets (Boolean) Whether Amazon S3 should restrict public bucket policies for buckets in this account. Defaults to true.

Nested Schema for configuration.securityhub

Optional:

  • standards (Attributes) Manages Security Hub Standards and their controls for this AWS Organization. (see below for nested schema)

Read-Only:

  • enabled (Boolean) Enables Security Hub for this AWS Account.

Nested Schema for configuration.securityhub.standards

Optional:

  • aws_foundational_security_best_practices (Attributes) Manages Security Hub AWS Foundational Security Best Practices standard. Defaults to {"controls":<null>,"enabled":true,"version":"v1.0.0"}. (see below for nested schema)
  • aws_resource_tagging_standard (Attributes) Manages Security Hub AWS Resource Tagging Standard standard. Defaults to {"controls":<null>,"enabled":true,"version":"v1.0.0"}. (see below for nested schema)
  • cis_aws_foundations_benchmark (Attributes) Manages Security Hub CIS AWS Foundations Benchmark standard. Defaults to {"controls":<null>,"enabled":true,"version":"v5.0.0"}. (see below for nested schema)
  • nist_special_publication_800_171 (Attributes) Manages Security Hub NIST Special Publication 800-171 standard. (see below for nested schema)
  • nist_special_publication_800_53 (Attributes) Manages Security Hub NIST Special Publication 800-53 standard. (see below for nested schema)
  • pci_dss (Attributes) Manages Security Hub PCI DSS standard. (see below for nested schema)

Nested Schema for configuration.securityhub.standards.aws_foundational_security_best_practices

Optional:

  • controls (Attributes Map) A map of object to disable control(s) part of this standard. The map keys MUST be the all lowercase control id. For control id see AWS Documentation. (see below for nested schema)
  • enabled (Boolean) Enables this Security Hub AWS Foundational Security Best Practices standard in the AWS Organization. Defaults to true.
  • version (String) Standard version. Valid versions: v1.0.0. Defaults to v1.0.0.

Nested Schema for configuration.securityhub.standards.aws_foundational_security_best_practices.controls

Required:

  • disable_control (Boolean) If true, the control will be disabled.
  • disable_reason (String) Provides a reason why the control has been disabled.

Nested Schema for configuration.securityhub.standards.aws_resource_tagging_standard

Optional:

  • controls (Attributes Map) A map of object to disable control(s) part of this standard. The map keys MUST be the all lowercase control id. For control id see AWS Documentation. (see below for nested schema)
  • enabled (Boolean) Enables this Security Hub AWS Resource Tagging Standard standard in the AWS Organization. Defaults to true.
  • version (String) Standard version. Valid versions: v1.0.0. Defaults to v1.0.0.

Nested Schema for configuration.securityhub.standards.aws_resource_tagging_standard.controls

Required:

  • disable_control (Boolean) If true, the control will be disabled.
  • disable_reason (String) Provides a reason why the control has been disabled.

Nested Schema for configuration.securityhub.standards.cis_aws_foundations_benchmark

Optional:

  • controls (Attributes Map) A map of object to disable control(s) part of this standard. The map keys MUST be the all lowercase control id. For control id see AWS Documentation. (see below for nested schema)
  • enabled (Boolean) Enables this Security Hub CIS AWS Foundations Benchmark standard in the AWS Organization. Defaults to true.
  • version (String) Standard version. Valid versions: v1.4.0, v3.0.0 or v5.0.0. Defaults to v5.0.0.

Nested Schema for configuration.securityhub.standards.cis_aws_foundations_benchmark.controls

Required:

  • disable_control (Boolean) If true, the control will be disabled.
  • disable_reason (String) Provides a reason why the control has been disabled.

Nested Schema for configuration.securityhub.standards.nist_special_publication_800_171

Required:

  • enabled (Boolean) Enables this Security Hub NIST Special Publication 800-171 standard in the AWS Organization.

Optional:

  • controls (Attributes Map) A map of object to disable control(s) part of this standard. The map keys MUST be the all lowercase control id. For control id see AWS Documentation. (see below for nested schema)
  • version (String) Standard version. Valid versions: revision_2. Defaults to revision_2.

Nested Schema for configuration.securityhub.standards.nist_special_publication_800_171.controls

Required:

  • disable_control (Boolean) If true, the control will be disabled.
  • disable_reason (String) Provides a reason why the control has been disabled.

Nested Schema for configuration.securityhub.standards.nist_special_publication_800_53

Required:

  • enabled (Boolean) Enables this Security Hub NIST Special Publication 800-53 standard in the AWS Organization.

Optional:

  • controls (Attributes Map) A map of object to disable control(s) part of this standard. The map keys MUST be the all lowercase control id. For control id see AWS Documentation. (see below for nested schema)
  • version (String) Standard version. Valid versions: revision_5. Defaults to revision_5.

Nested Schema for configuration.securityhub.standards.nist_special_publication_800_53.controls

Required:

  • disable_control (Boolean) If true, the control will be disabled.
  • disable_reason (String) Provides a reason why the control has been disabled.

Nested Schema for configuration.securityhub.standards.pci_dss

Required:

  • enabled (Boolean) Enables this Security Hub PCI DSS standard in the AWS Organization.

Optional:

  • controls (Attributes Map) A map of object to disable control(s) part of this standard. The map keys MUST be the all lowercase control id. For control id see AWS Documentation. (see below for nested schema)
  • version (String) Standard version. Valid versions: v3.2.1 or v4.0.1. Defaults to v4.0.1.

Nested Schema for configuration.securityhub.standards.pci_dss.controls

Required:

  • disable_control (Boolean) If true, the control will be disabled.
  • disable_reason (String) Provides a reason why the control has been disabled.