Skip to content

Resource: awsCloudcontrolapiResource

Manages a Cloud Control API Resource. The configuration and lifecycle handling of these resources is proxied through Cloud Control API handlers to the backend service.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.cloudcontrolapiResource.CloudcontrolapiResource(this, "example", {
  desiredState:
    '${jsonencode({\n    ClusterName = "example"\n    Tags = [\n      {\n        Key   = "CostCenter"\n        Value = "IT"\n      }\n    ]\n  })}',
  typeName: "AWS::ECS::Cluster",
});

Argument Reference

The following arguments are required:

  • desiredState - (Required) JSON string matching the CloudFormation resource type schema with desired configuration. Terraform configuration expressions can be converted into JSON using the jsonencode() function.
  • typeName - (Required) CloudFormation resource type name. For example, aws::ec2::vpc.

The following arguments are optional:

  • roleArn - (Optional) Amazon Resource Name (ARN) of the IAM Role to assume for operations.
  • schema - (Optional) JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same typeName, it is recommended to fetch the schema once via the awsCloudformationType data source and use this argument to reduce describeType API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.
  • typeVersionId - (Optional) Identifier of the CloudFormation resource type version.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • properties - JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the jsondecode() function, for example, jsondecode(dataAwsCloudcontrolapiResourceExampleProperties)["example"].