Proton / Client / create_component

create_component#

Proton.Client.create_component(**kwargs)#

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

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

See also: AWS API Documentation

Request Syntax

response = client.create_component(
    clientToken='string',
    description='string',
    environmentName='string',
    manifest='string',
    name='string',
    serviceInstanceName='string',
    serviceName='string',
    serviceSpec='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateFile='string'
)
Parameters:

  • clientToken (string) –

    The client token for the created component.

    This field is autopopulated if not provided.

  • description (string) – An optional customer-provided description of the component.

  • environmentName (string) – The name of the Proton environment that you want to associate this component with. You must specify this when you don’t specify serviceInstanceName and serviceName.

  • manifest (string) –

    [REQUIRED]

    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.

  • name (string) –

    [REQUIRED]

    The customer-provided name of the component.

  • serviceInstanceName (string) – 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.

  • serviceName (string) – 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.

  • serviceSpec (string) – 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.

  • tags (list) –

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

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

    • (dict) –

      A description of a resource tag.

      • key (string) – [REQUIRED]

        The key of the resource tag.

      • value (string) – [REQUIRED]

        The value of the resource tag.

  • templateFile (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'component': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentName': 'string',
        'lastAttemptedDeploymentId': 'string',
        'lastClientRequestToken': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'lastModifiedAt': datetime(2015, 1, 1),
        'lastSucceededDeploymentId': 'string',
        'name': 'string',
        'serviceInstanceName': 'string',
        'serviceName': 'string',
        'serviceSpec': 'string'
    }
}

Response Structure

  • (dict) –

    • component (dict) –

      The detailed data of the created component.

      • arn (string) –

        The Amazon Resource Name (ARN) of the component.

      • createdAt (datetime) –

        The time when the component was created.

      • deploymentStatus (string) –

        The component deployment status.

      • deploymentStatusMessage (string) –

        The message associated with the component deployment status.

      • description (string) –

        A description of the component.

      • environmentName (string) –

        The name of the Proton environment that this component is associated with.

      • lastAttemptedDeploymentId (string) –

        The ID of the last attempted deployment of this component.

      • lastClientRequestToken (string) –

        The last token the client requested.

      • lastDeploymentAttemptedAt (datetime) –

        The time when a deployment of the component was last attempted.

      • lastDeploymentSucceededAt (datetime) –

        The time when the component was last deployed successfully.

      • lastModifiedAt (datetime) –

        The time when the component was last modified.

      • lastSucceededDeploymentId (string) –

        The ID of the last successful deployment of this component.

      • name (string) –

        The name of the component.

      • serviceInstanceName (string) –

        The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

      • serviceName (string) –

        The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

      • serviceSpec (string) –

        The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

Exceptions