crewjam / go-cloudformation Goto Github PK

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html

Hi

I have the following while spinning up a cloudformation stack

func makeTemplate() *cf.Template {
    t := cf.NewTemplate()
   t.Description = "example production infrastructure"
    t.Parameters["Name"] = &cf.Parameter{
        Description: "This is a test",
        Type:        "String",
        Default:     "live long and prosper",
    }

    t.Outputs["myoutput1"] = &cf.Output{
        Description: "test output 1",
        Value:     "warp",
    }

    t.AddResource("ec2_vol", cf.EC2Volume{
        AutoEnableIO: cf.Bool(false),
        AvailabilityZone: cf.String("us-east-1b"),
        Encrypted: cf.Bool(false),
        Size: cf.String("1"),
        Tags: &cf.ResourceTag{
                 Key: cf.String("Name"),
                 Value: cf.String("my-vol"),
            },
        })


    etc etc 

The Tags are giving an error:
cannot use cloudformation.ResourceTag literal (type *cloudformation.ResourceTag) as type []cloudformation.ResourceTag in field value

Any advice here, please ?

Newbie in Go. So far this package was very useful in the project I'm working. I'm using this to generate CFN template. I noticed one feature is missing that is support for Parameter Groups using AWS::CloudFormation::Interface which is used by the AWS console to display relevant parameters in groups.

This requires Template struct to include Metadata field.

I see the schema.go includes various type (CloudFormationInterface, ParameterGroupsList etc etc) as resource types and wasn't sure how to use them to implement the Metadata field in Template struct.

I have come up with an alternate approach (patch attached) which works but probably not a good approach (again I'm newbie and in very early stage of my learning GO). Appreciate some suggestion and guidance.
metadata.txt

IAMRole.AssumeRolePolicyDocument is an interface{}

in [60a212d] @mweagle made a change to the generate code, which got reverted by the autoscaper. That change needs to be moved so that it doesn't get clobbered

Hi Russ,
In adding an ElasticBeanstalkApplicationVersion ref, it seems like the codegen didn't pickup the associated properties.

What's the best way for me to address & verify s.t. I can submit a PR? Thanks.

Hi @crewjam ,
I need to be able to set provider specific CustomResource properties, but it doesn't look as though CloudFormationCustomResource supports that.

Is this something on your backlog? I'd be happy to work on a PR to add this if you can give me some pointers on where to start. Thanks.

The Sub intrinsic function is missing.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-sub.html

The GroupName property does not exist. It is not a problem because Cloud Formation will create one, which is arguably better since if you specify a name, you cannot perform updates that require replacement of the resource.

https://godoc.org/github.com/crewjam/go-cloudformation#EC2SecurityGroup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html

That would very nice if you could have information if a property is required. This would a way road for linters based on your library.

If I am not mistaken, *Expr types can be extended with a bool field.

I discovered that S3NotificationConfiguration has properties like LambdaConfigurations that are clearly from context supposded to be []SimpleStorageServiceNotificationConfigurationLambdaConfigurations but are actually SimpleStorageServiceNotificationConfigurationLambdaConfigurations.

The heuristic we use to determine when something is a list failed for this item. I generated a list of other possible similar errors which appears below with the following code:

for _, resource := range tr.Resources {
    for _, property := range resource.Properties {
        if n := property.GoName(); !strings.HasSuffix(n, "s") {
            continue
        }
        if t := property.GoType(&tr); strings.Contains(t, "List") {
            continue
        }
        if t := property.GoType(&tr); strings.Contains(t, "[]") {
            continue
        }
        if t := property.GoType(&tr); strings.Contains(t, "interface{}") {
            continue
        }
        fmt.Fprintf(os.Stderr, "* in "+
            "[%s](https://godoc.org/github.com/crewjam/go-cloudformation#%s) "+
            "property `%s` has type `%s` but should maybe be a list type. [ref](%s)\n",
            resource.GoName(), resource.GoName(),
            property.GoName(),
            property.GoType(&tr),
            rootURL+resource.Href)
    }
}

This list:

• in AutoScalingLaunchConfiguration property AssociatePublicIpAddress has type *BoolExpr but should maybe be a list type. ref
• in CloudFormationStack property Parameters has type *CloudFormationStackParameters but should maybe be a list type. ref
• in CloudFormationStack property TimeoutInMinutes has type *StringExpr but should maybe be a list type. ref
• in CloudTrailTrail property IncludeGlobalServiceEvents has type *BoolExpr but should maybe be a list type. ref
• in CloudWatchAlarm property EvaluationPeriods has type *StringExpr but should maybe be a list type. ref
• in CodeDeployDeploymentConfig property MinimumHealthyHosts has type *CodeDeployDeploymentConfigMinimumHealthyHosts but should maybe be a list type. ref
• in CodeDeployDeploymentGroup property Ec2TagFilters has type *CodeDeployDeploymentGroupEc2TagFilters but should maybe be a list type. ref
• in CodeDeployDeploymentGroup property OnPremisesInstanceTagFilters has type *CodeDeployDeploymentGroupOnPremisesInstanceTagFilters but should maybe be a list type. ref
• in CodePipelineCustomAction property InputArtifactDetails has type *CodePipelineCustomActionTypeArtifactDetails but should maybe be a list type. ref
• in CodePipelineCustomAction property OutputArtifactDetails has type *CodePipelineCustomActionTypeArtifactDetails but should maybe be a list type. ref
• in CodePipelineCustomAction property Settings has type *CodePipelineCustomActionTypeSettings but should maybe be a list type. ref
• in CodePipelinePipeline property Stages has type *CodePipelinePipelineStages but should maybe be a list type. ref
• in ConfigDeliveryChannel property ConfigSnapshotDeliveryProperties has type *ConfigDeliveryChannelConfigSnapshotDeliveryProperties but should maybe be a list type. ref
• in DataPipelinePipeline property ParameterObjects has type *DataPipelinePipelineParameterObjects but should maybe be a list type. ref
• in DataPipelinePipeline property ParameterValues has type *DataPipelinePipelineParameterValues but should maybe be a list type. ref
• in DirectoryServiceMicrosoftAD property CreateAlias has type *BoolExpr but should maybe be a list type. ref
• in DirectoryServiceMicrosoftAD property VpcSettings has type *DirectoryServiceMicrosoftADVpcSettings but should maybe be a list type. ref
• in DirectoryServiceSimpleAD property CreateAlias has type *BoolExpr but should maybe be a list type. ref
• in DirectoryServiceSimpleAD property VpcSettings has type *DirectoryServiceSimpleADVpcSettings but should maybe be a list type. ref
• in DynamoDBTable property GlobalSecondaryIndexes has type *DynamoDBGlobalSecondaryIndexes but should maybe be a list type. ref
• in DynamoDBTable property LocalSecondaryIndexes has type *DynamoDBLocalSecondaryIndexes but should maybe be a list type. ref
• in EC2CustomerGateway property IpAddress has type *StringExpr but should maybe be a list type. ref
• in EC2EIPAssociation property PrivateIpAddress has type *StringExpr but should maybe be a list type. ref
• in EC2Instance property PrivateIpAddress has type *StringExpr but should maybe be a list type. ref
• in EC2NetworkAclEntry property Egress has type *BoolExpr but should maybe be a list type. ref
• in EC2NetworkInterface property PrivateIpAddress has type *StringExpr but should maybe be a list type. ref
• in EC2Volume property Iops has type *IntegerExpr but should maybe be a list type. ref
• in EC2VPC property EnableDnsHostnames has type *BoolExpr but should maybe be a list type. ref
• in EFSFileSystem property FileSystemTags has type *ElasticFileSystemFileSystemFileSystemTags but should maybe be a list type. ref
• in EFSMountTarget property IpAddress has type *StringExpr but should maybe be a list type. ref
• in ElastiCacheCacheCluster property NumCacheNodes has type *StringExpr but should maybe be a list type. ref
• in ElastiCacheReplicationGroup property NumCacheClusters has type *IntegerExpr but should maybe be a list type. ref
• in ElasticLoadBalancingLoadBalancer property ConnectionSettings has type *ElasticLoadBalancingConnectionSettings but should maybe be a list type. ref
• in IAMAccessKey property Status has type *StringExpr but should maybe be a list type. ref
• in LogsLogGroup property RetentionInDays has type *IntegerExpr but should maybe be a list type. ref
• in OpsWorksInstance property Os has type *StringExpr but should maybe be a list type. ref
• in OpsWorksLayer property AutoAssignElasticIps has type *BoolExpr but should maybe be a list type. ref
• in OpsWorksLayer property AutoAssignPublicIps has type *BoolExpr but should maybe be a list type. ref
• in OpsWorksLayer property CustomRecipes has type *OpsWorksRecipes but should maybe be a list type. ref
• in OpsWorksStack property DefaultOs has type *StringExpr but should maybe be a list type. ref
• in OpsWorksStack property UseCustomCookbooks has type *BoolExpr but should maybe be a list type. ref
• in OpsWorksStack property UseOpsworksSecurityGroups has type *BoolExpr but should maybe be a list type. ref
• in RDSDBCluster property AvailabilityZones has type *StringExpr but should maybe be a list type. ref
• in RDSDBInstance property DBInstanceClass has type *StringExpr but should maybe be a list type. ref
• in RDSDBInstance property Iops has type *IntegerExpr but should maybe be a list type. ref
• in RDSOptionGroup property OptionConfigurations has type *RDSOptionGroupOptionConfigurations but should maybe be a list type. ref
• in RedshiftCluster property NumberOfNodes has type *IntegerExpr but should maybe be a list type. ref
• in SQSQueue property DelaySeconds has type *IntegerExpr but should maybe be a list type. ref
• in SQSQueue property ReceiveMessageWaitTimeSeconds has type *IntegerExpr but should maybe be a list type. ref
• in AutoScalingBlockDeviceMapping property Ebs has type *AutoScalingEBSBlockDevice but should maybe be a list type. ref
• in AutoScalingEBSBlockDevice property Iops has type *IntegerExpr but should maybe be a list type. ref
• in CloudFrontDistributionConfig property CustomErrorResponses has type *CloudFrontDistributionConfigCustomErrorResponse but should maybe be a list type. ref
• in CloudFrontDistributionConfig property PriceClass has type *StringExpr but should maybe be a list type. ref
• in CloudFrontDistributionConfig property Restrictions has type *CloudFrontDistributionConfigurationRestrictions but should maybe be a list type. ref
• in CloudFrontDistributionConfigCacheBehavior property ForwardedValues has type *CloudFrontForwardedValues but should maybe be a list type. ref
• in CloudFrontDefaultCacheBehavior property ForwardedValues has type *CloudFrontForwardedValues but should maybe be a list type. ref
• in CloudFrontLogging property IncludeCookies has type *BoolExpr but should maybe be a list type. ref
• in CloudFrontForwardedValues property Cookies has type *CloudFrontForwardedValuesCookies but should maybe be a list type. ref
• in CodeDeployDeploymentGroupDeployment property IgnoreApplicationStopFailures has type *BoolExpr but should maybe be a list type. ref
• in ConfigConfigRuleSource property SourceDetails has type *ConfigConfigRuleSourceSourceDetails but should maybe be a list type. ref
• in DataPipelinePipelineParameterObjects property Attributes has type *DataPipelineParameterObjectsAttributes but should maybe be a list type. ref
• in DataPipelinePipelineObjects property Fields has type *DataPipelineDataPipelineObjectFields but should maybe be a list type. ref
• in EC2BlockDeviceMappingProperty property Ebs has type *ElasticBlockStoreBlockDeviceProperty but should maybe be a list type. ref
• in ElasticBlockStoreBlockDeviceProperty property Iops has type *IntegerExpr but should maybe be a list type. ref
• in EC2NetworkInterfaceEmbedded property AssociatePublicIpAddress has type *BoolExpr but should maybe be a list type. ref
• in EC2NetworkInterfaceEmbedded property PrivateIpAddress has type *StringExpr but should maybe be a list type. ref
• in EC2NetworkInterfacePrivateIPSpecification property PrivateIpAddress has type *StringExpr but should maybe be a list type. ref
• in ElasticComputeCloudSpotFleetSpotFleetRequestConfigDataLaunchSpecificationsBlockDeviceMappings property Ebs has type *ElasticComputeCloudSpotFleetSpotFleetRequestConfigDataLaunchSpecificationsBlockDeviceMappingsEbs but should maybe be a list type. ref
• in ElasticComputeCloudSpotFleetSpotFleetRequestConfigDataLaunchSpecificationsBlockDeviceMappingsEbs property Iops has type *IntegerExpr but should maybe be a list type. ref
• in ElasticComputeCloudSpotFleetSpotFleetRequestConfigDataLaunchSpecificationsNetworkInterfaces property AssociatePublicIpAddress has type *BoolExpr but should maybe be a list type. ref
• in ElasticComputeCloudSpotFleetSpotFleetRequestConfigDataLaunchSpecificationsNetworkInterfacesPrivateIpAddresses property PrivateIpAddress has type *StringExpr but should maybe be a list type. ref
• in OpsWorksVolumeConfiguration property Iops has type *IntegerExpr but should maybe be a list type. ref
• in OpsWorksVolumeConfiguration property NumberOfDisks has type *IntegerExpr but should maybe be a list type. ref
• in RDSOptionGroupOptionConfigurations property OptionSettings has type *RDSOptionGroupOptionConfigurationsOptionSettings but should maybe be a list type. ref
• in Route53HealthCheckConfig property IPAddress has type *StringExpr but should maybe be a list type. ref
• in S3CorsConfiguration property CorsRules has type *S3CorsConfigurationRule but should maybe be a list type. ref
• in S3LifecycleConfiguration property Rules has type *S3LifecycleRule but should maybe be a list type. ref
• in S3LifecycleRule property ExpirationInDays has type *IntegerExpr but should maybe be a list type. ref
• in S3LifecycleRule property NoncurrentVersionExpirationInDays has type *IntegerExpr but should maybe be a list type. ref
• in S3LifecycleRule property Status has type *StringExpr but should maybe be a list type. ref
• in S3LifecycleRuleNoncurrentVersionTransition property StorageClass has type *StringExpr but should maybe be a list type. ref
• in S3LifecycleRuleNoncurrentVersionTransition property TransitionInDays has type *IntegerExpr but should maybe be a list type. ref
• in S3LifecycleRuleTransition property StorageClass has type *StringExpr but should maybe be a list type. ref
• in S3LifecycleRuleTransition property TransitionInDays has type *IntegerExpr but should maybe be a list type. ref
• in S3ReplicationConfigurationRules property Status has type *StringExpr but should maybe be a list type. ref
• in S3ReplicationConfigurationRulesDestination property StorageClass has type *StringExpr but should maybe be a list type. ref
• in S3VersioningConfiguration property Status has type *StringExpr but should maybe be a list type. ref
• in S3WebsiteConfigurationRoutingRulesRoutingRuleConditionProperty property HttpErrorCodeReturnedEquals has type *StringExpr but should maybe be a list type. ref
• in S3WebsiteConfigurationRoutingRulesRoutingRuleConditionProperty property KeyPrefixEquals has type *StringExpr but should maybe be a list type. ref

The examples no longer compile with the breaking change introduced by #23. See https://travis-ci.org/crewjam/go-cloudformation/jobs/388076677 for more info.

CloudFormation has released some new properties recently. Is it possible to regenerate the schema?

Also, thinking out loud, thoughts on running the schema generation code as a Lambda function with a cron-style trigger? Maybe post the generated code to public S3? Might be an interesting case study for serverless.

schema.go L7269-7273 contains:
// EC2PortRange represents EC2 PortRange Property Type
//
// see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-port-range.html
type EC2PortRange struct {
}

struct should be:
type EC2PortRange struct {
From *IntegerExpr
To *IntegerExpr
}

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-resource-specification.html

https://twitter.com/mweagle/status/801504204615454720

https://github.com/crewjam/etcd-aws/blob/master/aws/iam.go

type PolicyDocument struct {
    Version   string `json:",omitempty"`
    Statement []Policy
}

type Policy struct {
    Sid            string              `json:",omitempty"`
    Effect         string              `json:",omitempty"`
    Principal      *Principal          `json:",omitempty"`
    Action         *cfn.StringListExpr `json:",omitempty"`
    Resource       *cfn.StringListExpr `json:",omitempty"`
    ConditionBlock interface{}         `json:",omitempty"`
}

type Principal struct {
    Service *cfn.StringListExpr `json:",omitempty"`
}

Would you like to add license notation ?

When creating an ingress/egress rule using a security group ID, this creates incorrect JSON. For example, the following:

EC2SecurityGroupRule{
	SourceSecurityGroupIdXXSecurityGroupIngressXOnlyX: Ref(s.elbSecurityGroupLogicalName()).String(),
	IpProtocol:                                        String(tcpProtocol),
	FromPort:                                          Integer(httpsPort),
	ToPort:                                            Integer(httpsPort),
},

Generates the JSON:

{
    "FromPort": 443,
    "IpProtocol": "tcp",
    "SourceSecurityGroupId (SecurityGroupIngress only)": {
        "Ref": "LBSecurityGroupGamma"
    },
    "ToPort": 443
}

The expected output is:

{
    "FromPort": 443,
    "IpProtocol": "tcp",
    "SourceSecurityGroupId": {
        "Ref": "LBSecurityGroupGamma"
    },
    "ToPort": 443
}

This is probably due to how the scraper is scraping the AWS website, causing it to include the (SecurityGroupIngress only) as seen here:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html#cfn-ec2-security-group-rule-sourcesecuritygroupid