diff --git a/website/docs/d/cd_toolchain_tool_securitycompliance.html.markdown b/website/docs/d/cd_toolchain_tool_securitycompliance.html.markdown deleted file mode 100644 index 229a4245f6..0000000000 --- a/website/docs/d/cd_toolchain_tool_securitycompliance.html.markdown +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_cd_toolchain_tool_securitycompliance" -description: |- - Get information about cd_toolchain_tool_securitycompliance -subcategory: "Continuous Delivery" ---- - -# ibm_cd_toolchain_tool_securitycompliance - -Provides a read-only data source to retrieve information about a cd_toolchain_tool_securitycompliance. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -See the [tool integration](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-scc) page for more information. - -## Example Usage - -```hcl -data "ibm_cd_toolchain_tool_securitycompliance" "cd_toolchain_tool_securitycompliance" { - tool_id = "9603dcd4-3c86-44f8-8d0a-9427369878cf" - toolchain_id = data.ibm_cd_toolchain.cd_toolchain.id -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `tool_id` - (Required, Forces new resource, String) ID of the tool bound to the toolchain. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/`. -* `toolchain_id` - (Required, Forces new resource, String) ID of the toolchain. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the cd_toolchain_tool_securitycompliance. -* `crn` - (String) Tool CRN. -* `href` - (String) URI representing the tool. -* `name` - (String) Name of the tool. - * Constraints: The maximum length is `128` characters. The minimum length is `0` characters. The value must match regular expression `/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/`. -* `parameters` - (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. -Nested schema for **parameters**: - * `attachment_id` - (String) An attachment ID. An attachment is configured under a profile to define how a scan will be run. To find the attachment ID, in the browser, in the attachments list, click on the attachment link, and a panel appears with a button to copy the attachment ID. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * Constraints: The value must match regular expression `/^[-0-9a-f]{32,36}$/`. - * `cos_bucket_name` - (String) The name of the Cloud Object Storage bucket used as an evidence locker. Make sure that this `cos_bucket_name` parameter matches the `bucket_name` for a `cloudobjectstorage` (Cloud Object Storage) tool integration in this toolchain. Only relevant when `evidence_locker_type` is set to `evidence-bucket`. - * `evidence_locker_type` - (String) The type of evidence storage locker. If you are using a Cloud Object Storage bucket, use the `evidence-bucket` type, and use the other `cos_bucket_name` parameter to point to the bucket, and provide a `cloudobjectstorage` (Cloud Object Storage) tool integration with a matching `bucket_name` and the credentials for connecting to the bucket. Or else if you are using a Git repository, use the `evidence-repo` type, and use the other `evidence_repo_url` parameter to point to the Git repository, and provide a Git tool integration. When absent defaults to `evidence-repo`. - * Constraints: Allowable values are: `evidence-repo`, `evidence-bucket`. - * `evidence_namespace` - (String) The kind of pipeline evidence to be displayed in Security and Compliance Center for this toolchain. The values are; `cd` which will use evidence generated by a Continuous Deployment (CD) pipeline, or `cc` which will use evidence generated by a Continuous Compliance (CC) pipeline. The default behavior is to use the CD evidence. - * Constraints: Allowable values are: `cd`, `cc`. - * `evidence_repo_url` - (String) The URL to a Git repository evidence locker. This evidence URL should match the `repo_url` for a Git tool integration in this toolchain. Only relevant when using `evidence-repo` as the `evidence_locker_type`. - * `instance_crn` - (String) The Security and Compliance Center service instance CRN (Cloud Resource Name). It is recommended to provide an instance CRN, but when absent, the oldest service instance will be used. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * Constraints: The value must match regular expression `/^crn:v1:(?:bluemix|staging):public:compliance:[a-zA-Z0-9-]*\\b:a\/[0-9a-fA-F]*\\b:[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}\\b::$/`. - * `name` - (String) The name for this tool integration, shown on the toolchain page. - * `profile_name` - (String) The name of a Security and Compliance Center profile. Usually, use the "IBM Cloud Framework for Financial Services" predefined profile, which contains the DevSecOps Toolchain rules. Or use a user-authored customized profile that has been configured to contain those rules. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * `profile_version` - (String) The version of a Security and Compliance Center profile, in SemVer format, like '0.0.0'. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * `scc_api_key` - (String) The IBM Cloud API key used to access the Security and Compliance Center service, for the use profile with attachment setting. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. You can use a toolchain secret reference for this parameter. For more information, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security#cd_secure_credentials). - * `use_profile_attachment` - (String) Set to `enabled` to enable use of a Security and Compliance Center (SCC) attachment and associated profile. This configuration allows the pre-deployment validation scripts to use the SCC profile. These scripts interact with the Security and Compliance Center service to check compliance rules for Continuous Deployment (CD). Similar checks are in place to ensure compliance monitoring for Continuous Compliance (CC). When enabled, other parameters become relevant; `scc_api_key`, `instance_crn`, `profile_name`, `profile_version`, `attachment_id`. - * Constraints: Allowable values are: `disabled`, `enabled`. -* `referent` - (List) Information on URIs to access this resource through the UI or API. -Nested schema for **referent**: - * `api_href` - (String) URI representing this resource through an API. - * `ui_href` - (String) URI representing this resource through the UI. -* `resource_group_id` - (String) Resource group where the tool is located. -* `state` - (String) Current configuration state of the tool. - * Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`. -* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to. -* `updated_at` - (String) Latest tool update timestamp. - diff --git a/website/docs/d/scc_control_libraries.html.markdown b/website/docs/d/scc_control_libraries.html.markdown deleted file mode 100644 index a6f3aa3559..0000000000 --- a/website/docs/d/scc_control_libraries.html.markdown +++ /dev/null @@ -1,60 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_control_libraries" -description: |- - Get information about scc_control_libraries -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_control_libraries - -Retrieve information about a list of scc_control_libraries from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_control_libraries" "scc_control_libraries" { - instance_id = "00000000-1111-2222-3333-444444444444" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `control_library_type` - (Optional, Forces new resource, String) The type of control library to query. - * Constraints: Allowable values are: `predefined`, `custom`. -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `control_libraries` - (List) The list of control libraries. - - Nested schema for **control_libraries**: - * `id` - (String) The unique identifier of the scc_control_library. - - * `account_id` - (String) The account ID. - - * `control_library_description` - (String) The control library description. - - * `control_library_name` - (String) The control library name. - - * `control_library_type` - (String) The control library type. - - * `control_library_version` - (String) The control library version. - - * `control_count` - (Integer) The number of controls in the control library. - - * `created_by` - (String) The user who created the control library. - - * `created_on` - (String) The date when the control library was created. - - * `updated_by` - (String) The user who updated the control library. - - * `updated_on` - (String) The date when the control library was updated. - - * `version_group_label` - (String) The version group label. diff --git a/website/docs/d/scc_control_library.html.markdown b/website/docs/d/scc_control_library.html.markdown deleted file mode 100644 index 965b2ee848..0000000000 --- a/website/docs/d/scc_control_library.html.markdown +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_control_library" -description: |- - Get information about scc_control_library -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_control_library - -Retrieve information about a scc_control_library from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_control_library" "scc_control_library" { - instance_id = "00000000-1111-2222-3333-444444444444" - control_library_id = "aaaaaaaa-1111-bbbb-2222-cccccccccccc" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `control_library_id` - (Required, Forces new resource, String) The control library ID. - * Constraints: The maximum length is `256` characters. The minimum length is `1` character. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_control_library. -* `account_id` - (String) The account ID. - * Constraints: The maximum length is `32` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -* `control_library_description` - (String) The control library description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `control_library_name` - (String) The control library name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_\\s\\-]*$/`. - -* `control_library_type` - (String) The control library type. - * Constraints: Allowable values are: `predefined`, `custom`. - -* `control_library_version` - (String) The control library version. - * Constraints: The maximum length is `64` characters. The minimum length is `5` characters. The value must match regular expression `/^[a-zA-Z0-9_\\-.]*$/`. - -* `control_parents_count` - (Integer) The number of parent controls in the control library. - -* `controls` - (List) The list of controls in a control library. - * Constraints: The maximum length is `1200` items. The minimum length is `0` items. -Nested schema for **controls**: - * `control_category` - (String) The control category. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,\\-\\s]*$/`. - * `control_description` - (String) The control description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. - * `control_docs` - (List) The control documentation. - Nested schema for **control_docs**: - * `control_docs_id` - (String) The ID of the control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_docs_type` - (String) The type of control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_id` - (String) The control name. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_name` - (String) The ID of the control library that contains the profile. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_parent` - (String) The parent control. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]*/`. - * `control_requirement` - (Boolean) The indication of whether a control can be automated or manually evaluated. - * `control_specifications` - (List) The control specifications. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - Nested schema for **control_specifications**: - * `assessments` - (List) The assessments. - * Constraints: The maximum length is `10` items. The minimum length is `0` items. - Nested schema for **assessments**: - * `assessment_description` - (String) The assessment description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `assessment_id` - (String) The assessment ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_method` - (String) The assessment method. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (String) The assessment type. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_count` - (Integer) The parameter count. - * `parameters` - (List) The parameters. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. - Nested schema for **parameters**: - * `parameter_display_name` - (String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_\\s\\-]*$/`. - * `parameter_type` - (String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - * `assessments_count` - (Integer) The number of assessments. - * `componenet_name` - (String) The component name. - * Constraints: The maximum length is `512` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `component_id` - (String) The component ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `control_specification_description` - (String) The control specifications description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `control_specification_id` - (String) The control specification ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - * `environment` - (String) The control specifications environment. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `responsibility` - (String) The responsibility for managing the control. - * Constraints: Allowable values are: `user`. - * `control_tags` - (List) The control tags. - * Constraints: The list items must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. The maximum length is `512` items. The minimum length is `0` items. - * `status` - (String) The control status. - * Constraints: Allowable values are: `enabled`, `disabled`. - -* `controls_count` - (Integer) The number of controls. - -* `created_by` - (String) The user who created the control library. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `created_on` - (String) The date when the control library was created. - -* `hierarchy_enabled` - (Boolean) The indication of whether hierarchy is enabled for the control library. - -* `id` - (String) The control library ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -* `latest` - (Boolean) The latest version of the control library. - -* `updated_by` - (String) The user who updated the control library. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `updated_on` - (String) The date when the control library was updated. - -* `version_group_label` - (String) The version group label. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - diff --git a/website/docs/d/scc_instance_settings.html.markdown b/website/docs/d/scc_instance_settings.html.markdown deleted file mode 100644 index a4c5673b9d..0000000000 --- a/website/docs/d/scc_instance_settings.html.markdown +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_instance_settings" -description: |- - Manages scc_instance_settings. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_instance_settings - -Provides a read-only data source to retrieve information about scc_instance_settings. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_instance_settings" "scc_instance_settings_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" -} -``` -## Argument Reference - - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `event_notifications` - (List) The Event Notifications settings. -Nested schema for **event_notifications**: - * `instance_crn` - (String) The Event Notifications instance CRN. - * `source_id` - (String) The connected Security and Compliance Center instance CRN. - * `updated_on` - (String) The date when the Event Notifications connection was updated. -* `object_storage` - (List) The Cloud Object Storage settings. -Nested schema for **object_storage**: - * `bucket` - (String) The connected Cloud Object Storage bucket name. - * `bucket_endpoint` - (String) The connected Cloud Object Storage bucket endpoint. - * `bucket_location` - (String) The connected Cloud Object Storage bucket location. - * `instance_crn` - (String) The connected Cloud Object Storage instance CRN. - * `updated_on` - (String) The date when the bucket connection was updated. diff --git a/website/docs/d/scc_latest_reports.html.markdown b/website/docs/d/scc_latest_reports.html.markdown deleted file mode 100644 index 89e163b50a..0000000000 --- a/website/docs/d/scc_latest_reports.html.markdown +++ /dev/null @@ -1,101 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_latest_reports" -description: |- - Get information about scc_latest_reports -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_latest_reports - -Retrieve information about the latest reports from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_latest_reports" "scc_latest_reports" { - instance_id = "00000000-1111-2222-3333-444444444444" - sort = "profile_name" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `sort` - (Optional, String) This field sorts results by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting). - * Constraints: The maximum length is `32` characters. The minimum length is `1` character. The value must match regular expression `/^[\\-]?[a-z0-9_]+$/`. -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_latest_reports. -* `controls_summary` - (List) The compliance stats. -Nested schema for **controls_summary**: - * `compliant_count` - (Integer) The number of compliant checks. - * `not_compliant_count` - (Integer) The number of checks that are not compliant. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of checks. - * `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - * `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - -* `evaluations_summary` - (List) The evaluation stats. -Nested schema for **evaluations_summary**: - * `completed_count` - (Integer) The total number of completed evaluations. - * `error_count` - (Integer) The number of evaluations that started, but did not finish, and ended with errors. - * `failure_count` - (Integer) The number of failed evaluations. - * `pass_count` - (Integer) The number of passed evaluations. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of evaluations. - -* `home_account_id` - (String) The ID of the home account. - -* `reports` - (List) The list of reports. - * Constraints: The maximum length is `1000` items. The minimum length is `0` items. -Nested schema for **reports**: - * `account` - (List) The account that is associated with a report. - Nested schema for **account**: - * `id` - (String) The account ID. - * `name` - (String) The account name. - * `type` - (String) The account type. - * `attachment` - (List) The attachment that is associated with a report. - Nested schema for **attachment**: - * `description` - (String) The description of the attachment. - * `id` - (String) The attachment ID. - * `name` - (String) The name of the attachment. - * `schedule` - (String) The attachment schedule. - * `scope` - (List) The scope of the attachment. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. - Nested schema for **scope**: - * `environment` - (String) The environment that relates to this scope. - * `id` - (String) The unique identifier for this scope. - * `properties` - (List) The properties that are supported for scoping by this environment. - * Constraints: The maximum length is `99999` items. The minimum length is `0` items. - Nested schema for **properties**: - * `name` - (String) The property name. - * `value` - (String) The property value. - * `cos_object` - (String) The Cloud Object Storage object that is associated with the report. - * `created_on` - (String) The date when the report was created. - * `group_id` - (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs. - * `id` - (String) The ID of the report. - * `instance_id` - (String) Instance ID. - * `profile` - (List) The profile information. - Nested schema for **profile**: - * `id` - (String) The profile ID. - * `name` - (String) The profile name. - * `version` - (String) The profile version. - * `scan_time` - (String) The date when the scan was run. - * `type` - (String) The type of the scan. - -* `score` - (List) The compliance score. -Nested schema for **score**: - * `passed` - (Integer) The number of successful evaluations. - * `percent` - (Integer) The percentage of successful evaluations. - * `total_count` - (Integer) The total number of evaluations. - diff --git a/website/docs/d/scc_profile.html.markdown b/website/docs/d/scc_profile.html.markdown deleted file mode 100644 index 6a027165ce..0000000000 --- a/website/docs/d/scc_profile.html.markdown +++ /dev/null @@ -1,159 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_profile" -description: |- - Get information about scc_profile -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_profile - -Retrieve information about a profile from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_profile" "scc_profile" { - instance_id = "00000000-1111-2222-3333-444444444444" - profile_id = ibm_scc_profile.scc_profile_instance.profile_id -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `profile_id` - (Required, Forces new resource, String) The profile ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `attachments_count` - (Integer) The number of attachments related to this profile. - -* `control_parents_count` - (Integer) The number of parent controls for the profile. - -* `controls` - (List) The array of controls that are used to create the profile. - * Constraints: The maximum length is `600` items. The minimum length is `0` items. - - Nested schema for **controls**: - * `control_category` - (String) The control category. - * Constraints: The maximum length is `512` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_description` - (String) The control description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_docs` - (List) The control documentation. - Nested schema for **control_docs**: - * `control_docs_id` - (String) The ID of the control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_docs_type` - (String) The type of control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_id` - (String) The unique ID of the control library that contains the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[A-Z0-9]+/`. - * `control_library_id` - (String) The ID of the control library that contains the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_library_version` - (String) The most recent version of the control library. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_name` - (String) The control name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_parent` - (String) The parent control. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]*/`. - * `control_requirement` - (Boolean) Is this a control that can be automated or manually evaluated. - * `control_specifications` - (List) The control specifications. - * Constraints: The maximum length is `400` items. The minimum length is `0` items. - - Nested schema for **control_specifications**: - * `assessments` - (List) The assessments. - * Constraints: The maximum length is `10` items. The minimum length is `0` items. - Nested schema for **assessments**: - * `assessment_description` - (String) The assessment description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `assessment_id` - (String) The assessment ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_method` - (String) The assessment method. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (String) The assessment type. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_count` - (Integer) The parameter count. - * `parameters` - (List) The parameters. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. - - Nested schema for **parameters**: - * `parameter_display_name` - (String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_\\s\\-]*$/`. - * `parameter_type` - (String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - * `assessments_count` - (Integer) The number of assessments. - * `componenet_name` - (String) The component name. - * Constraints: The maximum length is `512` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `component_id` - (String) The component ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `control_specification_description` - (String) The control specifications description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `control_specification_id` - (String) The control specification ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - * `environment` - (String) The control specifications environment. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `responsibility` - (String) The responsibility for managing the control. - * Constraints: Allowable values are: `user`. - * `control_specifications_count` - (Integer) The number of control specifications. - -* `controls_count` - (Integer) The number of controls for the profile. - -* `created_by` - (String) The user who created the profile. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `created_on` - (String) The date when the profile was created. - -* `default_parameters` - (List) The default parameters of the profile. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. - - Nested schema for **default_parameters**: - * `assessment_id` - (String) The implementation ID of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (String) The type of the implementation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_default_value` - (String) The default value of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. - * `parameter_display_name` - (String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_]*$/`. - * `parameter_type` - (String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - -* `hierarchy_enabled` - (Boolean) The indication of whether hierarchy is enabled for the profile. - -* `id` - (String) The unique ID of the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `instance_id` - (String) The instance ID. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `latest` - (Boolean) The latest version of the profile. - -* `profile_description` - (String) The profile description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `profile_name` - (String) The profile name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `profile_type` - (String) The profile type, such as custom or predefined. - * Constraints: Allowable values are: `predefined`, `custom`. - -* `profile_version` - (String) The version status of the profile. - * Constraints: The maximum length is `64` characters. The minimum length is `5` characters. The value must match regular expression `/^[a-zA-Z0-9_\\-.]*$/`. - -* `updated_by` - (String) The user who updated the profile. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `updated_on` - (String) The date when the profile was updated. - -* `version_group_label` - (String) The version group label of the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - diff --git a/website/docs/d/scc_profile_attachment.html.markdown b/website/docs/d/scc_profile_attachment.html.markdown deleted file mode 100644 index a050752c39..0000000000 --- a/website/docs/d/scc_profile_attachment.html.markdown +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_profile_attachment" -description: |- - Get information about scc_profile_attachment -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_profile_attachment - -Retrieve information about a profile attachment from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_profile_attachment" "scc_profile_attachment" { - instance_id = "00000000-1111-2222-3333-444444444444" - attachment_id = "attachment_id" - profile_id = ibm_scc_profile_attachment.scc_profile_attachment.profiles_id -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `attachment_id` - (Required, Forces new resource, String) The attachment ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. -* `profile_id` - (Required, Forces new resource, String) The profile ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_profile_attachment. -* `account_id` - (String) The account ID that is associated to the attachment. - * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -* `attachment_item_id` - (String) The ID of the attachment. - * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -* `attachment_parameters` - (List) The profile parameters for the attachment. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. -Nested schema for **attachment_parameters**: - * `assessment_id` - (String) The implementation ID of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (String) The type of the implementation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_display_name` - (String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_]*$/`. - * `parameter_type` - (String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - * `parameter_value` - (String) The value of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. - -* `created_by` - (String) The user who created the attachment. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `created_on` - (String) The date when the attachment was created. - -* `description` - (String) The description for the attachment. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - -* `instance_id` - (String) The instance ID of the account that is associated to the attachment. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. - -* `last_scan` - (List) The details of the last scan of an attachment. -Nested schema for **last_scan**: - * `id` - (String) The ID of the last scan of an attachment. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `status` - (String) The status of the last scan of an attachment. - * Constraints: Allowable values are: `in_progress`, `completed`. - * `time` - (String) The time when the last scan started. - -* `name` - (String) The name of the attachment. - * Constraints: The maximum length is `128` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -* `next_scan_time` - (String) The start time of the next scan. - -* `notifications` - (List) The request payload of the attachment notifications. -Nested schema for **notifications**: - * `controls` - (List) The failed controls. - Nested schema for **controls**: - * `failed_control_ids` - (List) The failed control IDs. - * Constraints: The list items must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. The maximum length is `512` items. The minimum length is `0` items. - * `threshold_limit` - (Integer) The threshold limit. - * `enabled` - (Boolean) enabled notifications. - -* `profile_id` - (String) The ID of the profile that is specified in the attachment. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - -* `schedule` - (String) The schedule of an attachment evaluation. - * Constraints: Allowable values are: `daily`, `every_7_days`, `every_30_days`. - -* `scope` - (List) The scope payload for the multi cloud feature. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. -Nested schema for **scope**: - * `environment` - (String) The environment that relates to this scope. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `properties` - (List) The properties supported for scoping by this environment. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. - Nested schema for **properties**: - * `name` - (String) The name of the property. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) The value of the property. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `status` - (String) The status of an attachment evaluation. - * Constraints: Allowable values are: `enabled`, `disabled`. - -* `updated_by` - (String) The user who updated the attachment. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `updated_on` - (String) The date when the attachment was updated. - diff --git a/website/docs/d/scc_profiles.html.markdown b/website/docs/d/scc_profiles.html.markdown deleted file mode 100644 index 6bb501b060..0000000000 --- a/website/docs/d/scc_profiles.html.markdown +++ /dev/null @@ -1,73 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_profiles" -description: |- - Get information about scc_profiles -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_profiles - -Retrieve information about a list of profiles from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_profiles" "scc_profiles_instace" { - instance_id = "00000000-1111-2222-3333-444444444444" - profile_type = ibm_scc_profile.scc_profile_instance.profile_id -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `profile_type` - (Optional, Forces new resource, String) The type of profiles to query. - * Constraints: Allowable values are: `predefined`, `custom`. -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `profiles` - (List) The list of profiles. - - Nested schema for **profiles**: - * `id` - The unique identifier of the scc_profile. - - * `attachments_count` - (Integer) The number of attachments related to this profile. - - * `control_parents_count` - (Integer) The number of parent controls for the profile. - - * `instance_id` - (String) The instance ID. - - * `latest` - (Boolean) The latest version of the profile. - - * `profile_description` - (String) The profile description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - - * `profile_name` - (String) The profile name. - - - * `profile_type` - (String) The profile type, such as custom or predefined. - - * `profile_version` - (String) The version status of the profile. - - * `version_group_label` - (String) The version group label of the profile. - - * `latest` - (Boolean) The latest version of the profile. - - * `hierarchy_enabled` - (Boolean) The indication of whether hierarchy is enabled for the profile. - - * `created_by` - (String) The user who created the profile. - - * `created_on` - (String) The date when the profile was created. - - * `controls_count` - (Integer) The number of controls for the profile. - - * `control_parents_count` - (Integer) The number of parent controls for the profile. - - * `attachments_count` - (Integer) The number of attachments related to this profile. \ No newline at end of file diff --git a/website/docs/d/scc_provider_type.html.markdown b/website/docs/d/scc_provider_type.html.markdown deleted file mode 100644 index 2e80352b71..0000000000 --- a/website/docs/d/scc_provider_type.html.markdown +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_provider_type" -description: |- - Get information about scc_provider_type -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_provider_type - -Retrieve information about a provider type from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_provider_type" "scc_provider_type" { - provider_type_id = "provider_type_id" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `provider_type_id` - (Required, Forces new resource, String) The provider type ID. - * Constraints: The maximum length is `36` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9 ,\\-_]+$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_provider_type. -* `attributes` - (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, `{type:"", display_name:""}`. **NOTE;** If the provider type is s2s-enabled, which means that if the `s2s_enabled` field is set to `true`, then a CRN field of type text is required in the attributes value object. - -* `created_at` - (String) The time when the resource was created. - -* `data_type` - (String) The format of the results that a provider supports. - -* `description` - (String) The provider type description. - -* `icon` - (String) The icon of a provider in .svg format that is encoded as a base64 string. - -* `id` - (String) The unique identifier of the provider type. - -* `instance_limit` - (Integer) The maximum number of instances that can be created for the provider type. - -* `label` - (List) The label that is associated with the provider type. -Nested schema for **label**: - * `text` - (String) The text of the label. - * `tip` - (String) The text to be shown when user hover overs the label. - -* `mode` - (String) The mode that is used to get results from provider (`PUSH` or `PULL`). - -* `name` - (String) The name of the provider type. - -* `s2s_enabled` - (Boolean) A boolean that indicates whether the provider type is s2s-enabled. - -* `type` - (String) The type of the provider type. - -* `updated_at` - (String) The time when the resource was updated. - diff --git a/website/docs/d/scc_provider_type_collection.html.markdown b/website/docs/d/scc_provider_type_collection.html.markdown deleted file mode 100644 index aef7017fc2..0000000000 --- a/website/docs/d/scc_provider_type_collection.html.markdown +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_provider_type_collection" -description: |- - Get information about scc_provider_type_collection -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_provider_type_collection - -Retrieve information about a provider type collection from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_provider_type_collection" "scc_provider_type_collection" { -} -``` - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_provider_type_collection. -* `provider_types` - (List) The array of provder type. - * Constraints: The minimum length is `0` items. -Nested schema for **provider_types**: - * `attributes` - (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, `{type:"", display_name:""}`. **NOTE;** If the provider type is s2s-enabled, which means that if the `s2s_enabled` field is set to `true`, then a CRN field of type text is required in the attributes value object. - * `created_at` - (String) The time when the resource was created. - * `data_type` - (String) The format of the results that a provider supports. - * `description` - (String) The provider type description. - * `icon` - (String) The icon of a provider in .svg format that is encoded as a base64 string. - * `id` - (String) The unique identifier of the provider type. - * `instance_limit` - (Integer) The maximum number of instances that can be created for the provider type. - * `label` - (List) The label that is associated with the provider type. - Nested schema for **label**: - * `text` - (String) The text of the label. - * `tip` - (String) The text to be shown when user hover overs the label. - * `mode` - (String) The mode that is used to get results from provider (`PUSH` or `PULL`). - * `name` - (String) The name of the provider type. - * `s2s_enabled` - (Boolean) A boolean that indicates whether the provider type is s2s-enabled. - * `type` - (String) The type of the provider type. - * `updated_at` - (String) The time when the resource was updated. - diff --git a/website/docs/d/scc_provider_type_instance.html.markdown b/website/docs/d/scc_provider_type_instance.html.markdown deleted file mode 100644 index 8ee37657cf..0000000000 --- a/website/docs/d/scc_provider_type_instance.html.markdown +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_provider_type_instance" -description: |- - Get information about scc_provider_type_instance -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_provider_type_instance - -Retrieve information about a provider type instance from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_provider_type_instance" "scc_provider_type_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - provider_type_id = ibm_scc_provider_type_instance.scc_provider_type_instance.provider_type_id - provider_type_instance_id = ibm_scc_provider_type_instance.scc_provider_type_instance_instance.providerTypeInstanceItem_id -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `provider_type_id` - (Required, Forces new resource, String) The provider type ID. - * Constraints: The maximum length is `36` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9 ,\\-_]+$/`. -* `provider_type_instance_id` - (Required, Forces new resource, String) The provider type instance ID. - * Constraints: The maximum length is `36` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9 ,\\-_]+$/` - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_provider_type_instance. -* `attributes` - (List) The attributes for connecting to the provider type instance. -Nested schema for **attributes**: - -* `created_at` - (String) The time when the resource was created. - -* `name` - (String) The name of the provider type instance. - -* `provider_type_instance_item_id` - (String) The unique identifier of the provider type instance. - -* `type` - (String) The type of the provider type. - -* `updated_at` - (String) The time when the resource was updated. - diff --git a/website/docs/d/scc_provider_types.html.markdown b/website/docs/d/scc_provider_types.html.markdown deleted file mode 100644 index fa1e3faa5b..0000000000 --- a/website/docs/d/scc_provider_types.html.markdown +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_provider_types" -description: |- - Get information about various scc_provider_types -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_provider_types - -Retrieve information about a provider type from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_provider_types" "scc_provider_types_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. - - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `provider_types` - (List) The list of provider_types. - -* `id` - The unique identifier of the scc_provider_type. - -* `type` - (String) The type of the provider type. - -* `name` - (String) The name of the provider type. - -* `description` - (String) The provider type description. - -* `s2s_enabled` - (Boolean) A boolean that indicates whether the provider type is s2s-enabled. - - **NOTE;** If the provider type is s2s-enabled, which means that if the `s2s_enabled` field is set to `true`, then a CRN field of type text is required in the attributes value object when creating a `ibm_scc_provider_type_instance` - -* `attributes` - (Map) The attributes that are required when you're creating an instance of a provider type. The attributes field can have multiple keys in its value. Each of those keys has a value object that includes the type, and display name as keys. For example, `{type:"", display_name:""}`. - -* `created_at` - (String) The time when the resource was created. - -* `data_type` - (String) The format of the results that a provider supports. - -* `icon` - (String) The icon of a provider in .svg format that is encoded as a base64 string. - -* `instance_limit` - (Integer) The maximum number of instances that can be created for the provider type. - -* `label` - (List) The label that is associated with the provider type. -Nested schema for **label**: - * `text` - (String) The text of the label. - * `tip` - (String) The text to be shown when user hover overs the label. - -* `mode` - (String) The mode that is used to get results from provider (`PUSH` or `PULL`). - -* `updated_at` - (String) The time when the resource was updated. - diff --git a/website/docs/d/scc_report.html.markdown b/website/docs/d/scc_report.html.markdown deleted file mode 100644 index ad19872854..0000000000 --- a/website/docs/d/scc_report.html.markdown +++ /dev/null @@ -1,79 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report" -description: |- - Get information about scc_report -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report - -Retrieve information about a report from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report" "scc_report" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report. -* `account` - (List) The account that is associated with a report. -Nested schema for **account**: - * `id` - (String) The account ID. - * `name` - (String) The account name. - * `type` - (String) The account type. - -* `attachment` - (List) The attachment that is associated with a report. -Nested schema for **attachment**: - * `description` - (String) The description of the attachment. - * `id` - (String) The attachment ID. - * `name` - (String) The name of the attachment. - * `schedule` - (String) The attachment schedule. - * `scope` - (List) The scope of the attachment. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. - Nested schema for **scope**: - * `environment` - (String) The environment that relates to this scope. - * `id` - (String) The unique identifier for this scope. - * `properties` - (List) The properties that are supported for scoping by this environment. - * Constraints: The maximum length is `99999` items. The minimum length is `0` items. - Nested schema for **properties**: - * `name` - (String) The property name. - * `value` - (String) The property value. - -* `cos_object` - (String) The Cloud Object Storage object that is associated with the report. - -* `created_on` - (String) The date when the report was created. - -* `group_id` - (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs. - -* `id` - (String) The ID of the report. - -* `instance_id` - (String) Instance ID. - -* `profile` - (List) The profile information. -Nested schema for **profile**: - * `id` - (String) The profile ID. - * `name` - (String) The profile name. - * `version` - (String) The profile version. - -* `scan_time` - (String) The date when the scan was run. - -* `type` - (String) The type of the scan. - diff --git a/website/docs/d/scc_report_controls.html.markdown b/website/docs/d/scc_report_controls.html.markdown deleted file mode 100644 index 78dfba6005..0000000000 --- a/website/docs/d/scc_report_controls.html.markdown +++ /dev/null @@ -1,109 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_controls" -description: |- - Get information about scc_report_controls -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_controls - -Retrieve information about report controls from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_controls" "scc_report_controls" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" - status = "compliant" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `control_category` - (Optional, String) A control category value. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `control_description` - (Optional, String) The description of the control. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\s]+$/`. -* `control_id` - (Optional, String) The ID of the control. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `control_name` - (Optional, String) The name of the control. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `sort` - (Optional, String) This field sorts controls by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting). - * Constraints: Allowable values are: `control_name`, `control_category`, `status`. -* `status` - (Optional, String) The compliance status value. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_controls. -* `compliant_count` - (Integer) The number of compliant checks. - -* `controls` - (List) The list of controls that are in the report. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. -Nested schema for **controls**: - * `compliant_count` - (Integer) The number of compliant checks. - * `control_category` - (String) The control category. - * `control_description` - (String) The control description. - * `control_library_id` - (String) The control library ID. - * `control_library_version` - (String) The control library version. - * `control_name` - (String) The control name. - * `control_path` - (String) The control path. - * `control_specifications` - (List) The list of specifications that are on the page. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - Nested schema for **control_specifications**: - * `assessments` - (List) The list of assessments. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - Nested schema for **assessments**: - * `assessment_description` - (String) The assessment description. - * `assessment_id` - (String) The assessment ID. - * `assessment_method` - (String) The assessment method. - * `assessment_type` - (String) The assessment type. - * `parameter_count` - (Integer) The number of parameters of this assessment. - * `parameters` - (List) The list of parameters of this assessment. - * Constraints: The maximum length is `1000` items. The minimum length is `0` items. - Nested schema for **parameters**: - * `parameter_display_name` - (String) The parameter display name. - * `parameter_name` - (String) The parameter name. - * `parameter_type` - (String) The parameter type. - * `parameter_value` - (String) The property value. - * `compliant_count` - (Integer) The number of compliant checks. - * `component_id` - (String) The component ID. - * `control_specification_description` - (String) The component description. - * `control_specification_id` - (String) The control specification ID. - * `environment` - (String) The environment. - * `not_compliant_count` - (Integer) The number of checks that are not compliant. - * `responsibility` - (String) The responsibility for managing control specifications. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of checks. - * `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - * `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - * `id` - (String) The control ID. - * `not_compliant_count` - (Integer) The number of checks that are not compliant. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of checks. - * `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - * `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - -* `home_account_id` - (String) The ID of the home account. - -* `not_compliant_count` - (Integer) The number of checks that are not compliant. - -* `total_count` - (Integer) The total number of checks. - -* `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - -* `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - diff --git a/website/docs/d/scc_report_evaluations.html.markdown b/website/docs/d/scc_report_evaluations.html.markdown deleted file mode 100644 index d357ce51c7..0000000000 --- a/website/docs/d/scc_report_evaluations.html.markdown +++ /dev/null @@ -1,96 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_evaluations" -description: |- - Get information about scc_report_evaluations -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_evaluations - -Retrieve information about report evaluations from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_evaluations" "scc_report_evaluations" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" - status = "failure" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `assessment_id` - (Optional, String) The ID of the assessment. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `component_id` - (Optional, String) The ID of component. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9.\\-]+$/`. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `status` - (Optional, String) The evaluation status value. - * Constraints: Allowable values are: `pass`, `failure`, `error`, `skipped`. -* `target_id` - (Optional, String) The ID of the evaluation target. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `target_name` - (Optional, String) The name of the evaluation target. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_evaluations. -* `evaluations` - (List) The list of evaluations that are on the page. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. -Nested schema for **evaluations**: - * `assessment` - (List) The control specification assessment. - Nested schema for **assessment**: - * `assessment_description` - (String) The assessment description. - * `assessment_id` - (String) The assessment ID. - * `assessment_method` - (String) The assessment method. - * `assessment_type` - (String) The assessment type. - * `parameter_count` - (Integer) The number of parameters of this assessment. - * `parameters` - (List) The list of parameters of this assessment. - * Constraints: The maximum length is `1000` items. The minimum length is `0` items. - Nested schema for **parameters**: - * `parameter_display_name` - (String) The parameter display name. - * `parameter_name` - (String) The parameter name. - * `parameter_type` - (String) The parameter type. - * `parameter_value` - (String) The property value. - * `component_id` - (String) The component ID. - * `control_id` - (String) The control ID. **Deprecated** - * `details` - (List) The evaluation details. - Nested schema for **details**: - * `properties` - (List) The evaluation properties. - * Constraints: The maximum length is `1000` items. The minimum length is `0` items. - Nested schema for **properties**: - * `expected_value` - (String) The property value. - * `found_value` - (String) The property value. - * `operator` - (String) The property operator. - * `property` - (String) The property name. - * `property_description` - (String) The property description. - * `evaluate_time` - (String) The time when the evaluation was made. - * `home_account_id` - (String) The ID of the home account. - * `reason` - (String) The reason for the evaluation failure. - * `report_id` - (String) The ID of the report that is associated to the evaluation. - * `status` - (String) The allowed values of an evaluation status. - * Constraints: Allowable values are: `pass`, `failure`, `error`, `skipped`. - * `target` - (List) The evaluation target. - Nested schema for **target**: - * `account_id` - (String) The target account ID. - * `id` - (String) The target ID. - * `resource_crn` - (String) The target resource CRN. - * `resource_name` - (String) The target resource name. - * `service_name` - (String) The target service name. - -* `first` - (List) The page reference. -Nested schema for **first**: - * `href` - (String) The URL for the first and next page. - -* `home_account_id` - (String) The ID of the home account. - diff --git a/website/docs/d/scc_report_resources.html.markdown b/website/docs/d/scc_report_resources.html.markdown deleted file mode 100644 index e9258f50a9..0000000000 --- a/website/docs/d/scc_report_resources.html.markdown +++ /dev/null @@ -1,76 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_resources" -description: |- - Get information about scc_report_resources -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_resources - -Retrieve information about report resources from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_resources" "scc_report_resources" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" - status = "compliant" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `account_id` - (Optional, String) The ID of the account owning a resource. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `component_id` - (Optional, String) The ID of component. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9.\\-]+$/`. -* `id` - (Optional, String) The ID of the resource. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `resource_name` - (Optional, String) The name of the resource. - * Constraints: The maximum length is `1024` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `sort` - (Optional, String) This field sorts resources by using a valid sort field. To learn more, see [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting). - * Constraints: Allowable values are: `account_id`, `component_id`, `resource_name`, `status`. -* `status` - (Optional, String) The compliance status value. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_resources. -* `first` - (List) The page reference. -Nested schema for **first**: - * `href` - (String) The URL for the first and next page. - -* `home_account_id` - (String) The ID of the home account. - -* `resources` - (List) The list of resource evaluation summaries that are on the page. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. -Nested schema for **resources**: - * `account` - (List) The account that is associated with a report. - Nested schema for **account**: - * `id` - (String) The account ID. - * `name` - (String) The account name. - * `type` - (String) The account type. - * `completed_count` - (Integer) The total number of completed evaluations. - * `component_id` - (String) The ID of the component. - * `environment` - (String) The environment. - * `error_count` - (Integer) The number of evaluations that started, but did not finish, and ended with errors. - * `failure_count` - (Integer) The number of failed evaluations. - * `id` - (String) The resource CRN. - * `pass_count` - (Integer) The number of passed evaluations. - * `report_id` - (String) The ID of the report. - * `resource_name` - (String) The resource name. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of evaluations. - diff --git a/website/docs/d/scc_report_rule.html.markdown b/website/docs/d/scc_report_rule.html.markdown deleted file mode 100644 index 9056e60285..0000000000 --- a/website/docs/d/scc_report_rule.html.markdown +++ /dev/null @@ -1,60 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_rule" -description: |- - Get information about scc_report_rule -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_rule - -Retrieve information about a report rule from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_rule" "scc_report_rule" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" - rule_id = "rule-8d444f8c-fd1d-48de-bcaa-f43732568761" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `rule_id` - (Required, Forces new resource, String) The ID of a rule in a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_rule. -* `account_id` - (String) The rule account ID. - -* `created_by` - (String) The ID of the user who created the rule. - -* `created_on` - (String) The date when the rule was created. - -* `description` - (String) The rule description. - -* `id` - (String) The rule ID. - -* `labels` - (List) The rule labels. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - -* `type` - (String) The rule type. - -* `updated_by` - (String) The ID of the user who updated the rule. - -* `updated_on` - (String) The date when the rule was updated. - -* `version` - (String) The rule version. - diff --git a/website/docs/d/scc_report_summary.html.markdown b/website/docs/d/scc_report_summary.html.markdown deleted file mode 100644 index e6a444e1bd..0000000000 --- a/website/docs/d/scc_report_summary.html.markdown +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_summary" -description: |- - Get information about scc_report_summary -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_summary - -Retrieve information about a report summary from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_summary" "scc_report_summary" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_summary. -* `account` - (List) The account that is associated with a report. -Nested schema for **account**: - * `id` - (String) The account ID. - * `name` - (String) The account name. - * `type` - (String) The account type. - -* `controls` - (List) The compliance stats. -Nested schema for **controls**: - * `compliant_count` - (Integer) The number of compliant checks. - * `not_compliant_count` - (Integer) The number of checks that are not compliant. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of checks. - * `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - * `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - -* `evaluations` - (List) The evaluation stats. -Nested schema for **evaluations**: - * `completed_count` - (Integer) The total number of completed evaluations. - * `error_count` - (Integer) The number of evaluations that started, but did not finish, and ended with errors. - * `failure_count` - (Integer) The number of failed evaluations. - * `pass_count` - (Integer) The number of passed evaluations. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of evaluations. - -* `isntance_id` - (String) Instance ID. - -* `resources` - (List) The resource summary. -Nested schema for **resources**: - * `compliant_count` - (Integer) The number of compliant checks. - * `not_compliant_count` - (Integer) The number of checks that are not compliant. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `top_failed` - (List) The top 10 resources that have the most failures. - * Constraints: The maximum length is `10` items. The minimum length is `0` items. - Nested schema for **top_failed**: - * `account` - (String) The account that owns the resource. - * `completed_count` - (Integer) The total number of completed evaluations. - * `error_count` - (Integer) The number of evaluations that started, but did not finish, and ended with errors. - * `failure_count` - (Integer) The number of failed evaluations. - * `id` - (String) The resource ID. - * `name` - (String) The resource name. - * `pass_count` - (Integer) The number of passed evaluations. - * `service` - (String) The service that is managing the resource. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `tags` - (List) The collection of different types of tags. - Nested schema for **tags**: - * `access` - (List) The collection of access tags. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - * `service` - (List) The collection of service tags. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - * `user` - (List) The collection of user tags. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - * `total_count` - (Integer) The total number of evaluations. - * `total_count` - (Integer) The total number of checks. - * `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - * `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - -* `score` - (List) The compliance score. -Nested schema for **score**: - * `passed` - (Integer) The number of successful evaluations. - * `percent` - (Integer) The percentage of successful evaluations. - * `total_count` - (Integer) The total number of evaluations. - diff --git a/website/docs/d/scc_report_tags.html.markdown b/website/docs/d/scc_report_tags.html.markdown deleted file mode 100644 index 0eeed23c4c..0000000000 --- a/website/docs/d/scc_report_tags.html.markdown +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_tags" -description: |- - Get information about scc_report_tags -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_tags - -Retrieve information about report tags from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_tags" "scc_report_tags" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_tags. -* `tags` - (List) The collection of different types of tags. -Nested schema for **tags**: - * `access` - (List) The collection of access tags. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - * `service` - (List) The collection of service tags. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - * `user` - (List) The collection of user tags. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - diff --git a/website/docs/d/scc_report_violation_drift.html.markdown b/website/docs/d/scc_report_violation_drift.html.markdown deleted file mode 100644 index e9cab490de..0000000000 --- a/website/docs/d/scc_report_violation_drift.html.markdown +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_report_violation_drift" -description: |- - Get information about scc_report_violation_drift -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_report_violation_drift - -Retrieve information about a report violation drift from a read-only data source. Then, yo can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_report_violation_drift" "scc_report_violation_drift" { - instance_id = "00000000-1111-2222-3333-444444444444" - report_id = "report_id" -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `report_id` - (Required, Forces new resource, String) The ID of the scan that is associated with a report. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9\\-]+$/`. -* `scan_time_duration` - (Optional, Integer) The duration of the `scan_time` timestamp in number of days. - * Constraints: The default value is `0`. The maximum value is `366`. The minimum value is `0`. - - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_report_violation_drift. -* `data_points` - (List) The list of report violations data points. - * Constraints: The maximum length is `1000` items. The minimum length is `0` items. -Nested schema for **data_points**: - * `controls` - (List) The compliance stats. - Nested schema for **controls**: - * `compliant_count` - (Integer) The number of compliant checks. - * `not_compliant_count` - (Integer) The number of checks that are not compliant. - * `status` - (String) The allowed values of an aggregated status for controls, specifications, assessments, and resources. - * Constraints: Allowable values are: `compliant`, `not_compliant`, `unable_to_perform`, `user_evaluation_required`. - * `total_count` - (Integer) The total number of checks. - * `unable_to_perform_count` - (Integer) The number of checks that are unable to perform. - * `user_evaluation_required_count` - (Integer) The number of checks that require a user evaluation. - * `report_group_id` - (String) The group ID that is associated with the report. The group ID combines profile, scope, and attachment IDs. - * `report_id` - (String) The ID of the report. - * `scan_time` - (String) The date when the scan was run. - -* `home_account_id` - (String) The ID of the home account. - diff --git a/website/docs/d/scc_rule.html.markdown b/website/docs/d/scc_rule.html.markdown deleted file mode 100644 index 8c3517f646..0000000000 --- a/website/docs/d/scc_rule.html.markdown +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_rule" -description: |- - Get information about scc_rule -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_rule - -Retrieve information about a rule from a read-only data source. Then, you can reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_rule" "scc_rule" { - instance_id = "00000000-1111-2222-3333-444444444444" - rule_id = ibm_scc_rule.scc_rule_instance.rule_id -} -``` - -## Argument Reference - -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `rule_id` - (Required, Forces new resource, String) The ID of the corresponding rule. - * Constraints: The maximum length is `41` characters. The minimum length is `41` characters. The value must match regular expression `/rule-[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/`. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `id` - The unique identifier of the scc_rule. -* `account_id` - (String) The account ID. - * Constraints: The maximum length is `32` characters. The minimum length is `3` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `created_by` - (String) The user who created the rule. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `created_on` - (String) The date when the rule was created. - -* `description` - (String) The details of a rule's response. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `id` - (String) The rule ID. - * Constraints: The maximum length is `41` characters. The minimum length is `41` characters. The value must match regular expression `/rule-[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}/`. - -* `import` - (List) The collection of import parameters. -Nested schema for **import**: - * `parameters` - (List) The list of import parameters. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. - Nested schema for **parameters**: - * `description` - (String) The propery description. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `display_name` - (String) The display name of the property. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `name` - (String) The import parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `type` - (String) The property type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. The maximum length is `11` characters. The minimum length is `6` characters. The value must match regular expression `/[A-Za-z]+/`. - -* `labels` - (List) The list of labels. - * Constraints: The list items must match regular expression `/[A-Za-z0-9]+/`. The maximum length is `32` items. The minimum length is `0` items. - -* `required_config` - (List) The required configurations. -Nested schema for **required_config**: - * `and` - (List) The `AND` required configurations. - * Constraints: The maximum length is `64` items. The minimum length is `1` item. - Nested schema for **and**: - * `and` - (List) The `AND` required configurations. - * Constraints: The maximum length is `64` items. The minimum length is `1` item. - Nested schema for **and**: - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `or` - (List) The `OR` required configurations. - * Constraints: The maximum length is `64` items. The minimum length is `1` item. - Nested schema for **or**: - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `or` - (List) The `OR` required configurations. - * Constraints: The maximum length is `64` items. The minimum length is `1` item. - Nested schema for **or**: - * `and` - (List) The `AND` required configurations. - * Constraints: The maximum length is `64` items. The minimum length is `1` item. - Nested schema for **and**: - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `or` - (List) The `OR` required configurations. - * Constraints: The maximum length is `64` items. The minimum length is `1` item. - Nested schema for **or**: - * `description` - (String) The required config description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. The maximum length is `23` characters. The minimum length is `7` characters. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - * `property` - (String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (String) Schema for any JSON type. - -* `target` - (List) The rule target. -Nested schema for **target**: - * `additional_target_attributes` - (List) The list of targets supported properties. - * Constraints: The maximum length is `99999` items. The minimum length is `0` items. - Nested schema for **additional_target_attributes**: - * `name` - (String) The additional target attribute name. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (String) The operator. - * Constraints: Allowable values are: `string_equals`, `string_not_equals`, `string_match`, `string_not_match`, `string_contains`, `string_not_contains`, `num_equals`, `num_not_equals`, `num_less_than`, `num_less_than_equals`, `num_greater_than`, `num_greater_than_equals`, `is_empty`, `is_not_empty`, `is_true`, `is_false`, `strings_in_list`, `strings_allowed`, `strings_required`, `ips_in_range`, `ips_equals`, `ips_not_equals`, `days_less_than`. - * `value` - (String) The value. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `resource_kind` - (String) The target resource kind. - * Constraints: The maximum length is `99999` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `service_display_name` - (String) The display name of the target service. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `service_name` - (String) The target service name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `type` - (String) The rule type (allowable values are `user_defined` or `system_defined`). - * Constraints: Allowable values are: `user_defined`, `system_defined`. The maximum length is `14` characters. The minimum length is `12` characters. The value must match regular expression `/[A-Za-z]+_[A-Za-z]+/`. - -* `updated_by` - (String) The user who modified the rule. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -* `updated_on` - (String) The date when the rule was modified. - -* `version` - (String) The version number of a rule. - * Constraints: The maximum length is `10` characters. The minimum length is `5` characters. The value must match regular expression `/^[0-9][0-9.]*$/`. - diff --git a/website/docs/d/scc_scope.html.markdown b/website/docs/d/scc_scope.html.markdown deleted file mode 100644 index 9abec354a7..0000000000 --- a/website/docs/d/scc_scope.html.markdown +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_scope" -description: |- - Get information about a Security and Compliance Center scope. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_scope - -Provides a read-only data source to retrieve information about scc_scope. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_scope" "scc_scope" { - instance_id = "00000000-1111-2222-3333-444444444444" - scope_id = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" -} -``` -## Argument Reference -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `scope_id` - (Required, Forces new resource, String) THe ID of the SCC instance scope in a particular region. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. -* `account_id` - (String) The ID of the IBM account associated with the scope. - -* `attachment_count` - (Integer) The number of `scc_profile_attachment` using the scope. - -* `created_by` - (String) The user who created the scope. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `created_on` - (String) The date when the scope was created. - -* `description` - (String) The details of the scope - -* `exclusions` - (List) A list of excluded targets from the scope. -Nested schema for **exclusions**: - * `account_id` - (String) The ID of the account that was excluded. - * `resource_group_id` - (String) The ID of the resource group that was excluded. - * `account_group_id` - (String) The ID of the account group in an enterprise that was excluded. - -* `id` - (String) The scope ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -* `name` - (String) The name of the scope. - -* `properties` - (List) The properties of the scope. -Nested schema for **properties**: - * `account_group_id` - (String) The ID of the account group in an enterprise. - * `account_id` - (String) The ID of the account. - * `enterprise_id` - (String) The ID of the enterprise. - * `ibm_facts_api_instance_id` - (String) The ID of the `scc_provider_type_instance` that is a provider type `ibm_cloud_facts_api`. - * `resource_group_id` - (String) The ID of the resource group tied to an account. - -* `updated_by` - (String) The user who updated the control library. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - -* `updated_on` - (String) The date when the control library was updated. diff --git a/website/docs/d/scc_scope_collection.html.markdown b/website/docs/d/scc_scope_collection.html.markdown deleted file mode 100644 index ab9de462e8..0000000000 --- a/website/docs/d/scc_scope_collection.html.markdown +++ /dev/null @@ -1,60 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_scope_collection" -description: |- - Get information about a list of Security and Compliance Center scopes. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_scope_collection - -Provides a read-only data source to retrieve information about scc_scope. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -data "ibm_scc_scope_collection" "scc_scope_collection" { - instance_id = "00000000-1111-2222-3333-444444444444" -} -``` -## Argument Reference -You can specify the following arguments for this data source. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. - -## Attribute Reference - -After your data source is created, you can read values from the following attributes. - -* `scopes` - (List) A list of scope that accessible to the user. -Nested schema for **scopes**: - * `account_id` - (String) The ID of the IBM account associated with the scope. - - * `attachment_count` - (Integer) The number of `scc_profile_attachment` using the scope. - - * `created_by` - (String) The user who created the scope. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - - * `created_on` - (String) The date when the scope was created. - - * `description` - (String) The details of the scope. - - * `id` - (String) The scope ID. - - * `instance_id` - (String) The ID of the SCC instance tied to the scope. - - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - - * `name` - (String) The name of the scope. - - * `properties` - (List) The properties of the scope. - Nested schema for **properties**: - * `name` - (String) The name of property. - * `value` - (String) The value of the property in string form. - - * `updated_by` - (String) The user who updated the control library. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. - - * `updated_on` - (String) The date when the control library was updated. diff --git a/website/docs/r/cd_toolchain_tool_securitycompliance.html.markdown b/website/docs/r/cd_toolchain_tool_securitycompliance.html.markdown deleted file mode 100644 index 24c396e39b..0000000000 --- a/website/docs/r/cd_toolchain_tool_securitycompliance.html.markdown +++ /dev/null @@ -1,89 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_cd_toolchain_tool_securitycompliance" -description: |- - Manages cd_toolchain_tool_securitycompliance. -subcategory: "Continuous Delivery" ---- - -# ibm_cd_toolchain_tool_securitycompliance - -Create, update, and delete cd_toolchain_tool_securitycompliances with this resource. - -See the [tool integration](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-scc) page for more information. - -## Example Usage - -```hcl -resource "ibm_cd_toolchain_tool_securitycompliance" "cd_toolchain_tool_securitycompliance_instance" { - parameters { - name = "compliance" - evidence_namespace = "cd" - evidence_repo_url = "https://github.example.com//compliance-evidence-" - } - toolchain_id = ibm_cd_toolchain.cd_toolchain.id -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `name` - (Optional, String) Name of the tool. - * Constraints: The maximum length is `128` characters. The minimum length is `0` characters. The value must match regular expression `/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/`. -* `parameters` - (Required, List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. -Nested schema for **parameters**: - * `attachment_id` - (Optional, String) An attachment ID. An attachment is configured under a profile to define how a scan will be run. To find the attachment ID, in the browser, in the attachments list, click on the attachment link, and a panel appears with a button to copy the attachment ID. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * Constraints: The value must match regular expression `/^[-0-9a-f]{32,36}$/`. - * `cos_bucket_name` - (Optional, String) The name of the Cloud Object Storage bucket used as an evidence locker. Make sure that this `cos_bucket_name` parameter matches the `bucket_name` for a `cloudobjectstorage` (Cloud Object Storage) tool integration in this toolchain. Only relevant when `evidence_locker_type` is set to `evidence-bucket`. - * `evidence_locker_type` - (Optional, String) The type of evidence storage locker. If you are using a Cloud Object Storage bucket, use the `evidence-bucket` type, and use the other `cos_bucket_name` parameter to point to the bucket, and provide a `cloudobjectstorage` (Cloud Object Storage) tool integration with a matching `bucket_name` and the credentials for connecting to the bucket. Or else if you are using a Git repository, use the `evidence-repo` type, and use the other `evidence_repo_url` parameter to point to the Git repository, and provide a Git tool integration. When absent defaults to `evidence-repo`. - * Constraints: Allowable values are: `evidence-repo`, `evidence-bucket`. - * `evidence_namespace` - (Optional, String) The kind of pipeline evidence to be displayed in Security and Compliance Center for this toolchain. The values are; `cd` which will use evidence generated by a Continuous Deployment (CD) pipeline, or `cc` which will use evidence generated by a Continuous Compliance (CC) pipeline. The default behavior is to use the CD evidence. - * Constraints: Allowable values are: `cd`, `cc`. - * `evidence_repo_url` - (Optional, String) The URL to a Git repository evidence locker. This evidence URL should match the `repo_url` for a Git tool integration in this toolchain. Only relevant when using `evidence-repo` as the `evidence_locker_type`. - * `instance_crn` - (Optional, String) The Security and Compliance Center service instance CRN (Cloud Resource Name). It is recommended to provide an instance CRN, but when absent, the oldest service instance will be used. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * Constraints: The value must match regular expression `/^crn:v1:(?:bluemix|staging):public:compliance:[a-zA-Z0-9-]*\\b:a\/[0-9a-fA-F]*\\b:[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}\\b::$/`. - * `name` - (Required, String) The name for this tool integration, shown on the toolchain page. - * `profile_name` - (Optional, String) The name of a Security and Compliance Center profile. Usually, use the "IBM Cloud Framework for Financial Services" predefined profile, which contains the DevSecOps Toolchain rules. Or use a user-authored customized profile that has been configured to contain those rules. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * `profile_version` - (Optional, String) The version of a Security and Compliance Center profile, in SemVer format, like '0.0.0'. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. - * `scc_api_key` - (Optional, String) The IBM Cloud API key used to access the Security and Compliance Center service, for the use profile with attachment setting. This parameter is only relevant when the `use_profile_attachment` parameter is `enabled`. You can use a toolchain secret reference for this parameter. For more information, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security#cd_secure_credentials). - * `use_profile_attachment` - (Optional, String) Set to `enabled` to enable use of a Security and Compliance Center (SCC) attachment and associated profile. This configuration allows the pre-deployment validation scripts to use the SCC profile. These scripts interact with the Security and Compliance Center service to check compliance rules for Continuous Deployment (CD). Similar checks are in place to ensure compliance monitoring for Continuous Compliance (CC). When enabled, other parameters become relevant; `scc_api_key`, `instance_crn`, `profile_name`, `profile_version`, `attachment_id`. - * Constraints: Allowable values are: `disabled`, `enabled`. -* `toolchain_id` - (Required, Forces new resource, String) ID of the toolchain to bind the tool to. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/`. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the cd_toolchain_tool_securitycompliance. -* `crn` - (String) Tool CRN. -* `href` - (String) URI representing the tool. -* `referent` - (List) Information on URIs to access this resource through the UI or API. -Nested schema for **referent**: - * `api_href` - (String) URI representing this resource through an API. - * `ui_href` - (String) URI representing this resource through the UI. -* `resource_group_id` - (String) Resource group where the tool is located. -* `state` - (String) Current configuration state of the tool. - * Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`. -* `tool_id` - (String) Tool ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/`. -* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to. -* `updated_at` - (String) Latest tool update timestamp. - - -## Import - -You can import the `ibm_cd_toolchain_tool_securitycompliance` resource by using `id`. -The `id` property can be formed from `toolchain_id`, and `tool_id` in the following format: - -
-<toolchain_id>/<tool_id>
-
-* `toolchain_id`: A string. ID of the toolchain to bind the tool to. -* `tool_id`: A string. Tool ID. - -# Syntax -
-$ terraform import ibm_cd_toolchain_tool_securitycompliance.cd_toolchain_tool_securitycompliance <toolchain_id>/<tool_id>
-
diff --git a/website/docs/r/scc_control_library.html.markdown b/website/docs/r/scc_control_library.html.markdown deleted file mode 100644 index e02998934c..0000000000 --- a/website/docs/r/scc_control_library.html.markdown +++ /dev/null @@ -1,178 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_control_library" -description: |- - Manages scc_control_library. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_control_library - -Create, update, and delete control libraries by using this resource. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -resource "ibm_scc_control_library" "scc_control_library_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - control_library_description = "control_library_description" - control_library_name = "control_library_name" - control_library_type = "predefined" - controls { - control_name = "control_name" - control_id = "1fa45e17-9322-4e6c-bbd6-1c51db08e790" - control_description = "control_description" - control_category = "control_category" - control_parent = "control_parent" - control_tags = [ "control_tags" ] - control_specifications { - control_specification_id = "f3517159-889e-4781-819a-89d89b747c85" - responsibility = "user" - component_id = "f3517159-889e-4781-819a-89d89b747c85" - component_name = "componenet_name" - environment = "environment" - control_specification_description = "control_specification_description" - assessments_count = 1 - assessments { - assessment_id = "assessment_id" - assessment_method = "assessment_method" - assessment_type = "assessment_type" - assessment_description = "assessment_description" - parameter_count = 1 - parameters { - parameter_name = "parameter_name" - parameter_display_name = "parameter_display_name" - parameter_type = "string" - } - } - } - control_docs { - control_docs_id = "control_docs_id" - control_docs_type = "control_docs_type" - } - control_requirement = true - status = "enabled" - } - version_group_label = "e0923045-f00d-44de-b49b-6f1f0e8033cc" -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `control_library_description` - (Required, String) The control library description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `control_library_name` - (Required, String) The control library name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_\\s\\-]*$/`. -* `control_library_type` - (Required, String) The control library type. Use `custom` in most cases. - * Constraints: Allowable values are: `predefined`, `custom`. -* `control_library_version` - (Optional, String) The control library version. - * Constraints: The maximum length is `64` characters. The minimum length is `5` characters. The value must match regular expression `/^[a-zA-Z0-9_\\-.]*$/`. -* `controls` - (Required, List) The list of controls in a control library. - * Constraints: The maximum length is `1200` items. The minimum length is `0` items. -Nested schema for **controls**: - * `control_category` - (Optional, String) The control category. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,\\-\\s]*$/`. - * `control_description` - (Optional, String) The control description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. - * `control_docs` - (Optional, List) The control documentation. - Nested schema for **control_docs**: - * `control_docs_id` - (Optional, String) The ID of the control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_docs_type` - (Optional, String) The type of control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_id` - (Optional, String) The control name. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_name` - (Optional, String) The ID of the control library that contains the profile. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_parent` - (Optional, String) The parent control. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]*/`. - * `control_requirement` - (Optional, Boolean) Is this a control that can be automated or manually evaluated. - * `control_specifications` - (Optional, List) The control specifications. - * Constraints: The maximum length is `100` items. The minimum length is `0` items. - Nested schema for **control_specifications**: - * `assessments` - (Optional, List) The assessments. - * Constraints: The maximum length is `10` items. The minimum length is `0` items. - Nested schema for **assessments**: - * `assessment_description` - (Optional, String) The assessment description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `assessment_id` - (Optional, String) The assessment ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_method` - (Optional, String) The assessment method. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (Optional, String) The assessment type. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_count` - (Optional, Integer) The parameter count. - * `parameters` - (Optional, List) The parameters. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. - Nested schema for **parameters**: - * `parameter_display_name` - (Optional, String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (Optional, String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_\\s\\-]*$/`. - * `parameter_type` - (Optional, String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - * `assessments_count` - (Optional, Integer) The number of assessments. - * `component_name` - (Optional, String) The component name. - * Constraints: The maximum length is `512` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `component_id` - (Optional, String) The component ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `control_specification_description` - (Optional, String) The control specifications description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `control_specification_id` - (Optional, String) The control specification ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - * `environment` - (Optional, String) The control specifications environment. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `responsibility` - (Optional, String) The responsibility for managing the control. - * Constraints: Allowable values are: `user`. - * `control_tags` - (Optional, List) The control tags. - * Constraints: The list items must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. The maximum length is `512` items. The minimum length is `0` items. - * `status` - (Optional, String) The control status. Set to `enabled` to other resources to use this control library, `disabled` otherwise. - * Constraints: Allowable values are: `enabled`, `disabled`. - -* `latest` - (Optional, Boolean) The latest version of the control library. -* `version_group_label` - (Computed, String) The version group label. This is string is the unique identifier for the current version of the Control Library - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `controls_count` - (Optional, Integer) The number of controls. -* `id` - The unique identifier of the scc_control_library. -* `control_library_id` - (String) The ID that is associated with the created `control_library` -* `account_id` - (String) The account ID. - * Constraints: The maximum length is `32` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. -* `control_parents_count` - (Integer) The number of parent controls in the control library. -* `created_by` - (String) The user who created the control library. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `created_on` - (String) The date when the control library was created. -* `hierarchy_enabled` - (Boolean) The indication of whether hierarchy is enabled for the control library. -* `updated_by` - (String) The user who updated the control library. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `updated_on` - (String) The date when the control library was updated. - - -## Import - -You can import the `ibm_scc_control_library` resource by using `id`. -The `id` property can be formed from `instance_id` and `control_library_id` in the following format: -```bash -/ -``` -* `instance_id`: A string. The instance ID. -* `control_library_id`: A string. The control library ID. - -# Syntax -```bash -$ terraform import ibm_scc_control_library.scc_control_library / -``` - -# Example -```bash -$ terraform import ibm_scc_control_library.scc_control_library 00000000-1111-2222-3333-444444444444/f3517159-889e-4781-819a-89d89b747c85 -``` diff --git a/website/docs/r/scc_instance.html.markdown b/website/docs/r/scc_instance.html.markdown deleted file mode 100644 index 1347256fb6..0000000000 --- a/website/docs/r/scc_instance.html.markdown +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_instance" -description: |- - Manages scc_instance. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_instance - -Create, update, and delete scc_instance with this resource. - -~> NOTE: This document details how to use the resource `ibm_resource_instance` targeting the service `Security and Compliance Center`. For more information about the Terraform resource `ibm_resource_instance`, click [here](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_instance) - -## Example Usage - -```hcl -data "ibm_resource_group" "group" { - name = "test" -} - -resource "ibm_resource_instance" "scc_instance" { - name = "test" - service = "compliance" - plan = "security-compliance-center-standard-plan" # also support security-compliance-center-trial-plan - location = "us-south" - resource_group_id = data.ibm_resource_group.group.id - tags = ["tag1", "tag2"] -} -``` - -## Argument reference -Review the argument references that you can specify for your resource. - -- `location` - (Required, Forces new resource, String) Target location or environment to create the resource instance. -- `plan` - (Required, String) The name of the plan type supported by service. You can retrieve the value by running the `ibmcloud catalog service ` command. -- `name` - (Required, String) A descriptive name used to identify the resource instance. -- `resource_group_id` - (Optional, Forces new resource, String) The ID of the resource group where you want to create the service. You can retrieve the value from data source `ibm_resource_group`. If not provided creates the service in `default` resource group. -- `tags` (Optional, Array of Strings) Tags associated with the instance. -- `service` - (Required, Forces new resource, String) The name of the service offering. - diff --git a/website/docs/r/scc_instance_settings.html.markdown b/website/docs/r/scc_instance_settings.html.markdown deleted file mode 100644 index 0bbfad4555..0000000000 --- a/website/docs/r/scc_instance_settings.html.markdown +++ /dev/null @@ -1,74 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_instance_settings" -description: |- - Manages scc_instance_settings. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_instance_settings - -Create, update, and delete scc_instance_settingss with this resource. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -resource "ibm_scc_instance_settings" "scc_instance_settings_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - event_notifications { - instance_crn = "" - } - object_storage { - instance_crn = "" - bucket = "" - } -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `event_notifications` - (Optional, List) The Event Notifications settings. -Nested schema for **event_notifications**: - * `instance_crn` - (Optional, String) The Event Notifications instance CRN. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}|$/`. - * `source_id` - (Computed, String) The connected Security and Compliance Center instance CRN. - * Constraints: The maximum length is `512` characters. The minimum length is `1` character. The value must match regular expression `/([A-Za-z0-9]+(:[A-Za-z0-9]+)+)/`. - * `updated_on` - (Optional, String) The date when the Event Notifications connection was updated. - * `source_description` - (Optional,Computed, String) The description of the Event Notifications connection source. - * `source_name` - (Optional,Computed, String) The name of the Event Notifications connection source. -* `object_storage` - (Optional, List) The Cloud Object Storage settings. -Nested schema for **object_storage**: - * `bucket` - (Optional, String) The connected Cloud Object Storage bucket name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z]+|/`. - * `bucket_endpoint` - (Computed, String) The connected Cloud Object Storage bucket endpoint. - * Constraints: The maximum length is `512` characters. The minimum length is `1` character. The value must match regular expression `/([A-Za-z0-9-]+)/`. - * `bucket_location` - (Computed, String) The connected Cloud Object Storage bucket location. - * Constraints: The maximum length is `32` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z]+/`. - * `instance_crn` - (Optional, String) The connected Cloud Object Storage instance CRN. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}|$/`. - * `updated_on` - (Computed, String) The date when the bucket connection was updated. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the scc_instance_settings. - -## Import - -You can import the `ibm_scc_instance_settings` resource by using `instance_id`. The unique identifier of the scc_instance_settings. - -# Syntax -```bash -$ terraform import ibm_scc_instance_settings.scc_instance_settings -``` - -# Example -```bash -$ terraform import ibm_scc_instance_settings.scc_instance_settings 00000000-1111-2222-3333-444444444444 -``` diff --git a/website/docs/r/scc_profile.html.markdown b/website/docs/r/scc_profile.html.markdown deleted file mode 100644 index 0c16e5411d..0000000000 --- a/website/docs/r/scc_profile.html.markdown +++ /dev/null @@ -1,206 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_profile" -description: |- - Manages scc_profile. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_profile - -Create, update, and delete profiles with this resource. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -resource "ibm_scc_profile" "scc_profile_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - controls { - control_library_id = "e98a56ff-dc24-41d4-9875-1e188e2da6cd" - control_id = "5C453578-E9A1-421E-AD0F-C6AFCDD67CCF" - control_library_version = "control_library_version" - control_name = "control_name" - control_description = "control_description" - control_category = "control_category" - control_parent = "control_parent" - control_requirement = true - control_docs { - control_docs_id = "control_docs_id" - control_docs_type = "control_docs_type" - } - control_specifications_count = 1 - control_specifications { - control_specification_id = "f3517159-889e-4781-819a-89d89b747c85" - responsibility = "user" - component_id = "f3517159-889e-4781-819a-89d89b747c85" - componenet_name = "componenet_name" - environment = "environment" - control_specification_description = "control_specification_description" - assessments_count = 1 - assessments { - assessment_id = "assessment_id" - assessment_method = "assessment_method" - assessment_type = "assessment_type" - assessment_description = "assessment_description" - parameter_count = 1 - parameters { - parameter_name = "parameter_name" - parameter_display_name = "parameter_display_name" - parameter_type = "string" - } - } - } - } - default_parameters { - assessment_type = "assessment_type" - assessment_id = "assessment_id" - parameter_name = "parameter_name" - parameter_default_value = "parameter_default_value" - parameter_display_name = "parameter_display_name" - parameter_type = "string" - } - profile_description = "profile_description" - profile_name = "profile_name" - profile_type = "predefined" -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `controls` - (Required, List) The array of controls that are used to create the profile. - * Constraints: The maximum length is `600` items. The minimum length is `0` items. -Nested schema for **controls**: - * `control_category` - (Optional, String) The control category. - * Constraints: The maximum length is `512` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_description` - (Optional, String) The control description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `[A-Za-z0-9]+//`. - * `control_docs` - (Optional, List) The control documentation. - Nested schema for **control_docs**: - * `control_docs_id` - (Optional, String) The ID of the control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_docs_type` - (Optional, String) The type of control documentation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_id` - (Optional, String) The unique ID of the control library that contains the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[A-Z0-9]+/`. - * `control_library_id` - (Optional, String) The ID of the control library that contains the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_library_version` - (Optional, String) The most recent version of the control library. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_name` - (Optional, String) The control name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `control_parent` - (Optional, String) The parent control. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]*/`. - * `control_requirement` - (Optional, Boolean) Is this a control that can be automated or manually evaluated. - * `control_specifications` - (Optional, List) The control specifications. - * Constraints: The maximum length is `400` items. The minimum length is `0` items. - Nested schema for **control_specifications**: - * `assessments` - (Optional, List) The assessments. - * Constraints: The maximum length is `10` items. The minimum length is `0` items. - Nested schema for **assessments**: - * `assessment_description` - (Optional, String) The assessment description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `assessment_id` - (Optional, String) The assessment ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_method` - (Optional, String) The assessment method. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (Optional, String) The assessment type. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_count` - (Optional, Integer) The parameter count. - * `parameters` - (Optional, List) The parameters. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. - Nested schema for **parameters**: - * `parameter_display_name` - (Optional, String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (Optional, String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_\\s\\-]*$/`. - * `parameter_type` - (Optional, String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - * `assessments_count` - (Optional, Integer) The number of assessments. - * `componenet_name` - (Optional, String) The component name. - * Constraints: The maximum length is `512` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `component_id` - (Optional, String) The component ID. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `control_specification_description` - (Optional, String) The control specifications description. - * Constraints: The maximum length is `1024` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `control_specification_id` - (Optional, String) The control specification ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. - * `environment` - (Optional, String) The control specifications environment. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `responsibility` - (Optional, String) The responsibility for managing the control. - * Constraints: Allowable values are: `user`. - * `control_specifications_count` - (Optional, Integer) The number of control specifications. -* `default_parameters` - (Required, List) The default parameters of the profile. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. -Nested schema for **default_parameters**: - * `assessment_id` - (Optional, String) The implementation ID of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (Optional, String) The type of the implementation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_default_value` - (Optional, String) The default value of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. - * `parameter_display_name` - (Optional, String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (Optional, String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_]*$/`. - * `parameter_type` - (Optional, String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. -* `profile_description` - (Required, String) The profile description. - * Constraints: The maximum length is `256` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `profile_name` - (Required, String) The profile name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `profile_version` - (Optional, String) The version of the profile to set. The value must match regular expression `/\d+\.\d+\.\d+/`. -* `profile_type` - (Required, String) The profile type, such as custom or predefined. - * Constraints: Allowable values are: `predefined`, `custom`. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the scc_profile. -* `profile_id` - (String) The ID that is associated with the created `profile` -* `attachments_count` - (Integer) The number of attachments related to this profile. -* `control_parents_count` - (Integer) The number of parent controls for the profile. -* `controls_count` - (Integer) The number of controls for the profile. -* `created_by` - (String) The user who created the profile. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `created_on` - (String) The date when the profile was created. -* `hierarchy_enabled` - (Boolean) The indication of whether hierarchy is enabled for the profile. -* `instance_id` - (String) The instance ID. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `latest` - (Boolean) The latest version of the profile. -* `profile_version` - (String) The version status of the profile. - * Constraints: The maximum length is `64` characters. The minimum length is `5` characters. The value must match regular expression `/^[a-zA-Z0-9_\\-.]*$/`. -* `updated_by` - (String) The user who updated the profile. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `updated_on` - (String) The date when the profile was updated. -* `version_group_label` - (String) The version group label of the profile. - * Constraints: The maximum length is `36` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - - -## Import - -You can import the `ibm_scc_profile` resource by using `id`. -The `id` property can be formed from `instance_id` and `profiles_id` in the following format: - -```bash -/ -``` - -* `instance_id`: A string. The instance ID. -* `profile_id`: A string. The profile ID. - -# Syntax - -```bash -$ terraform import ibm_scc_profile.scc_profile / -``` - -# Example -```bash -$ terraform import ibm_scc_profile.scc_profile 00000000-1111-2222-3333-444444444444/00000000-1111-2222-3333-444444444444 -``` \ No newline at end of file diff --git a/website/docs/r/scc_profile_attachment.html.markdown b/website/docs/r/scc_profile_attachment.html.markdown deleted file mode 100644 index ca5e9da53f..0000000000 --- a/website/docs/r/scc_profile_attachment.html.markdown +++ /dev/null @@ -1,240 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_profile_attachment" -description: |- - Manages scc_profile_attachment. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_profile_attachment - -Create, update, and delete profile attachments with this resource. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -Making a profile attachment using an IBM `ibm_scc_scope`: -```hcl -## Local Variables -locals { - scc_instance_id = "f6939361-4f72-47a3-ae5e-0ee77a90ee31" - ibm_cloud_sample_profile_id = "623ee808-2fcd-4700-8149-cc5500512ad7" -} - -## Datasources - -# datasource to obtain information of a profile -data "ibm_scc_profile" "sample_profile_id" { - instance_id = local.scc_instance_id - profile_id = local.ibm_cloud_sample_profile_id -} - -## Resources - -# resource to create a scope targeting an account -resource "ibm_scc_scope" "scc_personal_account_scope" { - description = "An scope targeting an account, made using Terraform" - environment = "ibm-cloud" - name = "Terraform sample resource group scope" - properties = { - scope_type = "account" - scope_id = "7379262615a74cb3b9f346408a3e1694" - } - instance_id = local.scc_instance_id -} - -# resource to create a profile attachment to a predefined profile -resource "ibm_scc_profile_attachment" "cis-profile-attachment-instance" { - instance_id = local.scc_instance_id - name = "tf-demo-profile-attach-demo" - description = "Sample Profile attachment using Terraform" - profile_id = local.ibm_cloud_sample_profile_id - - schedule = "every_7_days" - status = "disabled" - - # scope created by the resource ibm_scc_scope - scope { - id = ibm_scc_scope.scc_personal_account_scope.scope_id - } - - # dynamically use the default parameters of a profile if there are any - dynamic "attachment_parameters" { - for_each = data.ibm_scc_profile.sample_profile_id.default_parameters - content { - parameter_name = attachment_parameters.value["parameter_name"] - parameter_display_name = attachment_parameters.value["parameter_display_name"] - parameter_type = attachment_parameters.value["parameter_type"] - parameter_value = attachment_parameters.value["parameter_default_value"] - assessment_type = attachment_parameters.value["assessment_type"] - assessment_id = attachment_parameters.value["assessment_id"] - } - } - - notifications { - enabled = false - controls { - failed_control_ids = [] - threshold_limit = 10 - } - } -} -``` -Making a profile attachment using an IBM `account_id`: - -**NOTE**: This is considered legacy support and will be deprecated soon. - -```hcl -resource "ibm_scc_profile_attachment" "scc_profile_attachment_instance" { - profile_id = "a0bd1ee2-1ed3-407e-a2f4-ce7a1a38f54d" - instance_id = "34324315-2edc-23dc-2389-34982389834d" - name = "profile_attachment_name" - description = "scc_profile_attachment_description" - scope { - environment = "ibm-cloud" - properties { - name = "scope_id" - value = resource.ibm_scc_control_library.scc_control_library_instance.account_id - } - properties { - name = "scope_type" - value = "account" - } - } - schedule = "every_30_days" - status = "enabled" - notifications { - enabled = false - controls { - failed_control_ids = [] - threshold_limit = 14 - } - } - attachment_parameters { - parameter_value = "22" - assessment_id = "rule-this-is-a-fake-ruleid" - parameter_display_name = "Network ACL rule for allowed IPs to SSH port" - parameter_name = "ssh_port" - parameter_type = "numeric" - } -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `profile_id` - (Required, Forces new resource, String) The profile ID. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/`. -* `scope` - (List) The scope payload for the multi cloud feature. - * Constraints: - * The maximum length is `8` items. The minimum length is `0` items. - - Nested schema for **scope**: - * `environment` - (String) The environment that relates to this scope. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `properties` - (List, Forces new resource) The properties supported for scoping by this environment. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. - Nested schema for **properties**: - ~> NOTE: Defining the `scope_type` value must be either `account`, `account.resource_group`, `enterprise`, `enterprise.account` and `enterprise.account_group`." - ~> NOTE: Defining the `scope_id` value will be the id of the `scope_type`(ex. `enterprise.account_group` will be the ID of the account_group within an enterprise) - * `name` - (Required, String) The name of the property. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `value` - (Required, String) The value of the property. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`.; - * `id` - (Optional, String) The ID of an `ibm_scc_scope` that is prexisiting - * Constraints: `id` must not be used with `environment` and `properties` -* `notifications` - (Required, List) The configuration for setting up notifications if a scan fails. Requires event_notifications from the instance settings to be setup. - -Nested schema for **notifications**: - * `controls` - (List) The failed controls. - Nested schema for **controls**: - * `failed_control_ids` - (List) The failed control IDs. - * Constraints: The list items must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. The maximum length is `512` items. The minimum length is `0` items. - * `threshold_limit` - (Integer) The threshold limit. - * `enabled` - (Boolean) The flag to enable notifications. Set to true to enabled notifications, false to disable -* `attachment_parameters` - (List) The attachment parameters required from the profile that the attachment is targeting. All parameters listed from the profile needs to be set. **NOTE**: All `attachment_parameters` must be defined; use `datasource.ibm_scc_profile` to see all necessary parameters. - -Nested schema for **attachment_parameters**: - * `parameter_name` - (Required, String) The name of the parameter to target. - * `parameter_display_name` - (Required, String) The display name of the parameter shown in the UI. - * `parameter_type` - (Required, String) The type of the parameter value. - * `parameter_value` - (Required, String) The value of the parameter. - * `assessment_type` - (String) The type of assessment the parameter uses. -* `schedule` - (String) The schedule of an attachment evaluation. - * Constraints: Allowable values are: `daily`, `every_7_days`, `every_30_days`. -* `name` - (String) The name of the attachment. - * Constraints: The maximum length is `128` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the scc_profile_attachment. -* `profile_attachment_id` - (String) The ID that is associated with the created `profile_attachment` -* `account_id` - (String) The account ID that is associated to the attachment. - * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. -* `attachment_id` - (String) The ID of the attachment. - * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. -* `attachment_parameters` - (List) The profile parameters for the attachment. - * Constraints: The maximum length is `512` items. The minimum length is `0` items. - - Nested schema for **attachment_parameters**: - * `assessment_id` - (String) The implementation ID of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `assessment_type` - (String) The type of the implementation. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `parameter_display_name` - (String) The parameter display name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. - * `parameter_name` - (String) The parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_]*$/`. - * `parameter_type` - (String) The parameter type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. - * `parameter_value` - (String) The value of the parameter. - * Constraints: The maximum length is `64` characters. The minimum length is `2` characters. The value must match regular expression `/^[a-zA-Z0-9_,'"\\s\\-\\[\\]]+$/`. -* `created_by` - (String) The user who created the attachment. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `created_on` - (String) The date when the attachment was created. -* `description` - (String) The description for the attachment. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-]*$/`. -* `instance_id` - (String) The instance ID of the account that is associated to the attachment. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$|^$/`. -* `last_scan` - (List) The details of the last scan of an attachment. - - Nested schema for **last_scan**: - * `id` - (String) The ID of the last scan of an attachment. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[a-zA-Z0-9-]*$/`. - * `status` - (String) The status of the last scan of an attachment. - * Constraints: Allowable values are: `in_progress`, `completed`. - * `time` - (String) The time when the last scan started. -* `next_scan_time` - (String) The start time of the next scan. -* `status` - (String) The status of an attachment evaluation. - * Constraints: Allowable values are: `enabled`, `disabled`. -* `updated_by` - (String) The user who updated the attachment. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `updated_on` - (String) The date when the attachment was updated. - - -## Import - -You can import the `ibm_scc_profile_attachment` resource by using `id`. -The `id` property can be formed from `instance_id`, `profiles_id`, and `attachment_id` in the following format: - -```bash -// -``` -* `instance_id`: A string. The instance ID. -* `profile_id`: A string. The profile ID. -* `attachment_id`: A string. The attachment ID. - -# Syntax -```bash -$ terraform import ibm_scc_profile_attachment.scc_profile_attachment // -``` - -# Example -```bash -$ terraform import ibm_scc_profile_attachment.scc_profile_attachment 00000000-1111-2222-3333-444444444444/00000000-1111-2222-3333-444444444444/f3517159-889e-4781-819a-89d89b747c85 -``` diff --git a/website/docs/r/scc_provider_type_instance.html.markdown b/website/docs/r/scc_provider_type_instance.html.markdown deleted file mode 100644 index b9a813fd95..0000000000 --- a/website/docs/r/scc_provider_type_instance.html.markdown +++ /dev/null @@ -1,67 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_provider_type_instance" -description: |- - Manages scc_provider_type_instance. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_provider_type_instance - -Create, update, and delete provider type instances with this resource. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -resource "ibm_scc_provider_type_instance" "scc_provider_type_instance_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - attributes = {"wp_crn":"crn:v1:staging:public:sysdig-secure:eu-gb:a/14q5SEnVIbwxzvP4AWPCjr2dJg5BAvPb:d1461d1ae-df1eee12fa81812e0-12-aa259::"} - name = "workload-protection-instance-1" - provider_type_id = "provider_type_id" -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `attributes` - (Required, Map) The attributes for connecting to the provider type instance. -* `name` - (Required, String) The name for the provider_type instance -* `provider_type_id` - (Required, String) The unique identifier of the provider type instance. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the scc_provider_type_instance. -* `provider_type_instance_id` - (String) The ID that is associated with the created `provider_type_instance` -* `created_at` - (String) The time when resource was created. -* `type` - (String) The type of the provider type. -* `updated_at` - (String) The time when resource was updated. - - -## Import - -You can import the `ibm_scc_provider_type_instance` resource by using `id`. -The `id` property can be formed from `instance_id`, `provider_type_id`, and `provider_type_instance_id` in the following format: - -```bash -// -``` -* `instance_id`: A string. The instance ID. -* `provider_type_id`: A string. The provider type ID. -* `provider_type_instance_id`: A string. The provider type instance ID. - -# Syntax - -```bash -$ terraform import ibm_scc_provider_type_instance.scc_provider_type_instance // -``` - -# Example -```bash -$ terraform import ibm_scc_provider_type_instance.scc_provider_type_instance 00000000-1111-2222-3333-444444444444/00000000-1111-2222-3333-444444444444/f3517159-889e-4781-819a-89d89b747c85 -``` \ No newline at end of file diff --git a/website/docs/r/scc_rule.html.markdown b/website/docs/r/scc_rule.html.markdown deleted file mode 100644 index b703685d9d..0000000000 --- a/website/docs/r/scc_rule.html.markdown +++ /dev/null @@ -1,373 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_rule" -description: |- - Manages scc_rule. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_rule - -Create, update, and delete rules with this resource. - -~> NOTE: Security Compliance Center is a regional service. Please specify the IBM Cloud Provider attribute `region` to target another region. Else, exporting the environmental variable IBMCLOUD_SCC_API_ENDPOINT will also override which region is being targeted for all ibm providers(ex. `export IBMCLOUD_SCC_API_ENDPOINT=https://eu-es.compliance.cloud.ibm.com`). - -## Example Usage - -```hcl -resource "ibm_scc_rule" "scc_rule_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - description = "Example rule" - import { - parameters { - name = "name" - display_name = "display_name" - description = "description" - type = "string" - } - } - required_config { - description = "description" - and { - or { - description = "description" - property = "property" - operator = "string_equals" - value = "anything as a string" - } - } - } - target { - service_name = "service_name" - service_display_name = "service_display_name" - resource_kind = "resource_kind" - additional_target_attributes { - name = "name" - operator = "string_equals" - value = "value" - } - } - version = "1.0.0" -} -``` -```hcl -resource "ibm_scc_rule" "scc_rule_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - description = "This rule will determine if a cloud object storage bucket is configured my way" - version = "1.0.0" - import { - parameters { - name = "name" - display_name = "display_name" - description = "description" - type = "string" - } - } - target { - service_name = "cloud-object-storage" - resource_kind = "bucket" - additional_target_attributes { - name = "location" - operator = "string_equals" - value = "$${name}" - } - } - required_config { - and { - or { - description = "description 1" - property = "storage_class" - operator = "string_equals" - value = "smart" - } - or { - description = "description 2" - property = "storage_class" - operator = "string_equals" - value = "cold" - } - or { - description = "description 3" - property = "firewall.allowed_ip" - operator = "ips_equals" - value = jsonencode(["0.0.0.0/0"]) - } - } - } - labels = ["FIXME"] - } -``` -```hcl -resource "ibm_scc_rule" "scc_rule_instance" { - instance_id = "00000000-1111-2222-3333-444444444444" - description = "This rule will determine if Activity Tracker is correctly configured" - version = "0.1.0" - target { - service_name = "atracker" - resource_kind = "target" - reference_name = "this-target" - additional_target_attributes { - name = "type" - operator = "string_equals" - value = "cloud_object_storage" - } - } - required_config { - or { - property = "route_attached" - operator = "is_false" - } - or { - any_if { - target { - service_name = "cloud-object-storage" - resource_kind = "bucket" - additional_target_attributes { - name = "location" - operator = "strings_in_list" - value = "$${this-target}.bucket_name" - } - } - required_config { - property = "location" - operator = "strings_in_list" - value = jsonencode(["us-south","us-east"]) - } - } - } - } - labels = ["FIXME"] - } -``` - -## Timeouts - -scc_rule provides the following [Timeouts](https://www.terraform.io/docs/configuration/resources.html#timeouts) configuration options: - -* `create` - (Default 60 minutes) Used for creating a scc_rule. -* `update` - (Default 60 minutes) Used for updating a scc_rule. -* `delete` - (Default 20 minutes) Used for deleting a scc_rule. - -## Argument Reference - -You can specify the following arguments for this resource. - -* `instance_id` - (Required, Forces new resource, String) The ID of the SCC instance in a particular region. -* `description` - (Required, String) The details of a rule's response. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `import` - (Optional, List) The collection of import parameters. - - Nested schema for **import**: - * `parameters` - (Optional, List) The list of import parameters. - * Constraints: The maximum length is `8` items. The minimum length is `0` items. - - Nested schema for **parameters**: - * `description` - (Optional, String) The propery description. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `display_name` - (Optional, String) The display name of the property. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `name` - (Optional, String) The import parameter name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `type` - (Optional, String) The property type. - * Constraints: Allowable values are: `string`, `numeric`, `general`, `boolean`, `string_list`, `ip_list`, `timestamp`. The maximum length is `11` characters. The minimum length is `6` characters. The value must match regular expression `/[A-Za-z]+/`. -* `labels` - (Optional, List) The list of labels. - * Constraints: The list items must match regular expression `/[A-Za-z0-9]+/`. The maximum length is `32` items. The minimum length is `0` items. -* `required_config` - (Required, List) The specified settings by which your target service will be evaluated against. See the [required_config](#required_config) section for more details. -* `target` - (Required, List) The service or resource used in the assessment. See [rule_target](#rule_target) for more details. -* `version` - (Optional, String) The version number of a rule. - * Constraints: The maximum length is `10` characters. The minimum length is `5` characters. The value must match regular expression `/^[0-9][0-9.]*$/`. - -### required_config -The `required_config` is specified setting by which the target will be evaluated against. - -The `required_config` block supports any of the following schemas: - - [base_condition](#base_condtion) - - [list_condition](#list_condition) - - [sub_rule](#sub_rule) - -### base_condition -A base_condition is the basic object in `required_config` block. It details the expected specifications of a service/resource. - -```hcl -required_config { - property = "location" - operator = "strings_in_list" - description = "Must be in the region us-south or us-east" - value = jsonencode(["us-south","us-east"]) -} -``` - -* `description` - (Optional, String) The details of the expected setting. -* `property` - (Required, String) The property. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `operator` - (Required, String) The operator. - * Constraints: Allowable values are: - * `string_equals` - * `string_not_equals` - * `string_match` - * `string_not_match` - * `string_contains` - * `string_not_contains` - * `num_equals` - * `num_not_equals` - * `num_less_than` - * `num_less_than_equals` - * `num_greater_than` - * `num_greater_than_equals` - * `is_empty` - * `is_not_empty` - * `is_true` - * `is_false` - * `strings_in_list` - * `strings_allowed` - * `strings_required` - * `ips_in_range` - * `ips_equals` - * `ips_not_equals` - * `days_less_than` - - The maximum length is `23` characters. The minimum length is `7` characters. -* `value` - (Optional, String) Value of the condition to satisfy. Target/Imports can be used here. - - ~> NOTE: If the value requires a list/array, please use the terraform function `jsonencode` - ```hcl - jsonencode(["us-south","us-east"]) - ``` - -### list_condition -A list_condition is a collection of `and/or` conditons. One or all condtions must be satisfied for the rule to be compliant. -```hcl -required_config { - ... - and { - property = "app_lb_pools_with_multiple_members_count" - operator = "num_not_equals" - value = "0" - } - and { - property = "app_lb_pools_without_multiple_members_count" - operator = "num_not_equals" - value = "0" - } -} -``` -One of the following attributes can be used to denote a list_condition -* `and` - (Optional, List) A list of conditions where all conditions listed must be satisfied. -* `or` - (Optional, List) A list of conditions where one condition listed must be satisfied. - -`and`, `or` supports a combination of the following schemas in the list: -* [base_condition](#base_condition) -* [list_condition](#list_condition) -* [sub_rule_condition](#sub_rule) - -### sub_rule -A sub_rule is a rule condition within a rule used to evaluate a target. -```hcl -required_config { - ... - any_if { - target { - service_name = "cloud-object-storage" - resource_kind = "bucket" - } - required_config { - property = "location" - operator = "strings_in_list" - value = jsonencode(["us-south","us-east"]) - } - } -} -``` -One of the following attributes can be used to denote a subrule: -* `all` - (Optional) A subrule where all targets must satisfy the settings specified in the `required_config` argument. If no targets are found during evaluation, the subrule condition will fail. -* `all_if` - (Optional) A subrule where all targets must satisfy the setting specified in the `required_config` argument. If no targets are found, the subrule condition will pass. -* `any` - (Optional) A subrule where one of the targets must satisfy the setting specified in the `required_config` argument. If no targets are found, the subrule condition will fail. -* `any_if` - (Optional) A subrule where one of the targets must satisfy the setting specified in the `required_config` argument. If no targets are found, the subrule condition will fail. - -The arguments for `all`, `all_if`, `any`, `any_if`: -* `target` - (Required) see the section [rule_target](#rule_target) for more details -* `required_config` - (Required) see the section [required_config](#required_config) for more details - -### rule_target -The `rule_target` is the target the rule is evaluating. This target can be a service or a resource. - -Nested schema for **rule_target**: -* `additional_target_attributes` - (Optional, List) The list of targets supported properties. - * Constraints: The maximum length is `99999` items. The minimum length is `0` items. - Nested schema for **additional_target_attributes**: - * `name` - (Optional, String) The additional target attribute name. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - * `operator` - (Optional, String) The operator. - * Constraints: Allowable values are: - - `string_equals` - - `string_not_equals` - - `string_match` - - `string_not_match` - - `string_contains` - - `string_not_contains` - - `num_equals` - - `num_not_equals` - - `num_less_than` - - `num_less_than_equals` - - `num_greater_than` - - `num_greater_than_equals` - - `is_empty` - - `is_not_empty` - - `is_true` - - `is_false` - - `strings_in_list` - - `strings_allowed` - - `strings_required` - - `ips_in_range` - - `ips_equals` - - `ips_not_equals` - - `days_less_than` - * `value` - (Optional, String) The value. - * Constraints: The maximum length is `256` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `resource_kind` - (Required, String) The target resource kind. - * Constraints: The maximum length is `99999` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `reference_name` - (Optional, String) The variable that can be used in the `required_config`. -* `service_display_name` - (Optional, String) The display name of the target service. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `service_name` - (Required, String) The target service name. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the scc_rule. -* `rule_id` - (String) The ID that is associated with the created `rule` -* `account_id` - (String) The account ID. - * Constraints: The maximum length is `32` characters. The minimum length is `3` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `created_by` - (String) The user who created the rule. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `created_on` - (String) The date when the rule was created. -* `type` - (String) The rule type (allowable values are `user_defined` or `system_defined`). - * Constraints: Allowable values are: `user_defined`, `system_defined`. The maximum length is `14` characters. The minimum length is `12` characters. The value must match regular expression `/[A-Za-z]+_[A-Za-z]+/`. -* `updated_by` - (String) The user who modified the rule. - * Constraints: The maximum length is `64` characters. The minimum length is `0` characters. The value must match regular expression `/[A-Za-z0-9]+/`. -* `updated_on` - (String) The date when the rule was modified. - - -## Import - -You can import the `ibm_scc_rule` resource by using `id`. The rule ID. -The `id` property can be formed from `instance_id` and `rule_id` in the following format: - -```bash -/ -``` -* `instance_id`: A string. The instance ID. -* `rule_id`: A string. The rule ID. - -# Syntax - -```bash -$ terraform import ibm_scc_rule.scc_rule / -``` - -# Example -```bash -$ terraform import ibm_scc_rule.scc_rule 00000000-1111-2222-3333-444444444444/00000000-1111-2222-3333-444444444444 -``` diff --git a/website/docs/r/scc_scope.html.markdown b/website/docs/r/scc_scope.html.markdown deleted file mode 100644 index d59706f4ee..0000000000 --- a/website/docs/r/scc_scope.html.markdown +++ /dev/null @@ -1,124 +0,0 @@ ---- -layout: "ibm" -page_title: "IBM : ibm_scc_scope" -description: |- - Manages scc_scope. -subcategory: "Security and Compliance Center" ---- - -# ibm_scc_scope - -Create, update, and delete scc_scopes with this resource. - -## Example Usage - -To create a scope targeting an account -```hcl -resource "ibm_scc_scope" "scc_account_scope" { - description = "This scope allows a profile attachment to target an IBM account" - environment = "ibm-cloud" - instance_id = "b36c26e9-477a-43a1-9c50-19aff8e5d760" - name = "Sample account Scope" - properties = { - scope_id = "8e042beeccee40748674442960b9eb34" - scope_type = "account" - } -} -``` - -To create a scope targeting an enterprise -```hcl -resource "ibm_scc_scope" "scc_enterprise_scope" { - description = "This scope allows a profile attachment to target an IBM enterprise" - environment = "ibm-cloud" - instance_id = "b36c26e9-477a-43a1-9c50-19aff8e5d760" - name = "Sample enterprise Scope" - properties = { - scope_id = "6a204bd89f3c8348afd5c77c717a097a" - scope_type = "enterprise" - } -} -``` - -To create a scope targeting an account with an exclusion of a resource group -```hcl -resource "ibm_scc_scope" "scc_account_scope" { - description = "This scope allows a profile attachment to target an IBM account" - environment = "ibm-cloud" - instance_id = "b36c26e9-477a-43a1-9c50-19aff8e5d760" - name = "Sample account Scope" - properties = { - scope_id = "8e042beeccee40748674442960b9eb34" - scope_type = "account" - } - exclusions { - scope_id = "ff6ce35b305abe1f768e3317628c0ba3" - scope_type = "account.resource_group" - } -} -``` - -## Argument Reference - -You can specify the following arguments for this resource. - -* `description` - (Optional, String) The scope description. - * Constraints: The maximum length is `512` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-\\.]*$/`. -* `environment` - (Required, Force New, String) The scope environment. This value details what cloud provider the scope targets. - * Constraints: The maximum length is `128` characters. The minimum length is `0` characters. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-\\.]*$/`. - * Acceptable values are: - - `ibm-cloud` -* `instance_id` - (Required, Forces new resource, String) The ID of the Security and Compliance Center instance. - * Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/`. -* `name` - (Required, String) The scope name. - * Constraints: The maximum length is `128` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9_,'\\s\\-\\.]*$/`. -* `properties` - (Required, Forces new resource, Map) The properties of the scope to target. - - Keys accepted in **properties**: - * `scope_type` - (Required, String) The type of target the scope will cover - * Constraints: Acceptable values are: - * `account` - scope will target an IBM account - * `account.resource_group` - scope will target a resource_group of the account which owns the Security and Compliance Center instance specified in `instance_id` - * `enterprise.account_group` - targets an enterprise's account group - * `enterprise` - targets an IBM enterprise - * `scope_id` - (Required, String) The ID of the target defined in `scope_type`. -* `exclusions` - (Optional, List, Forces new resource) A list of scopes/targets to exclude from a scope. - - Nested schema for **exclusions**: - * `scope_type` - (Required, String) The type of target to exclude from the scope - * Constraints: Acceptable values are `account`, `account.resource_group`, or `enterprise.account_group`. - * `scope_id` - (Required, String) The ID of the target defined in `scope_type`. - -## Attribute Reference - -After your resource is created, you can read values from the listed arguments and the following attributes. - -* `id` - The unique identifier of the scc_scope. -* `account_id` - (String) The ID of the account associated with the scope. - * Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[a-zA-Z0-9_\\-.]*$/`. -* `attachment_count` - (Float) The number of attachments tied to the scope. -* `created_by` - (String) The identifier of the account or service ID who created the scope. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `created_on` - (String) The date when the scope was created. -* `scope_id` - (String) The ID of the scope. - * Constraints: The maximum length is `256` characters. The minimum length is `1` character. The value must match regular expression `/^.*$/`. -* `updated_by` - (String) The ID of the user or service ID who updated the scope. - * Constraints: The maximum length is `255` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9-\\.:,_\\s]*$/`. -* `updated_on` - (String) The date when the scope was updated. - - -## Import - -You can import the `ibm_scc_scope` resource by using `id`. -The `id` property can be formed from `instance_id`, and `scope_id` in the following format: - -``` -/ -``` -* `instance_id`: A string in the format `acd7032c-15a3-484f-bf5b-67d41534d940`. The ID of the Security and Compliance Center instance. -* `scope_id`: A string. The ID of the scope being targeted. - -# Syntax -``` -$ terraform import ibm_scc_scope.scc_scope / -```