How do I resolve the "Resource timed out waiting for creation of physical resource" error when I use my resource provider type in CloudFormation to create a resource?

Resolution

When resources don't return their primaryIdentifier or Physical ID within 60 seconds, you receive the "Resource timed out waiting for creation of physical resource" error. This error occurs because the CreateHandler of your resource doesn't return the property that's specified as the primaryIdentifier in the resource type schema file.

Note: The file uses the organization-service-resource.json naming format. For example, article-ec2-subnet.json is the file name for an Amazon Elastic Cloud Compute (Amazon EC2) resource that's named Article::EC2::Subnet.

To resolve the issue, complete the following steps:

1. In your resource type schema file, confirm that the primaryIdentifier definition uses the following format:

   "primaryIdentifier": [      
          "/properties/Id"
   ]

   Note: Replace Id with the property ID. You can find the resource schema type file in the root directory of your project.
2. In your CreateHandler file, set the primaryIdentifier property in the model object.
   Example:

   final ResourceModel model = request.getDesiredResourceState();
   model.setId("abcdxyz");
   return ProgressEvent.<ResourceModel, CallbackContext>builder()
       .resourceModel(model)
       .status(OperationStatus.SUCCESS)
       .build();

   Note: Replace Id with the resource's primary identifier and abcdxyz with a unique identifier value for your property.

If you receive a different error when you use your resource provider, then see the following AWS Knowledge Center articles to troubleshoot:

• How do I resolve the "Resource specification is invalid" error when I use the CloudFormation CLI to run the cfn generate command?
• How do I resolve the "Model validation failed (#: extraneous key [Key] is not permitted)" error in CloudFormation?
• How do I resolve the "Attribute 'Key' does not exist" error when I use the Fn::GetAtt function on my resource provider resource in CloudFormation?
• How do I resolve the "java.lang.ClassNotFoundException: com.example.package.resource.HandlerWrapper" error in CloudFormation?

Related information

CloudFormation CLI on the GitHub website.