amazonka-proton-2.0: Amazon Proton SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Proton.Lens

Contents

Description

 
Synopsis

Operations

AcceptEnvironmentAccountConnection

CancelComponentDeployment

cancelComponentDeployment_componentName :: Lens' CancelComponentDeployment Text Source #

The name of the component with the deployment to cancel.

cancelComponentDeploymentResponse_component :: Lens' CancelComponentDeploymentResponse Component Source #

The detailed data of the component with the deployment that is being canceled.

CancelEnvironmentDeployment

cancelEnvironmentDeployment_environmentName :: Lens' CancelEnvironmentDeployment Text Source #

The name of the environment with the deployment to cancel.

CancelServiceInstanceDeployment

cancelServiceInstanceDeployment_serviceInstanceName :: Lens' CancelServiceInstanceDeployment Text Source #

The name of the service instance with the deployment to cancel.

cancelServiceInstanceDeployment_serviceName :: Lens' CancelServiceInstanceDeployment Text Source #

The name of the service with the service instance deployment to cancel.

CancelServicePipelineDeployment

cancelServicePipelineDeployment_serviceName :: Lens' CancelServicePipelineDeployment Text Source #

The name of the service with the service pipeline deployment to cancel.

CreateComponent

createComponent_description :: Lens' CreateComponent (Maybe Text) Source #

An optional customer-provided description of the component.

createComponent_environmentName :: Lens' CreateComponent (Maybe Text) Source #

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.

createComponent_serviceInstanceName :: Lens' CreateComponent (Maybe Text) Source #

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.

createComponent_serviceName :: Lens' CreateComponent (Maybe Text) Source #

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.

createComponent_serviceSpec :: Lens' CreateComponent (Maybe Text) Source #

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.

createComponent_tags :: Lens' CreateComponent (Maybe [Tag]) Source #

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.

createComponent_manifest :: Lens' CreateComponent Text Source #

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.

createComponent_name :: Lens' CreateComponent Text Source #

The customer-provided name of the component.

createComponent_templateFile :: Lens' CreateComponent Text Source #

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

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

CreateEnvironment

createEnvironment_codebuildRoleArn :: Lens' CreateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

createEnvironment_componentRoleArn :: Lens' CreateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

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

createEnvironment_description :: Lens' CreateEnvironment (Maybe Text) Source #

A description of the environment that's being created and deployed.

createEnvironment_environmentAccountConnectionId :: Lens' CreateEnvironment (Maybe Text) Source #

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

createEnvironment_protonServiceRoleArn :: Lens' CreateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

createEnvironment_provisioningRepository :: Lens' CreateEnvironment (Maybe RepositoryBranchInput) Source #

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe [Tag]) Source #

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

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

createEnvironment_templateMinorVersion :: Lens' CreateEnvironment (Maybe Text) Source #

The minor version of the environment template.

createEnvironment_spec :: Lens' CreateEnvironment Text Source #

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

createEnvironment_templateMajorVersion :: Lens' CreateEnvironment Text Source #

The major version of the environment template.

createEnvironment_templateName :: Lens' CreateEnvironment Text Source #

The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

createEnvironmentResponse_environment :: Lens' CreateEnvironmentResponse Environment Source #

The environment detail data that's returned by Proton.

CreateEnvironmentAccountConnection

createEnvironmentAccountConnection_clientToken :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #

When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.

createEnvironmentAccountConnection_codebuildRoleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

createEnvironmentAccountConnection_componentRoleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.

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

createEnvironmentAccountConnection_roleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.

createEnvironmentAccountConnection_tags :: Lens' CreateEnvironmentAccountConnection (Maybe [Tag]) Source #

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

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

createEnvironmentAccountConnection_environmentName :: Lens' CreateEnvironmentAccountConnection Text Source #

The name of the Proton environment that's created in the associated management account.

createEnvironmentAccountConnection_managementAccountId :: Lens' CreateEnvironmentAccountConnection Text Source #

The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

CreateEnvironmentTemplate

createEnvironmentTemplate_displayName :: Lens' CreateEnvironmentTemplate (Maybe Text) Source #

The environment template name as displayed in the developer interface.

createEnvironmentTemplate_encryptionKey :: Lens' CreateEnvironmentTemplate (Maybe Text) Source #

A customer provided encryption key that Proton uses to encrypt data.

createEnvironmentTemplate_provisioning :: Lens' CreateEnvironmentTemplate (Maybe Provisioning) Source #

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

createEnvironmentTemplate_tags :: Lens' CreateEnvironmentTemplate (Maybe [Tag]) Source #

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

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

CreateEnvironmentTemplateVersion

createEnvironmentTemplateVersion_clientToken :: Lens' CreateEnvironmentTemplateVersion (Maybe Text) Source #

When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.

createEnvironmentTemplateVersion_description :: Lens' CreateEnvironmentTemplateVersion (Maybe Text) Source #

A description of the new version of an environment template.

createEnvironmentTemplateVersion_majorVersion :: Lens' CreateEnvironmentTemplateVersion (Maybe Text) Source #

To create a new minor version of the environment template, include major Version.

To create a new major and minor version of the environment template, exclude major Version.

createEnvironmentTemplateVersion_tags :: Lens' CreateEnvironmentTemplateVersion (Maybe [Tag]) Source #

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

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

createEnvironmentTemplateVersion_source :: Lens' CreateEnvironmentTemplateVersion TemplateVersionSourceInput Source #

An object that includes the template bundle S3 bucket path and name for the new version of an template.

CreateRepository

createRepository_encryptionKey :: Lens' CreateRepository (Maybe Text) Source #

The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.

createRepository_tags :: Lens' CreateRepository (Maybe [Tag]) Source #

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

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

createRepository_connectionArn :: Lens' CreateRepository Text Source #

The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see Setting up for Proton in the Proton User Guide.

createRepository_name :: Lens' CreateRepository Text Source #

The repository name (for example, myrepos/myrepo).

createRepositoryResponse_repository :: Lens' CreateRepositoryResponse Repository Source #

The repository link's detail data that's returned by Proton.

CreateService

createService_branchName :: Lens' CreateService (Maybe Text) Source #

The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

createService_description :: Lens' CreateService (Maybe Text) Source #

A description of the Proton service.

createService_repositoryConnectionArn :: Lens' CreateService (Maybe Text) Source #

The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

createService_repositoryId :: Lens' CreateService (Maybe Text) Source #

The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

createService_tags :: Lens' CreateService (Maybe [Tag]) Source #

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

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

createService_templateMinorVersion :: Lens' CreateService (Maybe Text) Source #

The minor version of the service template that was used to create the service.

createService_spec :: Lens' CreateService Text Source #

A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.

createService_templateMajorVersion :: Lens' CreateService Text Source #

The major version of the service template that was used to create the service.

createService_templateName :: Lens' CreateService Text Source #

The name of the service template that's used to create the service.

createServiceResponse_service :: Lens' CreateServiceResponse Service Source #

The service detail data that's returned by Proton.

CreateServiceTemplate

createServiceTemplate_displayName :: Lens' CreateServiceTemplate (Maybe Text) Source #

The name of the service template as displayed in the developer interface.

createServiceTemplate_encryptionKey :: Lens' CreateServiceTemplate (Maybe Text) Source #

A customer provided encryption key that's used to encrypt data.

createServiceTemplate_pipelineProvisioning :: Lens' CreateServiceTemplate (Maybe Provisioning) Source #

By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

createServiceTemplate_tags :: Lens' CreateServiceTemplate (Maybe [Tag]) Source #

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

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

CreateServiceTemplateVersion

createServiceTemplateVersion_clientToken :: Lens' CreateServiceTemplateVersion (Maybe Text) Source #

When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

