Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateComponent

Create an AWS Proton component. A component is an infrastructure extension for a service instance.

For more information about components, see AWS Proton components in the AWS Proton User Guide.

Request Syntax


{
   "clientToken": "string",
   "description": "string",
   "environmentName": "string",
   "manifest": "string",
   "name": "string",
   "serviceInstanceName": "string",
   "serviceName": "string",
   "serviceSpec": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "templateFile": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

clientToken

The client token for the created component.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: ^[!-~]*$

Required: No

description

An optional customer-provided description of the component.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

environmentName

The name of the AWS Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

manifest

A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

name

The customer-provided name of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

serviceInstanceName

The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

serviceName

The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

serviceSpec

The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

Required: No

tags

An optional list of metadata items that you can associate with the AWS Proton component. A tag is a key-value pair.

For more information, see AWS Proton resources and tagging in the AWS Proton User Guide.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

templateFile

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Note

Components support a single IaC file, even if you use Terraform as your template language.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

Required: Yes

Response Syntax


{
   "component": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "description": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastModifiedAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceInstanceName": "string",
      "serviceName": "string",
      "serviceSpec": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

component

The detailed data of the created component.

Type: Component object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton User Guide.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400