New Data Source: aws_cloudformation_exports #2180

moofish32 · 2017-11-06T04:26:12Z

This adds a new data source to leverage Cloudformation Exports. The improvement offered by this feature is improved integration to Cloudformation Exports to ease the transition to Terraform. This will enable a team to directly reference the Export name instead of having to know the Cloudformation Stack name. With the use of nested stacks the stack name is often non-deterministic using post-pended random characters.

This was originally opened as hashicorp/terraform#14407, but I have changed the solution to use one export per resource instead of entire map. This creates a declarative solution allowing validation prior to run of the export values.

trung · 2017-11-29T18:57:29Z

This is straightforward implementation for https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListExports.html

I would change stack_id to exporting_stack_id to match with AWS model

trung · 2017-12-19T02:16:31Z

Is there any chance to have this in the coming 1.6.1 release? This helps a lot in an environment where the transition happening from CloudFormation-based approach to Terraform

trung · 2018-01-05T03:04:46Z

@radeksimko appreciate your review on this PR

trung · 2018-01-12T19:52:58Z

@Ninir is there any chance you can look at this PR? I merged to my own fork and have been using it for awhile now. It works nicely.

moofish32 · 2018-02-11T04:42:45Z

@radeksimko -- rebase to resolve conflicts

moofish32 · 2018-02-18T06:26:07Z

@radeksimko @Ninir -- any update here?

trung · 2018-03-18T01:14:29Z

@bflad can you have a quick look at this? Thanks

trung · 2018-05-15T00:57:05Z

hope this can be merged soon so separate build just to include this PR is no longer needed

moofish32 · 2018-05-16T14:54:25Z

rebased to master @bflad @radeksimko not sure if there is something missing here?

johnmcteague · 2018-06-14T09:18:56Z

Any ETA on when this could get merged?

paultyng · 2018-06-15T13:02:20Z

For the most part this looks ok to me, the only change I would make would be to rename it to aws_cloudformation_export as its just a single export value, to leave room if we want to introduce a data source that pulls multiple exports at once.

moofish32 · 2018-06-15T15:59:49Z

renamed to cloudformatin_export

bflad

Sorry for the lengthy delay in getting this reviewed! 😅 As @paultyng mentioned this was in pretty good shape. I left some pretty minor feedback below, which I'll happily handle in a quick commit after yours. Thank you so much! 🚀

=== RUN   TestAccAWSCloudformationExports_dataSource
--- PASS: TestAccAWSCloudformationExports_dataSource (58.17s)

bflad · 2018-06-15T17:42:06Z

aws/data_source_aws_cloudformation_export.go