createServiceTemplateVersion_description :: Lens' CreateServiceTemplateVersion (Maybe Text) Source #

A description of the new version of a service template.

createServiceTemplateVersion_majorVersion :: Lens' CreateServiceTemplateVersion (Maybe Text) Source #

To create a new minor version of the service template, include a major Version.

To create a new major and minor version of the service template, exclude major Version.

createServiceTemplateVersion_supportedComponentSources :: Lens' CreateServiceTemplateVersion (Maybe [ServiceTemplateSupportedComponentSourceType]) Source #

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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

createServiceTemplateVersion_tags :: Lens' CreateServiceTemplateVersion (Maybe [Tag]) Source #

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

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

createServiceTemplateVersion_compatibleEnvironmentTemplates :: Lens' CreateServiceTemplateVersion (NonEmpty CompatibleEnvironmentTemplateInput) Source #

An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

createServiceTemplateVersion_source :: Lens' CreateServiceTemplateVersion TemplateVersionSourceInput Source #

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

createServiceTemplateVersionResponse_serviceTemplateVersion :: Lens' CreateServiceTemplateVersionResponse ServiceTemplateVersion Source #

The service template version summary of detail data that's returned by Proton.

CreateTemplateSyncConfig

createTemplateSyncConfig_subdirectory :: Lens' CreateTemplateSyncConfig (Maybe Text) Source #

A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.

createTemplateSyncConfig_branch :: Lens' CreateTemplateSyncConfig Text Source #

The repository branch for your template.

createTemplateSyncConfig_repositoryName :: Lens' CreateTemplateSyncConfig Text Source #

The repository name (for example, myrepos/myrepo).

createTemplateSyncConfigResponse_templateSyncConfig :: Lens' CreateTemplateSyncConfigResponse (Maybe TemplateSyncConfig) Source #

The template sync configuration detail data that's returned by Proton.

DeleteComponent

deleteComponent_name :: Lens' DeleteComponent Text Source #

The name of the component to delete.

deleteComponentResponse_component :: Lens' DeleteComponentResponse (Maybe Component) Source #

The detailed data of the component being deleted.

DeleteEnvironment

deleteEnvironment_name :: Lens' DeleteEnvironment Text Source #

The name of the environment to delete.

deleteEnvironmentResponse_environment :: Lens' DeleteEnvironmentResponse (Maybe Environment) Source #

The detailed data of the environment being deleted.

DeleteEnvironmentAccountConnection

deleteEnvironmentAccountConnection_id :: Lens' DeleteEnvironmentAccountConnection Text Source #

The ID of the environment account connection to delete.

DeleteEnvironmentTemplate

deleteEnvironmentTemplate_name :: Lens' DeleteEnvironmentTemplate Text Source #

The name of the environment template to delete.

DeleteEnvironmentTemplateVersion

DeleteRepository

deleteRepositoryResponse_repository :: Lens' DeleteRepositoryResponse (Maybe Repository) Source #

The deleted repository link's detail data that's returned by Proton.

DeleteService

deleteService_name :: Lens' DeleteService Text Source #

The name of the service to delete.

deleteServiceResponse_service :: Lens' DeleteServiceResponse (Maybe Service) Source #

The detailed data of the service being deleted.

DeleteServiceTemplate

deleteServiceTemplate_name :: Lens' DeleteServiceTemplate Text Source #

The name of the service template to delete.

DeleteServiceTemplateVersion

DeleteTemplateSyncConfig

deleteTemplateSyncConfigResponse_templateSyncConfig :: Lens' DeleteTemplateSyncConfigResponse (Maybe TemplateSyncConfig) Source #

The template sync configuration detail data that's returned by Proton.

GetAccountSettings

getAccountSettingsResponse_accountSettings :: Lens' GetAccountSettingsResponse (Maybe AccountSettings) Source #

The Proton pipeline service role detail data that's returned by Proton.

GetComponent

getComponent_name :: Lens' GetComponent Text Source #

The name of the component that you want to get the detailed data for.

getComponentResponse_component :: Lens' GetComponentResponse (Maybe Component) Source #

The detailed data of the requested component.

GetEnvironment

getEnvironment_name :: Lens' GetEnvironment Text Source #

The name of the environment that you want to get the detailed data for.

getEnvironmentResponse_environment :: Lens' GetEnvironmentResponse Environment Source #

The detailed data of the requested environment.

GetEnvironmentAccountConnection

getEnvironmentAccountConnection_id :: Lens' GetEnvironmentAccountConnection Text Source #

The ID of the environment account connection that you want to get the detailed data for.

GetEnvironmentTemplate

getEnvironmentTemplate_name :: Lens' GetEnvironmentTemplate Text Source #

The name of the environment template that you want to get the detailed data for.

GetEnvironmentTemplateVersion

getEnvironmentTemplateVersion_majorVersion :: Lens' GetEnvironmentTemplateVersion Text Source #

To get environment template major version detail data, include major Version.

getEnvironmentTemplateVersion_minorVersion :: Lens' GetEnvironmentTemplateVersion Text Source #

To get environment template minor version detail data, include minorVersion.

getEnvironmentTemplateVersion_templateName :: Lens' GetEnvironmentTemplateVersion Text Source #

The name of the environment template a version of which you want to get detailed data for.

GetRepository

getRepository_name :: Lens' GetRepository Text Source #

The repository name, for example myrepos/myrepo.

getRepositoryResponse_repository :: Lens' GetRepositoryResponse Repository Source #

The repository link's detail data that's returned by Proton.

GetRepositorySyncStatus

getRepositorySyncStatusResponse_latestSync :: Lens' GetRepositorySyncStatusResponse (Maybe RepositorySyncAttempt) Source #

The repository sync status detail data that's returned by Proton.

GetService

getService_name :: Lens' GetService Text Source #

The name of the service that you want to get the detailed data for.

getServiceResponse_service :: Lens' GetServiceResponse (Maybe Service) Source #

The detailed data of the requested service.

GetServiceInstance

getServiceInstance_name :: Lens' GetServiceInstance Text Source #

The name of a service instance that you want to get the detailed data for.

getServiceInstance_serviceName :: Lens' GetServiceInstance Text Source #

The name of the service that the service instance belongs to.

GetServiceTemplate

getServiceTemplate_name :: Lens' GetServiceTemplate Text Source #

The name of the service template that you want to get detailed data for.

GetServiceTemplateVersion

getServiceTemplateVersion_majorVersion :: Lens' GetServiceTemplateVersion Text Source #

To get service template major version detail data, include major Version.

getServiceTemplateVersion_minorVersion :: Lens' GetServiceTemplateVersion Text Source #

To get service template minor version detail data, include minorVersion.

getServiceTemplateVersion_templateName :: Lens' GetServiceTemplateVersion Text Source #

The name of the service template a version of which you want to get detailed data for.

GetTemplateSyncConfig

getTemplateSyncConfigResponse_templateSyncConfig :: Lens' GetTemplateSyncConfigResponse (Maybe TemplateSyncConfig) Source #

The template sync configuration detail data that's returned by Proton.

GetTemplateSyncStatus

getTemplateSyncStatusResponse_desiredState :: Lens' GetTemplateSyncStatusResponse (Maybe Revision) Source #

The template sync desired state that's returned by Proton.

getTemplateSyncStatusResponse_latestSuccessfulSync :: Lens' GetTemplateSyncStatusResponse (Maybe ResourceSyncAttempt) Source #

The details of the last successful sync that's returned by Proton.

ListComponentOutputs

listComponentOutputs_nextToken :: Lens' ListComponentOutputs (Maybe Text) Source #

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

listComponentOutputs_componentName :: Lens' ListComponentOutputs Text Source #

The name of the component whose outputs you want.

listComponentOutputsResponse_nextToken :: Lens' ListComponentOutputsResponse (Maybe Text) Source #

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

