diff --git a/website/docs/d/cloud_shell_account_settings.html.markdown b/website/docs/d/cloud_shell_account_settings.html.markdown index 083f94372e..d2753b714f 100644 --- a/website/docs/d/cloud_shell_account_settings.html.markdown +++ b/website/docs/d/cloud_shell_account_settings.html.markdown @@ -1,6 +1,6 @@ --- layout: "ibm" -page_title: "IBM : cloud_shell_account_settings" +page_title: "IBM : ibm_cloud_shell_account_settings" description: |- Get information about cloud_shell_account_settings subcategory: "IBM Cloud Shell" @@ -8,51 +8,51 @@ subcategory: "IBM Cloud Shell" # ibm_cloud_shell_account_settings -Provides a read-only data source for cloud_shell_account_settings. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. +Provides a read-only data source to retrieve information about cloud_shell_account_settings. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. -## Example usage +## Example Usage -```terraform -data "cloud_shell_account_settings" "cloud_shell_account_settings" { - account_id = "account_id" +```hcl +data "ibm_cloud_shell_account_settings" "cloud_shell_account_settings" { + account_id = ibm_cloud_shell_account_settings.cloud_shell_account_settings_instance.account_id } ``` -## Argument reference +## Argument Reference -The following arguments are supported: +You can specify the following arguments for this data source. -* `account_id` - (Required, string) The account ID in which the account settings belong to. +* `account_id` - (Required, Forces new resource, String) The account ID in which the account settings belong to. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. -## Attribute reference +## Attribute Reference -In addition to all arguments above, the following attributes are exported: +After your data source is created, you can read values from the following attributes. * `id` - The unique identifier of the cloud_shell_account_settings. - -* `rev` - Unique revision number for the settings object. - -* `created_at` - Creation timestamp in Unix epoch time. - -* `created_by` - IAM ID of creator. - -* `default_enable_new_features` - You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. - -* `default_enable_new_regions` - Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location. - -* `enabled` - When enabled, Cloud Shell is available to all users in the account. - -* `features` - List of Cloud Shell features. Nested `features` blocks have the following structure: - * `enabled` - State of the feature. - * `key` - Name of the feature. - -* `regions` - List of Cloud Shell region settings. Nested `regions` blocks have the following structure: - * `enabled` - State of the region. - * `key` - Name of the region. - -* `type` - Type of api response object. - -* `updated_at` - Timestamp of last update in Unix epoch time. - -* `updated_by` - IAM ID of last updater. +* `created_at` - (Integer) Creation timestamp in Unix epoch time. +* `created_by` - (String) IAM ID of creator. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. +* `default_enable_new_features` - (Boolean) You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. +* `default_enable_new_regions` - (Boolean) Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location. +* `enabled` - (Boolean) When enabled, Cloud Shell is available to all users in the account. +* `features` - (List) List of Cloud Shell features. + * Constraints: The maximum length is `2` items. The minimum length is `0` items. +Nested schema for **features**: + * `enabled` - (Boolean) State of the feature. + * `key` - (String) Name of the feature. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9_.]*$/`. +* `regions` - (List) List of Cloud Shell region settings. + * Constraints: The maximum length is `3` items. The minimum length is `0` items. +Nested schema for **regions**: + * `enabled` - (Boolean) State of the region. + * `key` - (String) Name of the region. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z-]*$/`. +* `rev` - (String) Unique revision number for the settings object. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. +* `type` - (String) Type of api response object. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z_]*$/`. +* `updated_at` - (Integer) Timestamp of last update in Unix epoch time. +* `updated_by` - (String) IAM ID of last updater. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. diff --git a/website/docs/r/cloud_shell_account_settings.html.markdown b/website/docs/r/cloud_shell_account_settings.html.markdown index e31b267b54..a8de752c63 100644 --- a/website/docs/r/cloud_shell_account_settings.html.markdown +++ b/website/docs/r/cloud_shell_account_settings.html.markdown @@ -1,6 +1,6 @@ --- layout: "ibm" -page_title: "IBM : cloud_shell_account_settings" +page_title: "IBM : ibm_cloud_shell_account_settings" description: |- Manages cloud_shell_account_settings. subcategory: "IBM Cloud Shell" @@ -8,9 +8,9 @@ subcategory: "IBM Cloud Shell" # ibm_cloud_shell_account_settings -Provides a resource for cloud_shell_account_settings. This allows cloud_shell_account_settings to be updated. +Create, update, and delete cloud_shell_account_settingss with this resource. -## Example usage +## Example Usage ```terraform resource "ibm_cloud_shell_account_settings" "cloud_shell_account_settings" { @@ -42,52 +42,58 @@ resource "ibm_cloud_shell_account_settings" "cloud_shell_account_settings" { } ``` -## Argument reference +## Argument Reference -The following arguments are supported: +You can specify the following arguments for this resource. -* `account_id` - (Required, Forces new resource, string) The account ID in which the account settings belong to. -* `default_enable_new_features` - (Optional, bool) You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. -* `default_enable_new_regions` - (Optional, bool) Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location. -* `enabled` - (Optional, bool) When enabled, Cloud Shell is available to all users in the account. +* `account_id` - (Required, Forces new resource, String) The account ID in which the account settings belong to. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. +* `default_enable_new_features` - (Optional, Boolean) You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. +* `default_enable_new_regions` - (Optional, Boolean) Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location. +* `enabled` - (Optional, Boolean) When enabled, Cloud Shell is available to all users in the account. * `features` - (Optional, List) List of Cloud Shell features. - * `enabled` - (Optional, bool) State of the feature. - * `key` - (Optional, string) Name of the feature. + * Constraints: The maximum length is `2` items. The minimum length is `0` items. +Nested schema for **features**: + * `enabled` - (Optional, Boolean) State of the feature. + * `key` - (Optional, String) Name of the feature. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9_.]*$/`. * `regions` - (Optional, List) List of Cloud Shell region settings. - * `enabled` - (Optional, bool) State of the region. - * `key` - (Optional, string) Name of the region. -* `rev` - (Required, string) Unique revision number for the settings object. Required it this field is available from the data source. + * Constraints: The maximum length is `3` items. The minimum length is `0` items. +Nested schema for **regions**: + * `enabled` - (Optional, Boolean) State of the region. + * `key` - (Optional, String) Name of the region. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z-]*$/`. +* `rev` - (Optional, String) Unique revision number for the settings object. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. -## Attribute reference +## Attribute Reference -In addition to all arguments above, the following attributes are exported: +After your resource is created, you can read values from the listed arguments and the following attributes. * `id` - The unique identifier of the cloud_shell_account_settings. -* `created_at` - Creation timestamp in Unix epoch time. -* `created_by` - IAM ID of creator. -* `default_enable_new_features` - You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. -* `default_enable_new_regions` - Set whether Cloud Shell is enabled in a specific location for the account. The location determines where user and session data are stored. By default, users are routed to the nearest available location. -* `enabled` - When enabled, Cloud Shell is available to all users in the account. -* `features` - List of Cloud Shell features. Nested `features` blocks have the following structure: - * `enabled` - State of the feature. - * `key` - Name of the feature. -* `regions` - List of Cloud Shell region settings. Nested `regions` blocks have the following structure: - * `enabled` - State of the region. - * `key` - Name of the region. -* `rev` - Unique revision number for the settings object. -* `type` - Type of api response object. -* `updated_at` - Timestamp of last update in Unix epoch time. -* `updated_by` - IAM ID of last updater. +* `created_at` - (Integer) Creation timestamp in Unix epoch time. +* `created_by` - (String) IAM ID of creator. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. +* `id` - (String) Unique id of the settings object. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. +* `type` - (String) Type of api response object. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-z_]*$/`. +* `updated_at` - (Integer) Timestamp of last update in Unix epoch time. +* `updated_by` - (String) IAM ID of last updater. + * Constraints: The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. + ## Import -You can import the `cloud_shell_account_settings` resource by using `account_id`. +You can import the `ibm_cloud_shell_account_settings` resource by using `account_id`. +The `account_id` property can be formed from and `account_id` in the following format: -``` - -``` +
+<account_id>
+
* `account_id`: A string. The account ID in which the account settings belong to. -``` -$ terraform import cloud_shell_account_settings.cloud_shell_account_settings -``` +# Syntax +
+$ terraform import ibm_cloud_shell_account_settings.cloud_shell_account_settings <account_id>
+