+func dataSourceAwsCloudFormationExportRead(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*AWSClient).cfconn
+	var name, value string
+	if v, ok := d.GetOk("name"); ok {


Minor nitpick: Since name is required, we do not need to check for its existence with d.GetOk() and instead can just get its value via name := d.Get("name").(string)

bflad · 2018-06-15T17:43:15Z

aws/data_source_aws_cloudformation_export.go

+	err := conn.ListExportsPages(input,
+		func(page *cloudformation.ListExportsOutput, lastPage bool) bool {
+			for _, e := range page.Exports {
+				if name == *e.Name {


To prevent potential panics with the resource, we should use the SDK provided helpers to dereference the pointers rather than *, e.g. aws.StringValue(e.Name)

bflad · 2018-06-15T17:44:11Z

aws/data_source_aws_cloudformation_export.go

+					return false
+				}
+			}
+			if page.NextToken != nil {


The SDK paginators should automatically handle NextToken so we can instead just return !lastPage

bflad · 2018-06-15T17:45:01Z

aws/data_source_aws_cloudformation_export_test.go

+	})
+}
+
+const testAccCheckCfnExport = `


😎 Extraneous constant here

bflad · 2018-06-15T17:47:11Z

website/docs/d/cloudformation_exports.html.markdown

+---
+layout: "aws"
+page_title: "AWS: aws_cloudformation_export"
+sidebar_current: "docs-aws-datasource-cloudformation-exports"


The filename and the sidebar naming need to be updated to remove the plural s 👍

bflad · 2018-06-15T17:48:19Z

website/docs/d/cloudformation_exports.html.markdown

+    Provides metadata of a CloudFormation Exports (e.g. Cross Stack References)
+---
+
+# aws\_cloudformation\_exports


Minor nitpick: the forward slashes are no longer required in the documentation headers -- understandably this PR was written during a time either when they were required or many of the other documentation pages still had them

bflad · 2018-06-15T17:50:13Z

aws/data_source_aws_cloudformation_export_test.go

+	"github.com/hashicorp/terraform/helper/resource"
+)
+
+func TestAccAWSCloudformationExports_dataSource(t *testing.T) {


Plural s is still present in this function name

…randomize test CF stack naming make testacc TEST=./aws TESTARGS='-run=TestAccAWSCloudformationExportDataSource_basic' ==> Checking that code complies with gofmt requirements... TF_ACC=1 go test ./aws -v -run=TestAccAWSCloudformationExportDataSource_basic -timeout 120m === RUN TestAccAWSCloudformationExportDataSource_basic --- PASS: TestAccAWSCloudformationExportDataSource_basic (70.16s) PASS ok github.com/terraform-providers/terraform-provider-aws/aws 70.195s

moofish32 · 2018-06-15T20:25:43Z

@bflad -- thanks for the feedback I'll try to keep this in mind for future work.

bflad · 2018-06-25T11:45:06Z

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

ghost · 2020-04-05T17:19:08Z

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 feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

radeksimko added the new-data-source Introduces a new data source. label Nov 7, 2017

radeksimko added the size/L Managed by automation to categorize the size of a PR. label Nov 15, 2017

moofish32 force-pushed the f-cfn-exports branch from 7c49f15 to 54b8996 Compare December 19, 2017 18:51

bflad added the service/cloudformation Issues and PRs that pertain to the cloudformation service. label Jan 12, 2018

radeksimko changed the title ~~Adding data source for Cloudformation Exports~~ New Data Source: aws_cloudformation_exports Jan 17, 2018

moofish32 force-pushed the f-cfn-exports branch from 54b8996 to 459cdee Compare February 11, 2018 04:42

ghost added the size/L Managed by automation to categorize the size of a PR. label Feb 11, 2018

Adding data source for Cloudformation Exports

e158e65

moofish32 force-pushed the f-cfn-exports branch from 459cdee to e158e65 Compare May 16, 2018 14:53

ghost added the size/L Managed by automation to categorize the size of a PR. label May 16, 2018

renaming cloudformation_exports to cloudformation_export

1f65313

ghost added the size/L Managed by automation to categorize the size of a PR. label Jun 15, 2018

bflad added this to the v1.24.0 milestone Jun 15, 2018

bflad approved these changes Jun 15, 2018

View reviewed changes

bflad merged commit 1f65313 into hashicorp:master Jun 15, 2018

bflad added a commit that referenced this pull request Jun 15, 2018

Update CHANGELOG for #2180

7c742c8

moofish32 deleted the f-cfn-exports branch June 15, 2018 20:23

ghost locked and limited conversation to collaborators Apr 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Data Source: aws_cloudformation_exports #2180

New Data Source: aws_cloudformation_exports #2180

moofish32 commented Nov 6, 2017

trung commented Nov 29, 2017

trung commented Dec 19, 2017

trung commented Jan 5, 2018

trung commented Jan 12, 2018

moofish32 commented Feb 11, 2018

moofish32 commented Feb 18, 2018

trung commented Mar 18, 2018

trung commented May 15, 2018

moofish32 commented May 16, 2018

johnmcteague commented Jun 14, 2018

paultyng commented Jun 15, 2018

moofish32 commented Jun 15, 2018

bflad left a comment

bflad Jun 15, 2018

bflad Jun 15, 2018

bflad Jun 15, 2018

bflad Jun 15, 2018

bflad Jun 15, 2018

bflad Jun 15, 2018

bflad Jun 15, 2018

moofish32 commented Jun 15, 2018

bflad commented Jun 25, 2018

ghost commented Apr 5, 2020

New Data Source: aws_cloudformation_exports #2180

New Data Source: aws_cloudformation_exports #2180

Conversation

moofish32 commented Nov 6, 2017

trung commented Nov 29, 2017

trung commented Dec 19, 2017

trung commented Jan 5, 2018

trung commented Jan 12, 2018

moofish32 commented Feb 11, 2018

moofish32 commented Feb 18, 2018

trung commented Mar 18, 2018

trung commented May 15, 2018

moofish32 commented May 16, 2018

johnmcteague commented Jun 14, 2018

paultyng commented Jun 15, 2018

moofish32 commented Jun 15, 2018

bflad left a comment

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

bflad Jun 15, 2018

Choose a reason for hiding this comment

moofish32 commented Jun 15, 2018

bflad commented Jun 25, 2018

ghost commented Apr 5, 2020