listComponentOutputsResponse_outputs :: Lens' ListComponentOutputsResponse [Output] Source #

An array of component Infrastructure as Code (IaC) outputs.

ListComponentProvisionedResources

listComponentProvisionedResources_nextToken :: Lens' ListComponentProvisionedResources (Maybe Text) Source #

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.

listComponentProvisionedResources_componentName :: Lens' ListComponentProvisionedResources Text Source #

The name of the component whose provisioned resources you want.

listComponentProvisionedResourcesResponse_nextToken :: Lens' ListComponentProvisionedResourcesResponse (Maybe Text) Source #

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.

ListComponents

listComponents_environmentName :: Lens' ListComponents (Maybe Text) Source #

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #

The maximum number of components to list.

listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #

A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

listComponents_serviceInstanceName :: Lens' ListComponents (Maybe Text) Source #

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

listComponents_serviceName :: Lens' ListComponents (Maybe Text) Source #

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text) Source #

A token that indicates the location of the next component in the array of components, after the current requested list of components.

ListEnvironmentAccountConnections

listEnvironmentAccountConnections_environmentName :: Lens' ListEnvironmentAccountConnections (Maybe Text) Source #

The environment name that's associated with each listed environment account connection.

listEnvironmentAccountConnections_maxResults :: Lens' ListEnvironmentAccountConnections (Maybe Natural) Source #

The maximum number of environment account connections to list.

listEnvironmentAccountConnections_nextToken :: Lens' ListEnvironmentAccountConnections (Maybe Text) Source #

A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.

listEnvironmentAccountConnectionsResponse_nextToken :: Lens' ListEnvironmentAccountConnectionsResponse (Maybe Text) Source #

A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.

ListEnvironmentOutputs

listEnvironmentOutputs_nextToken :: Lens' ListEnvironmentOutputs (Maybe Text) Source #

A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.

listEnvironmentOutputsResponse_nextToken :: Lens' ListEnvironmentOutputsResponse (Maybe Text) Source #

A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.

listEnvironmentOutputsResponse_outputs :: Lens' ListEnvironmentOutputsResponse [Output] Source #

An array of environment outputs with detail data.

ListEnvironmentProvisionedResources

listEnvironmentProvisionedResources_nextToken :: Lens' ListEnvironmentProvisionedResources (Maybe Text) Source #

A token that indicates the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.

listEnvironmentProvisionedResourcesResponse_nextToken :: Lens' ListEnvironmentProvisionedResourcesResponse (Maybe Text) Source #

A token that indicates the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.

ListEnvironmentTemplateVersions

listEnvironmentTemplateVersions_majorVersion :: Lens' ListEnvironmentTemplateVersions (Maybe Text) Source #

To view a list of minor of versions under a major version of an environment template, include major Version.

To view a list of major versions of an environment template, exclude major Version.

listEnvironmentTemplateVersions_maxResults :: Lens' ListEnvironmentTemplateVersions (Maybe Natural) Source #

The maximum number of major or minor versions of an environment template to list.

listEnvironmentTemplateVersions_nextToken :: Lens' ListEnvironmentTemplateVersions (Maybe Text) Source #

A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.

listEnvironmentTemplateVersionsResponse_nextToken :: Lens' ListEnvironmentTemplateVersionsResponse (Maybe Text) Source #

A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.

ListEnvironmentTemplates

listEnvironmentTemplates_maxResults :: Lens' ListEnvironmentTemplates (Maybe Natural) Source #

The maximum number of environment templates to list.

listEnvironmentTemplates_nextToken :: Lens' ListEnvironmentTemplates (Maybe Text) Source #

A token that indicates the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.

listEnvironmentTemplatesResponse_nextToken :: Lens' ListEnvironmentTemplatesResponse (Maybe Text) Source #

A token that indicates the location of the next environment template in the array of environment templates, after the current requested list of environment templates.

ListEnvironments

listEnvironments_environmentTemplates :: Lens' ListEnvironments (Maybe [EnvironmentTemplateFilter]) Source #

An array of the versions of the environment template.

listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #

The maximum number of environments to list.

listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #

A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.

listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #

A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.

ListRepositories

listRepositories_maxResults :: Lens' ListRepositories (Maybe Natural) Source #

The maximum number of repositories to list.

listRepositories_nextToken :: Lens' ListRepositories (Maybe Text) Source #

A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.

listRepositoriesResponse_nextToken :: Lens' ListRepositoriesResponse (Maybe Text) Source #

A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories.

ListRepositorySyncDefinitions

listRepositorySyncDefinitions_nextToken :: Lens' ListRepositorySyncDefinitions (Maybe Text) Source #

A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.

listRepositorySyncDefinitions_syncType :: Lens' ListRepositorySyncDefinitions SyncType Source #

The sync type. The only supported value is TEMPLATE_SYNC.

listRepositorySyncDefinitionsResponse_nextToken :: Lens' ListRepositorySyncDefinitionsResponse (Maybe Text) Source #

A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.

ListServiceInstanceOutputs

listServiceInstanceOutputs_nextToken :: Lens' ListServiceInstanceOutputs (Maybe Text) Source #

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

listServiceInstanceOutputs_serviceInstanceName :: Lens' ListServiceInstanceOutputs Text Source #

The name of the service instance whose outputs you want.

listServiceInstanceOutputs_serviceName :: Lens' ListServiceInstanceOutputs Text Source #

The name of the service that serviceInstanceName is associated to.

listServiceInstanceOutputsResponse_nextToken :: Lens' ListServiceInstanceOutputsResponse (Maybe Text) Source #

A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.

listServiceInstanceOutputsResponse_outputs :: Lens' ListServiceInstanceOutputsResponse [Output] Source #

An array of service instance Infrastructure as Code (IaC) outputs.

ListServiceInstanceProvisionedResources

listServiceInstanceProvisionedResources_nextToken :: Lens' ListServiceInstanceProvisionedResources (Maybe Text) Source #

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.

listServiceInstanceProvisionedResources_serviceInstanceName :: Lens' ListServiceInstanceProvisionedResources Text Source #

The name of the service instance whose provisioned resources you want.

listServiceInstanceProvisionedResources_serviceName :: Lens' ListServiceInstanceProvisionedResources Text Source #

The name of the service that serviceInstanceName is associated to.

listServiceInstanceProvisionedResourcesResponse_nextToken :: Lens' ListServiceInstanceProvisionedResourcesResponse (Maybe Text) Source #

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.

ListServiceInstances

listServiceInstances_filters :: Lens' ListServiceInstances (Maybe [ListServiceInstancesFilter]) Source #

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

listServiceInstances_maxResults :: Lens' ListServiceInstances (Maybe Natural) Source #

The maximum number of service instances to list.

listServiceInstances_nextToken :: Lens' ListServiceInstances (Maybe Text) Source #

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

listServiceInstances_serviceName :: Lens' ListServiceInstances (Maybe Text) Source #

The name of the service that the service instance belongs to.

listServiceInstances_sortBy :: Lens' ListServiceInstances (Maybe ListServiceInstancesSortBy) Source #

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

listServiceInstances_sortOrder :: Lens' ListServiceInstances (Maybe SortOrder) Source #

Result list sort order.

Default: ASCENDING

listServiceInstancesResponse_nextToken :: Lens' ListServiceInstancesResponse (Maybe Text) Source #

A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.

ListServicePipelineOutputs

listServicePipelineOutputs_nextToken :: Lens' ListServicePipelineOutputs (Maybe Text) Source #

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

listServicePipelineOutputs_serviceName :: Lens' ListServicePipelineOutputs Text Source #

The name of the service whose pipeline's outputs you want.

