diff --git a/README.md b/README.md index 566031d..8700cf0 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,58 @@ Terraform module to create and manage a SageMaker studio | user\_profile | The attributes of the users of sagemaker domain | + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13.0 | +| [aws](#requirement\_aws) | >= 3.10 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | >= 3.10 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_efs_backup_policy.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/efs_backup_policy) | resource | +| [aws_iam_role.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | +| [aws_iam_role_policy.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | +| [aws_iam_role_policy_attachment.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | +| [aws_sagemaker_domain.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sagemaker_domain) | resource | +| [aws_sagemaker_studio_lifecycle_config.jupyter](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sagemaker_studio_lifecycle_config) | resource | +| [aws_sagemaker_user_profile.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sagemaker_user_profile) | resource | +| [aws_iam_policy_document.assume_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | +| [aws_iam_policy_document.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [name](#input\_name) | The name for the sagemaker resources | `string` | n/a | yes | +| [subnet\_ids](#input\_subnet\_ids) | The subnet ids | `list(string)` | n/a | yes | +| [tags](#input\_tags) | A mapping of tags to assign to the resources | `map(string)` | n/a | yes | +| [vpc\_id](#input\_vpc\_id) | The VPC id | `string` | n/a | yes | +| [app\_network\_access\_type](#input\_app\_network\_access\_type) | Specifies the VPC used for non-EFS traffic | `string` | `"VpcOnly"` | no | +| [auth\_mode](#input\_auth\_mode) | The mode of authentication that members use to access the domain | `string` | `"IAM"` | no | +| [lcc\_python\_kernel](#input\_lcc\_python\_kernel) | Specifies the custom lifecycle config file | `string` | `null` | no | +| [role\_arn](#input\_role\_arn) | The arn of the IAM role to use for sagemaker | `string` | `null` | no | +| [security\_groups](#input\_security\_groups) | The security groups | `list(string)` | `null` | no | +| [user\_profiles](#input\_user\_profiles) | The subnet ids | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [domain](#output\_domain) | The attributes of the sagemaker domain | +| [user\_profile](#output\_user\_profile) | The attributes of the users of sagemaker domain | + \ No newline at end of file