Sagemaker Domain - Support retaining EFS File system

[DrFaust92]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Add an argument to retain Sagemaker Domain EFS File system upon deletion. This change will revert current behaviour change introduced in #17123

New or Affected Resource(s)

• aws_sagemaker_domain

Potential Terraform Configuration

resource "aws_sagemaker_domain" "example" {
  domain_name        = "example"
  auth_mode          = "IAM"
  vpc_id             = aws_vpc.test.id
  subnet_ids         = [aws_subnet.test.id]

  retain_policy {
    home_efs_file_system = "Delete|Retain" # Default: Retain
  }

  default_user_settings {
    execution_role = aws_iam_role.test.arn
  }
}

References

• r/sagemaker_user_profile - new resource #17123

[bflad]

Since the DeleteDomain API models this as a structure with a string parameter, we might want to do the same. 👍

resource "aws_sagemaker_domain" "example" {
  # ... other configuration ...

  retain_policy {
    home_efs_file_system = "Delete|Retain" # Default: Retain
  }
}

Then the logic can skip adding it if the block is not declared (essentially reverting it back to the default behavior):

func resourceAwsSagemakerDomainDelete(d *schema.ResourceData, meta interface{}) error {
	conn := meta.(*AWSClient).sagemakerconn

	input := &sagemaker.DeleteDomainInput{
		DomainId: aws.String(d.Id()),
	}

	if v, ok := d.GetOk("retention_policy"); ok && len(v.([]interface{})) > 0 && v.([]interface{})[0] != nil {
		input.RetentionPolicy = expandSagemakerRetentionPolicy(v.([]interface{}))
	}

To prevent confusion we have seen in other resources with destroy-time configuration, it would also be good to include additional cues in the documentation that this configuration must be applied in the Terraform state before the resource destroy operation.

[github-actions]

This functionality has been released in v3.50.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.