listServicePipelineOutputsResponse_nextToken :: Lens' ListServicePipelineOutputsResponse (Maybe Text) Source #

A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.

listServicePipelineOutputsResponse_outputs :: Lens' ListServicePipelineOutputsResponse [Output] Source #

An array of service pipeline Infrastructure as Code (IaC) outputs.

ListServicePipelineProvisionedResources

listServicePipelineProvisionedResources_nextToken :: Lens' ListServicePipelineProvisionedResources (Maybe Text) Source #

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.

listServicePipelineProvisionedResources_serviceName :: Lens' ListServicePipelineProvisionedResources Text Source #

The name of the service whose pipeline's provisioned resources you want.

listServicePipelineProvisionedResourcesResponse_nextToken :: Lens' ListServicePipelineProvisionedResourcesResponse (Maybe Text) Source #

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.

ListServiceTemplateVersions

listServiceTemplateVersions_majorVersion :: Lens' ListServiceTemplateVersions (Maybe Text) Source #

To view a list of minor of versions under a major version of a service template, include major Version.

To view a list of major versions of a service template, exclude major Version.

listServiceTemplateVersions_maxResults :: Lens' ListServiceTemplateVersions (Maybe Natural) Source #

The maximum number of major or minor versions of a service template to list.

listServiceTemplateVersions_nextToken :: Lens' ListServiceTemplateVersions (Maybe Text) Source #

A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.

listServiceTemplateVersionsResponse_nextToken :: Lens' ListServiceTemplateVersionsResponse (Maybe Text) Source #

A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.

ListServiceTemplates

listServiceTemplates_maxResults :: Lens' ListServiceTemplates (Maybe Natural) Source #

The maximum number of service templates to list.

listServiceTemplates_nextToken :: Lens' ListServiceTemplates (Maybe Text) Source #

A token that indicates the location of the next service template in the array of service templates, after the list of service templates previously requested.

listServiceTemplatesResponse_nextToken :: Lens' ListServiceTemplatesResponse (Maybe Text) Source #

A token that indicates the location of the next service template in the array of service templates, after the current requested list of service templates.

ListServices

listServices_maxResults :: Lens' ListServices (Maybe Natural) Source #

The maximum number of services to list.

listServices_nextToken :: Lens' ListServices (Maybe Text) Source #

A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text) Source #

A token that indicates the location of the next service in the array of services, after the current requested list of services.

listServicesResponse_services :: Lens' ListServicesResponse [ServiceSummary] Source #

An array of services with summaries of detail data.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource for the listed tags.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

A token that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse [Tag] Source #

A list of resource tags with detail data.

NotifyResourceDeploymentStatusChange

notifyResourceDeploymentStatusChange_outputs :: Lens' NotifyResourceDeploymentStatusChange (Maybe [Output]) Source #

The provisioned resource state change detail data that's returned by Proton.

RejectEnvironmentAccountConnection

rejectEnvironmentAccountConnection_id :: Lens' RejectEnvironmentAccountConnection Text Source #

The ID of the environment account connection to reject.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of customer tags to apply to the Proton resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to remove customer tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of customer tag keys that indicate the customer tags to be removed from the resource.

UpdateAccountSettings

updateAccountSettings_deletePipelineProvisioningRepository :: Lens' UpdateAccountSettings (Maybe Bool) Source #

Set to true to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured pipeline repository.

updateAccountSettings_pipelineCodebuildRoleArn :: Lens' UpdateAccountSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.

updateAccountSettings_pipelineProvisioningRepository :: Lens' UpdateAccountSettings (Maybe RepositoryBranchInput) Source #

A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

To remove a previously configured repository, set deletePipelineProvisioningRepository to true, and don't set pipelineProvisioningRepository.

updateAccountSettings_pipelineServiceRoleArn :: Lens' UpdateAccountSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.

To remove a previously configured ARN, specify an empty string.

updateAccountSettingsResponse_accountSettings :: Lens' UpdateAccountSettingsResponse AccountSettings Source #

The Proton pipeline service role and repository data shared across the Amazon Web Services account.

UpdateComponent

updateComponent_description :: Lens' UpdateComponent (Maybe Text) Source #

An optional customer-provided description of the component.

updateComponent_serviceInstanceName :: Lens' UpdateComponent (Maybe Text) Source #

The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

updateComponent_serviceName :: Lens' UpdateComponent (Maybe Text) Source #

The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

updateComponent_serviceSpec :: Lens' UpdateComponent (Maybe Text) Source #

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

updateComponent_templateFile :: Lens' UpdateComponent (Maybe Text) Source #

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

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

updateComponent_deploymentType :: Lens' UpdateComponent ComponentDeploymentUpdateType Source #

The deployment type. It defines the mode for updating a component, as follows:

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

[] CURRENT_VERSION

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

updateComponent_name :: Lens' UpdateComponent Text Source #

The name of the component to update.

UpdateEnvironment

updateEnvironment_codebuildRoleArn :: Lens' UpdateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

updateEnvironment_componentRoleArn :: Lens' UpdateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text) Source #

A description of the environment update.

updateEnvironment_environmentAccountConnectionId :: Lens' UpdateEnvironment (Maybe Text) Source #

The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

updateEnvironment_protonServiceRoleArn :: Lens' UpdateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.

updateEnvironment_provisioningRepository :: Lens' UpdateEnvironment (Maybe RepositoryBranchInput) Source #

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

updateEnvironment_spec :: Lens' UpdateEnvironment (Maybe Text) Source #

The formatted specification that defines the update.

updateEnvironment_templateMajorVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

The major version of the environment to update.

updateEnvironment_templateMinorVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

The minor version of the environment to update.

updateEnvironment_deploymentType :: Lens' UpdateEnvironment DeploymentUpdateType Source #

There are four modes for updating an environment. The deploymentType field defines the mode.

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

[] CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

[] MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

[] MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

updateEnvironment_name :: Lens' UpdateEnvironment Text Source #

The name of the environment to update.

updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse Environment Source #

The environment detail data that's returned by Proton.

UpdateEnvironmentAccountConnection

updateEnvironmentAccountConnection_codebuildRoleArn :: Lens' UpdateEnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

updateEnvironmentAccountConnection_componentRoleArn :: Lens' UpdateEnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

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

updateEnvironmentAccountConnection_roleArn :: Lens' UpdateEnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.

updateEnvironmentAccountConnection_id :: Lens' UpdateEnvironmentAccountConnection Text Source #

The ID of the environment account connection to update.

UpdateEnvironmentTemplate

updateEnvironmentTemplate_description :: Lens' UpdateEnvironmentTemplate (Maybe Text) Source #

A description of the environment template update.

updateEnvironmentTemplate_displayName :: Lens' UpdateEnvironmentTemplate (Maybe Text) Source #

The name of the environment template to update as displayed in the developer interface.

updateEnvironmentTemplate_name :: Lens' UpdateEnvironmentTemplate Text Source #

The name of the environment template to update.

UpdateEnvironmentTemplateVersion

updateEnvironmentTemplateVersion_description :: Lens' UpdateEnvironmentTemplateVersion (Maybe Text) Source #

A description of environment template version to update.

updateEnvironmentTemplateVersion_status :: Lens' UpdateEnvironmentTemplateVersion (Maybe TemplateVersionStatus) Source #

The status of the environment template minor version to update.

updateEnvironmentTemplateVersion_majorVersion :: Lens' UpdateEnvironmentTemplateVersion Text Source #

To update a major version of an environment template, include major Version.

updateEnvironmentTemplateVersion_minorVersion :: Lens' UpdateEnvironmentTemplateVersion Text Source #

To update a minor version of an environment template, include minorVersion.

UpdateService

updateService_description :: Lens' UpdateService (Maybe Text) Source #

The edited service description.

updateService_spec :: Lens' UpdateService (Maybe Text) Source #

Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton User Guide.

updateService_name :: Lens' UpdateService Text Source #

The name of the service to edit.

updateServiceResponse_service :: Lens' UpdateServiceResponse Service Source #

The service detail data that's returned by Proton.

UpdateServiceInstance

updateServiceInstance_spec :: Lens' UpdateServiceInstance (Maybe Text) Source #

The formatted specification that defines the service instance update.

updateServiceInstance_templateMajorVersion :: Lens' UpdateServiceInstance (Maybe Text) Source #

The major version of the service template to update.

updateServiceInstance_templateMinorVersion :: Lens' UpdateServiceInstance (Maybe Text) Source #

The minor version of the service template to update.

updateServiceInstance_deploymentType :: Lens' UpdateServiceInstance DeploymentUpdateType Source #

The deployment type. It defines the mode for updating a service instance, as follows:

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

[] CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

[] MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

[] MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

updateServiceInstance_name :: Lens' UpdateServiceInstance Text Source #

The name of the service instance to update.

updateServiceInstance_serviceName :: Lens' UpdateServiceInstance Text Source #

The name of the service that the service instance belongs to.

updateServiceInstanceResponse_serviceInstance :: Lens' UpdateServiceInstanceResponse ServiceInstance Source #

The service instance summary data that's returned by Proton.

UpdateServicePipeline

updateServicePipeline_templateMajorVersion :: Lens' UpdateServicePipeline (Maybe Text) Source #

The major version of the service template that was used to create the service that the pipeline is associated with.

updateServicePipeline_templateMinorVersion :: Lens' UpdateServicePipeline (Maybe Text) Source #

The minor version of the service template that was used to create the service that the pipeline is associated with.

updateServicePipeline_deploymentType :: Lens' UpdateServicePipeline DeploymentUpdateType Source #

The deployment type.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

[] NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

[] CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

[] MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

[] MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

updateServicePipeline_serviceName :: Lens' UpdateServicePipeline Text Source #

The name of the service to that the pipeline is associated with.

updateServicePipeline_spec :: Lens' UpdateServicePipeline Text Source #

The spec for the service pipeline to update.

UpdateServiceTemplate

updateServiceTemplate_description :: Lens' UpdateServiceTemplate (Maybe Text) Source #

A description of the service template update.

updateServiceTemplate_displayName :: Lens' UpdateServiceTemplate (Maybe Text) Source #

The name of the service template to update that's displayed in the developer interface.

updateServiceTemplate_name :: Lens' UpdateServiceTemplate Text Source #

The name of the service template to update.

UpdateServiceTemplateVersion

updateServiceTemplateVersion_compatibleEnvironmentTemplates :: Lens' UpdateServiceTemplateVersion (Maybe (NonEmpty CompatibleEnvironmentTemplateInput)) Source #

An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.

updateServiceTemplateVersion_description :: Lens' UpdateServiceTemplateVersion (Maybe Text) Source #

A description of a service template version to update.

updateServiceTemplateVersion_status :: Lens' UpdateServiceTemplateVersion (Maybe TemplateVersionStatus) Source #

The status of the service template minor version to update.

updateServiceTemplateVersion_supportedComponentSources :: Lens' UpdateServiceTemplateVersion (Maybe [ServiceTemplateSupportedComponentSourceType]) Source #

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

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

updateServiceTemplateVersion_majorVersion :: Lens' UpdateServiceTemplateVersion Text Source #

To update a major version of a service template, include major Version.

updateServiceTemplateVersion_minorVersion :: Lens' UpdateServiceTemplateVersion Text Source #

To update a minor version of a service template, include minorVersion.

UpdateTemplateSyncConfig

updateTemplateSyncConfig_subdirectory :: Lens' UpdateTemplateSyncConfig (Maybe Text) Source #

A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.

updateTemplateSyncConfig_branch :: Lens' UpdateTemplateSyncConfig Text Source #

The repository branch for your template.

updateTemplateSyncConfig_repositoryName :: Lens' UpdateTemplateSyncConfig Text Source #

The repository name (for example, myrepos/myrepo).

updateTemplateSyncConfigResponse_templateSyncConfig :: Lens' UpdateTemplateSyncConfigResponse (Maybe TemplateSyncConfig) Source #

The template sync configuration detail data that's returned by Proton.

Types

AccountSettings

accountSettings_pipelineCodebuildRoleArn :: Lens' AccountSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.

accountSettings_pipelineProvisioningRepository :: Lens' AccountSettings (Maybe RepositoryBranch) Source #

The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

accountSettings_pipelineServiceRoleArn :: Lens' AccountSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.

CompatibleEnvironmentTemplate

compatibleEnvironmentTemplate_majorVersion :: Lens' CompatibleEnvironmentTemplate Text Source #

The major version of the compatible environment template.

CompatibleEnvironmentTemplateInput

compatibleEnvironmentTemplateInput_majorVersion :: Lens' CompatibleEnvironmentTemplateInput Text Source #

The major version of the compatible environment template.

Component

component_deploymentStatusMessage :: Lens' Component (Maybe Text) Source #

The message associated with the component deployment status.

component_description :: Lens' Component (Maybe Text) Source #

A description of the component.

component_lastDeploymentAttemptedAt :: Lens' Component (Maybe UTCTime) Source #

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

component_lastDeploymentSucceededAt :: Lens' Component (Maybe UTCTime) Source #

The time when the component was last deployed successfully.

component_serviceInstanceName :: Lens' Component (Maybe Text) Source #

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

component_serviceName :: Lens' Component (Maybe Text) Source #

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

component_serviceSpec :: Lens' Component (Maybe Text) Source #

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

component_arn :: Lens' Component Text Source #

The Amazon Resource Name (ARN) of the component.

component_createdAt :: Lens' Component UTCTime Source #

The time when the component was created.

component_environmentName :: Lens' Component Text Source #

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

component_lastModifiedAt :: Lens' Component UTCTime Source #

The time when the component was last modified.

component_name :: Lens' Component Text Source #

The name of the component.

ComponentSummary

componentSummary_deploymentStatusMessage :: Lens' ComponentSummary (Maybe Text) Source #

The message associated with the component deployment status.

componentSummary_lastDeploymentAttemptedAt :: Lens' ComponentSummary (Maybe UTCTime) Source #

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

componentSummary_lastDeploymentSucceededAt :: Lens' ComponentSummary (Maybe UTCTime) Source #

The time when the component was last deployed successfully.

componentSummary_serviceInstanceName :: Lens' ComponentSummary (Maybe Text) Source #

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

componentSummary_serviceName :: Lens' ComponentSummary (Maybe Text) Source #

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

componentSummary_arn :: Lens' ComponentSummary Text Source #

The Amazon Resource Name (ARN) of the component.

componentSummary_createdAt :: Lens' ComponentSummary UTCTime Source #

The time when the component was created.

componentSummary_environmentName :: Lens' ComponentSummary Text Source #

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

componentSummary_lastModifiedAt :: Lens' ComponentSummary UTCTime Source #

The time when the component was last modified.

Environment

environment_codebuildRoleArn :: Lens' Environment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

environment_componentRoleArn :: Lens' Environment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

environment_deploymentStatusMessage :: Lens' Environment (Maybe Text) Source #

An environment deployment status message.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

environment_environmentAccountConnectionId :: Lens' Environment (Maybe Text) Source #

The ID of the environment account connection that's used to provision infrastructure resources in an environment account.

environment_environmentAccountId :: Lens' Environment (Maybe Text) Source #

The ID of the environment account that the environment infrastructure resources are provisioned in.

environment_protonServiceRoleArn :: Lens' Environment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

environment_provisioning :: Lens' Environment (Maybe Provisioning) Source #

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

environment_provisioningRepository :: Lens' Environment (Maybe RepositoryBranch) Source #

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

environment_spec :: Lens' Environment (Maybe Text) Source #

The environment spec.

environment_arn :: Lens' Environment Text Source #

The Amazon Resource Name (ARN) of the environment.

environment_createdAt :: Lens' Environment UTCTime Source #

The time when the environment was created.

environment_lastDeploymentAttemptedAt :: Lens' Environment UTCTime Source #

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

environment_lastDeploymentSucceededAt :: Lens' Environment UTCTime Source #

The time when the environment was last deployed successfully.

environment_name :: Lens' Environment Text Source #

The name of the environment.

environment_templateMajorVersion :: Lens' Environment Text Source #

The major version of the environment template.

environment_templateMinorVersion :: Lens' Environment Text Source #

The minor version of the environment template.

environment_templateName :: Lens' Environment Text Source #

The Amazon Resource Name (ARN) of the environment template.

EnvironmentAccountConnection

environmentAccountConnection_codebuildRoleArn :: Lens' EnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

environmentAccountConnection_componentRoleArn :: Lens' EnvironmentAccountConnection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

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

environmentAccountConnection_arn :: Lens' EnvironmentAccountConnection Text Source #

The Amazon Resource Name (ARN) of the environment account connection.

environmentAccountConnection_environmentAccountId :: Lens' EnvironmentAccountConnection Text Source #

The environment account that's connected to the environment account connection.

environmentAccountConnection_environmentName :: Lens' EnvironmentAccountConnection Text Source #

The name of the environment that's associated with the environment account connection.

environmentAccountConnection_id :: Lens' EnvironmentAccountConnection Text Source #

The ID of the environment account connection.

environmentAccountConnection_lastModifiedAt :: Lens' EnvironmentAccountConnection UTCTime Source #

The time when the environment account connection was last modified.

environmentAccountConnection_managementAccountId :: Lens' EnvironmentAccountConnection Text Source #

The ID of the management account that's connected to the environment account connection.

environmentAccountConnection_requestedAt :: Lens' EnvironmentAccountConnection UTCTime Source #

The time when the environment account connection request was made.

environmentAccountConnection_roleArn :: Lens' EnvironmentAccountConnection Text Source #

The IAM service role that's associated with the environment account connection.

EnvironmentAccountConnectionSummary

environmentAccountConnectionSummary_componentRoleArn :: Lens' EnvironmentAccountConnectionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

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

environmentAccountConnectionSummary_arn :: Lens' EnvironmentAccountConnectionSummary Text Source #

The Amazon Resource Name (ARN) of the environment account connection.

environmentAccountConnectionSummary_environmentAccountId :: Lens' EnvironmentAccountConnectionSummary Text Source #

The ID of the environment account that's connected to the environment account connection.

environmentAccountConnectionSummary_environmentName :: Lens' EnvironmentAccountConnectionSummary Text Source #

The name of the environment that's associated with the environment account connection.

environmentAccountConnectionSummary_lastModifiedAt :: Lens' EnvironmentAccountConnectionSummary UTCTime Source #

The time when the environment account connection was last modified.

environmentAccountConnectionSummary_managementAccountId :: Lens' EnvironmentAccountConnectionSummary Text Source #

The ID of the management account that's connected to the environment account connection.

environmentAccountConnectionSummary_requestedAt :: Lens' EnvironmentAccountConnectionSummary UTCTime Source #

The time when the environment account connection request was made.

environmentAccountConnectionSummary_roleArn :: Lens' EnvironmentAccountConnectionSummary Text Source #

The IAM service role that's associated with the environment account connection.

EnvironmentSummary

environmentSummary_componentRoleArn :: Lens' EnvironmentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

environmentSummary_description :: Lens' EnvironmentSummary (Maybe Text) Source #

The description of the environment.

environmentSummary_environmentAccountConnectionId :: Lens' EnvironmentSummary (Maybe Text) Source #

The ID of the environment account connection that the environment is associated with.

environmentSummary_environmentAccountId :: Lens' EnvironmentSummary (Maybe Text) Source #

The ID of the environment account that the environment infrastructure resources are provisioned in.

environmentSummary_protonServiceRoleArn :: Lens' EnvironmentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

environmentSummary_provisioning :: Lens' EnvironmentSummary (Maybe Provisioning) Source #

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

environmentSummary_arn :: Lens' EnvironmentSummary Text Source #

The Amazon Resource Name (ARN) of the environment.

environmentSummary_createdAt :: Lens' EnvironmentSummary UTCTime Source #

The time when the environment was created.

environmentSummary_lastDeploymentAttemptedAt :: Lens' EnvironmentSummary UTCTime Source #

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

environmentSummary_lastDeploymentSucceededAt :: Lens' EnvironmentSummary UTCTime Source #

The time when the environment was last deployed successfully.

environmentSummary_templateMajorVersion :: Lens' EnvironmentSummary Text Source #

The major version of the environment template.

environmentSummary_templateMinorVersion :: Lens' EnvironmentSummary Text Source #

The minor version of the environment template.

environmentSummary_templateName :: Lens' EnvironmentSummary Text Source #

The name of the environment template.

EnvironmentTemplate

environmentTemplate_description :: Lens' EnvironmentTemplate (Maybe Text) Source #

A description of the environment template.

environmentTemplate_displayName :: Lens' EnvironmentTemplate (Maybe Text) Source #

The name of the environment template as displayed in the developer interface.

environmentTemplate_encryptionKey :: Lens' EnvironmentTemplate (Maybe Text) Source #

The customer provided encryption key for the environment template.

environmentTemplate_provisioning :: Lens' EnvironmentTemplate (Maybe Provisioning) Source #

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

environmentTemplate_recommendedVersion :: Lens' EnvironmentTemplate (Maybe Text) Source #

The ID of the recommended version of the environment template.

environmentTemplate_arn :: Lens' EnvironmentTemplate Text Source #

The Amazon Resource Name (ARN) of the environment template.

environmentTemplate_createdAt :: Lens' EnvironmentTemplate UTCTime Source #

The time when the environment template was created.

environmentTemplate_lastModifiedAt :: Lens' EnvironmentTemplate UTCTime Source #

The time when the environment template was last modified.

environmentTemplate_name :: Lens' EnvironmentTemplate Text Source #

The name of the environment template.

EnvironmentTemplateFilter

environmentTemplateFilter_majorVersion :: Lens' EnvironmentTemplateFilter Text Source #

Include majorVersion to filter search for a major version.

environmentTemplateFilter_templateName :: Lens' EnvironmentTemplateFilter Text Source #

Include templateName to filter search for a template name.

EnvironmentTemplateSummary

environmentTemplateSummary_displayName :: Lens' EnvironmentTemplateSummary (Maybe Text) Source #

The name of the environment template as displayed in the developer interface.

environmentTemplateSummary_provisioning :: Lens' EnvironmentTemplateSummary (Maybe Provisioning) Source #

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

environmentTemplateSummary_recommendedVersion :: Lens' EnvironmentTemplateSummary (Maybe Text) Source #

The recommended version of the environment template.

environmentTemplateSummary_arn :: Lens' EnvironmentTemplateSummary Text Source #

The Amazon Resource Name (ARN) of the environment template.

environmentTemplateSummary_createdAt :: Lens' EnvironmentTemplateSummary UTCTime Source #

The time when the environment template was created.

environmentTemplateSummary_lastModifiedAt :: Lens' EnvironmentTemplateSummary UTCTime Source #

The time when the environment template was last modified.

EnvironmentTemplateVersion

environmentTemplateVersion_description :: Lens' EnvironmentTemplateVersion (Maybe Text) Source #

A description of the minor version of an environment template.

environmentTemplateVersion_recommendedMinorVersion :: Lens' EnvironmentTemplateVersion (Maybe Text) Source #

The recommended minor version of the environment template.

environmentTemplateVersion_schema :: Lens' EnvironmentTemplateVersion (Maybe Text) Source #

The schema of the version of an environment template.

environmentTemplateVersion_statusMessage :: Lens' EnvironmentTemplateVersion (Maybe Text) Source #

The status message of the version of an environment template.

environmentTemplateVersion_arn :: Lens' EnvironmentTemplateVersion Text Source #

The Amazon Resource Name (ARN) of the version of an environment template.

environmentTemplateVersion_createdAt :: Lens' EnvironmentTemplateVersion UTCTime Source #

The time when the version of an environment template was created.

environmentTemplateVersion_lastModifiedAt :: Lens' EnvironmentTemplateVersion UTCTime Source #

The time when the version of an environment template was last modified.

environmentTemplateVersion_majorVersion :: Lens' EnvironmentTemplateVersion Text Source #

The latest major version that's associated with the version of an environment template.

environmentTemplateVersion_templateName :: Lens' EnvironmentTemplateVersion Text Source #

The name of the version of an environment template.

EnvironmentTemplateVersionSummary

environmentTemplateVersionSummary_description :: Lens' EnvironmentTemplateVersionSummary (Maybe Text) Source #

A description of the version of an environment template.

environmentTemplateVersionSummary_statusMessage :: Lens' EnvironmentTemplateVersionSummary (Maybe Text) Source #

The status message of the version of an environment template.

environmentTemplateVersionSummary_arn :: Lens' EnvironmentTemplateVersionSummary Text Source #

The Amazon Resource Name (ARN) of the version of an environment template.

environmentTemplateVersionSummary_createdAt :: Lens' EnvironmentTemplateVersionSummary UTCTime Source #

The time when the version of an environment template was created.

environmentTemplateVersionSummary_lastModifiedAt :: Lens' EnvironmentTemplateVersionSummary UTCTime Source #

The time when the version of an environment template was last modified.

environmentTemplateVersionSummary_majorVersion :: Lens' EnvironmentTemplateVersionSummary Text Source #

The latest major version that's associated with the version of an environment template.

ListServiceInstancesFilter

listServiceInstancesFilter_value :: Lens' ListServiceInstancesFilter (Maybe Text) Source #

A value to filter by.

With the date/time keys (*At{Before,After}), the value is a valid RFC 3339 string with no UTC offset and with an optional fractional precision (for example, 1985-04-12T23:20:50.52Z).

Output

output_key :: Lens' Output (Maybe Text) Source #

The output key.

ProvisionedResource

provisionedResource_identifier :: Lens' ProvisionedResource (Maybe Text) Source #

The provisioned resource identifier.

provisionedResource_provisioningEngine :: Lens' ProvisionedResource (Maybe ProvisionedResourceEngine) Source #

The resource provisioning engine. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.

For more information, see Self-managed provisioning in the Proton User Guide.

Repository

repository_encryptionKey :: Lens' Repository (Maybe Text) Source #

Your customer Amazon Web Services KMS encryption key.

repository_arn :: Lens' Repository Text Source #

The Amazon Resource Name (ARN) of the linked repository.

repository_connectionArn :: Lens' Repository Text Source #

The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.

repository_name :: Lens' Repository Text Source #

The repository name.

RepositoryBranch

repositoryBranch_arn :: Lens' RepositoryBranch Text Source #

The Amazon Resource Name (ARN) of the linked repository.

RepositoryBranchInput

RepositorySummary

repositorySummary_arn :: Lens' RepositorySummary Text Source #

The Amazon Resource Name (ARN) of the linked repository.

RepositorySyncAttempt

RepositorySyncDefinition

RepositorySyncEvent

repositorySyncEvent_event :: Lens' RepositorySyncEvent Text Source #

Event detail for a repository sync attempt.

repositorySyncEvent_time :: Lens' RepositorySyncEvent UTCTime Source #

The time that the sync event occurred.

ResourceSyncAttempt

resourceSyncAttempt_initialRevision :: Lens' ResourceSyncAttempt Revision Source #

Detail data for the initial repository commit, path and push.

resourceSyncAttempt_startedAt :: Lens' ResourceSyncAttempt UTCTime Source #

The time when the sync attempt started.

ResourceSyncEvent

resourceSyncEvent_time :: Lens' ResourceSyncEvent UTCTime Source #

The time when the event occurred.

Revision

revision_branch :: Lens' Revision Text Source #

The repository branch.

revision_directory :: Lens' Revision Text Source #

The repository directory changed by a commit and push that activated the sync attempt.

revision_sha :: Lens' Revision Text Source #

The secure hash algorithm (SHA) hash for the revision.

S3ObjectSource

s3ObjectSource_bucket :: Lens' S3ObjectSource Text Source #

The name of the S3 bucket that contains a template bundle.

s3ObjectSource_key :: Lens' S3ObjectSource Text Source #

The path to the S3 bucket that contains a template bundle.

Service

service_branchName :: Lens' Service (Maybe Text) Source #

The name of the code repository branch that holds the code that's deployed in Proton.

service_description :: Lens' Service (Maybe Text) Source #

A description of the service.

service_pipeline :: Lens' Service (Maybe ServicePipeline) Source #

The service pipeline detail data.

service_repositoryConnectionArn :: Lens' Service (Maybe Text) Source #

The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

service_repositoryId :: Lens' Service (Maybe Text) Source #

The ID of the source code repository.

service_statusMessage :: Lens' Service (Maybe Text) Source #

A service status message.

service_arn :: Lens' Service Text Source #

The Amazon Resource Name (ARN) of the service.

service_createdAt :: Lens' Service UTCTime Source #

The time when the service was created.

service_lastModifiedAt :: Lens' Service UTCTime Source #

The time when the service was last modified.

service_name :: Lens' Service Text Source #

The name of the service.

service_spec :: Lens' Service Text Source #

The formatted specification that defines the service.

service_status :: Lens' Service ServiceStatus Source #

The status of the service.

service_templateName :: Lens' Service Text Source #

The name of the service template.

ServiceInstance

serviceInstance_deploymentStatusMessage :: Lens' ServiceInstance (Maybe Text) Source #

The message associated with the service instance deployment status.

serviceInstance_spec :: Lens' ServiceInstance (Maybe Text) Source #

The service spec that was used to create the service instance.

serviceInstance_arn :: Lens' ServiceInstance Text Source #

The Amazon Resource Name (ARN) of the service instance.

serviceInstance_createdAt :: Lens' ServiceInstance UTCTime Source #

The time when the service instance was created.

serviceInstance_environmentName :: Lens' ServiceInstance Text Source #

The name of the environment that the service instance was deployed into.

serviceInstance_lastDeploymentAttemptedAt :: Lens' ServiceInstance UTCTime Source #

The time when a deployment of the service instance was last attempted.

serviceInstance_lastDeploymentSucceededAt :: Lens' ServiceInstance UTCTime Source #

The time when the service instance was last deployed successfully.

serviceInstance_name :: Lens' ServiceInstance Text Source #

The name of the service instance.

serviceInstance_serviceName :: Lens' ServiceInstance Text Source #

The name of the service that the service instance belongs to.

serviceInstance_templateMajorVersion :: Lens' ServiceInstance Text Source #

The major version of the service template that was used to create the service instance.

serviceInstance_templateMinorVersion :: Lens' ServiceInstance Text Source #

The minor version of the service template that was used to create the service instance.

serviceInstance_templateName :: Lens' ServiceInstance Text Source #

The name of the service template that was used to create the service instance.

ServiceInstanceSummary

serviceInstanceSummary_arn :: Lens' ServiceInstanceSummary Text Source #

The Amazon Resource Name (ARN) of the service instance.

serviceInstanceSummary_createdAt :: Lens' ServiceInstanceSummary UTCTime Source #

The time when the service instance was created.

serviceInstanceSummary_environmentName :: Lens' ServiceInstanceSummary Text Source #

The name of the environment that the service instance was deployed into.

serviceInstanceSummary_lastDeploymentAttemptedAt :: Lens' ServiceInstanceSummary UTCTime Source #

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

serviceInstanceSummary_lastDeploymentSucceededAt :: Lens' ServiceInstanceSummary UTCTime Source #

The time when the service was last deployed successfully.

serviceInstanceSummary_serviceName :: Lens' ServiceInstanceSummary Text Source #

The name of the service that the service instance belongs to.

ServicePipeline

servicePipeline_deploymentStatusMessage :: Lens' ServicePipeline (Maybe Text) Source #

A service pipeline deployment status message.

servicePipeline_spec :: Lens' ServicePipeline (Maybe Text) Source #

The service spec that was used to create the service pipeline.

servicePipeline_arn :: Lens' ServicePipeline Text Source #

The Amazon Resource Name (ARN) of the service pipeline.

servicePipeline_createdAt :: Lens' ServicePipeline UTCTime Source #

The time when the service pipeline was created.

servicePipeline_deploymentStatus :: Lens' ServicePipeline DeploymentStatus Source #

The deployment status of the service pipeline.

servicePipeline_lastDeploymentAttemptedAt :: Lens' ServicePipeline UTCTime Source #

The time when a deployment of the service pipeline was last attempted.

servicePipeline_lastDeploymentSucceededAt :: Lens' ServicePipeline UTCTime Source #

The time when the service pipeline was last deployed successfully.

servicePipeline_templateMajorVersion :: Lens' ServicePipeline Text Source #

The major version of the service template that was used to create the service pipeline.

servicePipeline_templateMinorVersion :: Lens' ServicePipeline Text Source #

The minor version of the service template that was used to create the service pipeline.

servicePipeline_templateName :: Lens' ServicePipeline Text Source #

The name of the service template that was used to create the service pipeline.

ServiceSummary

serviceSummary_arn :: Lens' ServiceSummary Text Source #

The Amazon Resource Name (ARN) of the service.

serviceSummary_createdAt :: Lens' ServiceSummary UTCTime Source #

The time when the service was created.

serviceSummary_lastModifiedAt :: Lens' ServiceSummary UTCTime Source #

The time when the service was last modified.

serviceSummary_templateName :: Lens' ServiceSummary Text Source #

The name of the service template.

ServiceTemplate

serviceTemplate_description :: Lens' ServiceTemplate (Maybe Text) Source #

A description of the service template.

serviceTemplate_displayName :: Lens' ServiceTemplate (Maybe Text) Source #

The service template name as displayed in the developer interface.

serviceTemplate_encryptionKey :: Lens' ServiceTemplate (Maybe Text) Source #

The customer provided service template encryption key that's used to encrypt data.

serviceTemplate_pipelineProvisioning :: Lens' ServiceTemplate (Maybe Provisioning) Source #

If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.

serviceTemplate_recommendedVersion :: Lens' ServiceTemplate (Maybe Text) Source #

The recommended version of the service template.

serviceTemplate_arn :: Lens' ServiceTemplate Text Source #

The Amazon Resource Name (ARN) of the service template.

serviceTemplate_createdAt :: Lens' ServiceTemplate UTCTime Source #

The time when the service template was created.

serviceTemplate_lastModifiedAt :: Lens' ServiceTemplate UTCTime Source #

The time when the service template was last modified.

serviceTemplate_name :: Lens' ServiceTemplate Text Source #

The name of the service template.

ServiceTemplateSummary

serviceTemplateSummary_displayName :: Lens' ServiceTemplateSummary (Maybe Text) Source #

The service template name as displayed in the developer interface.

serviceTemplateSummary_pipelineProvisioning :: Lens' ServiceTemplateSummary (Maybe Provisioning) Source #

If pipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.

serviceTemplateSummary_recommendedVersion :: Lens' ServiceTemplateSummary (Maybe Text) Source #

The recommended version of the service template.

serviceTemplateSummary_arn :: Lens' ServiceTemplateSummary Text Source #

The Amazon Resource Name (ARN) of the service template.

serviceTemplateSummary_createdAt :: Lens' ServiceTemplateSummary UTCTime Source #

The time when the service template was created.

serviceTemplateSummary_lastModifiedAt :: Lens' ServiceTemplateSummary UTCTime Source #

The time when the service template was last modified.

ServiceTemplateVersion

serviceTemplateVersion_description :: Lens' ServiceTemplateVersion (Maybe Text) Source #

A description of the version of a service template.

serviceTemplateVersion_recommendedMinorVersion :: Lens' ServiceTemplateVersion (Maybe Text) Source #

The recommended minor version of the service template.

serviceTemplateVersion_schema :: Lens' ServiceTemplateVersion (Maybe Text) Source #

The schema of the version of a service template.

serviceTemplateVersion_statusMessage :: Lens' ServiceTemplateVersion (Maybe Text) Source #

A service template version status message.

serviceTemplateVersion_supportedComponentSources :: Lens' ServiceTemplateVersion (Maybe [ServiceTemplateSupportedComponentSourceType]) Source #

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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

serviceTemplateVersion_arn :: Lens' ServiceTemplateVersion Text Source #

The Amazon Resource Name (ARN) of the version of a service template.

serviceTemplateVersion_compatibleEnvironmentTemplates :: Lens' ServiceTemplateVersion [CompatibleEnvironmentTemplate] Source #

An array of compatible environment template names for the major version of a service template.

serviceTemplateVersion_createdAt :: Lens' ServiceTemplateVersion UTCTime Source #

The time when the version of a service template was created.

serviceTemplateVersion_lastModifiedAt :: Lens' ServiceTemplateVersion UTCTime Source #

The time when the version of a service template was last modified.

serviceTemplateVersion_majorVersion :: Lens' ServiceTemplateVersion Text Source #

The latest major version that's associated with the version of a service template.

serviceTemplateVersion_templateName :: Lens' ServiceTemplateVersion Text Source #

The name of the version of a service template.

ServiceTemplateVersionSummary

serviceTemplateVersionSummary_description :: Lens' ServiceTemplateVersionSummary (Maybe Text) Source #

A description of the version of a service template.

serviceTemplateVersionSummary_arn :: Lens' ServiceTemplateVersionSummary Text Source #

The Amazon Resource Name (ARN) of the version of a service template.

serviceTemplateVersionSummary_createdAt :: Lens' ServiceTemplateVersionSummary UTCTime Source #

The time when the version of a service template was created.

serviceTemplateVersionSummary_lastModifiedAt :: Lens' ServiceTemplateVersionSummary UTCTime Source #

The time when the version of a service template was last modified.

serviceTemplateVersionSummary_majorVersion :: Lens' ServiceTemplateVersionSummary Text Source #

The latest major version that's associated with the version of a service template.

Tag

tag_key :: Lens' Tag Text Source #

The key of the resource tag.

tag_value :: Lens' Tag Text Source #

The value of the resource tag.

TemplateSyncConfig

templateSyncConfig_subdirectory :: Lens' TemplateSyncConfig (Maybe Text) Source #

A subdirectory path to your template bundle version.

templateSyncConfig_repositoryName :: Lens' TemplateSyncConfig Text Source #

The repository name (for example, myrepos/myrepo).

TemplateVersionSourceInput

templateVersionSourceInput_s3 :: Lens' TemplateVersionSourceInput (Maybe S3ObjectSource) Source #

An S3 source object that includes the template bundle S3 path and name for a template minor version.