String id
The ID of the environment account connection.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection data that's returned by Proton.
String pipelineCodebuildRoleArn
The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.
RepositoryBranch pipelineProvisioningRepository
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.
String pipelineServiceRoleArn
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.
String componentName
The name of the component with the deployment to cancel.
Component component
The detailed data of the component with the deployment that is being canceled.
String environmentName
The name of the environment with the deployment to cancel.
Environment environment
The environment summary data that's returned by Proton.
ServiceInstance serviceInstance
The service instance summary data that's returned by Proton.
String serviceName
The name of the service with the service pipeline deployment to cancel.
ServicePipeline pipeline
The service pipeline detail data that's returned by Proton.
String arn
The Amazon Resource Name (ARN) of the component.
Date createdAt
The time when the component was created.
String deploymentStatus
The component deployment status.
String deploymentStatusMessage
The message associated with the component deployment status.
String description
A description of the component.
String environmentName
The name of the Proton environment that this component is associated with.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this component.
String lastClientRequestToken
The last token the client requested.
Date lastDeploymentAttemptedAt
The time when a deployment of the component was last attempted.
Date lastDeploymentSucceededAt
The time when the component was last deployed successfully.
Date lastModifiedAt
The time when the component was last modified.
String lastSucceededDeploymentId
The ID of the last successful deployment of this component.
String name
The name of the component.
String serviceInstanceName
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
String serviceName
The name of the service that serviceInstanceName is associated with. Provided when a component is
attached to a service instance.
String serviceSpec
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
String serviceInstanceName
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
String serviceName
The name of the service that serviceInstanceName is associated with. Provided when a component is
attached to a service instance.
String serviceSpec
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
String templateFile
The template file used.
String arn
The Amazon Resource Name (ARN) of the component.
Date createdAt
The time when the component was created.
String deploymentStatus
The component deployment status.
String deploymentStatusMessage
The message associated with the component deployment status.
String environmentName
The name of the Proton environment that this component is associated with.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this component.
Date lastDeploymentAttemptedAt
The time when a deployment of the component was last attempted.
Date lastDeploymentSucceededAt
The time when the component was last deployed successfully.
Date lastModifiedAt
The time when the component was last modified.
String lastSucceededDeploymentId
The ID of the last successful deployment of this component.
String name
The name of the component.
String serviceInstanceName
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
String serviceName
The name of the service that serviceInstanceName is associated with. Provided when a component is
attached to a service instance.
ResourceCountsSummary components
The total number of components in the Amazon Web Services account.
The semantics of the components field are different from the semantics of results for other
infrastructure-provisioning resources. That's because at this time components don't have associated templates,
therefore they don't have the concept of staleness. The components object will only contain
total and failed members.
ResourceCountsSummary environmentTemplates
The total number of environment templates in the Amazon Web Services account. The
environmentTemplates object will only contain total members.
ResourceCountsSummary environments
The staleness counts for Proton environments in the Amazon Web Services account. The environments
object will only contain total members.
ResourceCountsSummary pipelines
The staleness counts for Proton pipelines in the Amazon Web Services account.
ResourceCountsSummary serviceInstances
The staleness counts for Proton service instances in the Amazon Web Services account.
ResourceCountsSummary serviceTemplates
The total number of service templates in the Amazon Web Services account. The serviceTemplates
object will only contain total members.
ResourceCountsSummary services
The staleness counts for Proton services in the Amazon Web Services account.
String clientToken
The client token for the created component.
String description
An optional customer-provided description of the component.
String environmentName
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.
String manifest
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
String name
The customer-provided name of the component.
String serviceInstanceName
The name of the service instance that you want to attach this component to. If you don't specify this, the
component isn't attached to any service instance. Specify both serviceInstanceName and
serviceName or neither of them.
String serviceName
The name of the service that serviceInstanceName is associated with. If you don't specify this, the
component isn't attached to any service instance. Specify both serviceInstanceName and
serviceName or neither of them.
String serviceSpec
The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
List<E> tags
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.
String templateFile
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.
Component component
The detailed data of the created component.
String clientToken
When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
String codebuildRoleArn
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.
String componentRoleArn
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.
String environmentName
The name of the Proton environment that's created in the associated management account.
String managementAccountId
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.
String roleArn
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.
List<E> tags
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.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection detail data that's returned by Proton.
String codebuildRoleArn
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.
String componentRoleArn
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.
String description
A description of the environment that's being created and deployed.
String environmentAccountConnectionId
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.
String name
The name of the environment.
String protonServiceRoleArn
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.
RepositoryBranchInput provisioningRepository
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.
String spec
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.
List<E> tags
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.
String templateMajorVersion
The major version of the environment template.
String templateMinorVersion
The minor version of the environment template.
String templateName
The name of the environment template. For more information, see Environment Templates in the Proton User Guide.
Environment environment
The environment detail data that's returned by Proton.
String description
A description of the environment template.
String displayName
The environment template name as displayed in the developer interface.
String encryptionKey
A customer provided encryption key that Proton uses to encrypt data.
String name
The name of the environment template.
String provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
List<E> tags
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.
EnvironmentTemplate environmentTemplate
The environment template detail data that's returned by Proton.
String clientToken
When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.
String description
A description of the new version of an environment template.
String majorVersion
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.
TemplateVersionSourceInput source
An object that includes the template bundle S3 bucket path and name for the new version of an template.
List<E> tags
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.
String templateName
The name of the environment template.
EnvironmentTemplateVersion environmentTemplateVersion
The environment template detail data that's returned by Proton.
String connectionArn
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.
String encryptionKey
The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
String name
The repository name (for example, myrepos/myrepo).
String provider
The repository provider.
List<E> tags
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.
Repository repository
The repository link's detail data that's returned by Proton.
String clientToken
The client token of the service instance to create.
String name
The name of the service instance to create.
String serviceName
The name of the service the service instance is added to.
String spec
The spec for the service instance you want to create.
List<E> tags
An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
String templateMajorVersion
To create a new major and minor version of the service template, exclude major Version.
String templateMinorVersion
To create a new minor version of the service template, include a major Version.
ServiceInstance serviceInstance
The detailed data of the service instance being created.
String branchName
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.
String description
A description of the Proton service.
String name
The service name.
String repositoryConnectionArn
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.
String repositoryId
The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
String spec
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.
List<E> tags
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.
String templateMajorVersion
The major version of the service template that was used to create the service.
String templateMinorVersion
The minor version of the service template that was used to create the service.
String templateName
The name of the service template that's used to create the service.
Service service
The service detail data that's returned by Proton.
String branch
The repository branch for your Proton Ops file.
String filePath
The path to the Proton Ops file.
String repositoryName
The repository name.
String repositoryProvider
The provider type for your repository.
String serviceName
The name of the service the Proton Ops file is for.
ServiceSyncConfig serviceSyncConfig
The detailed data of the Proton Ops file.
String description
A description of the service template.
String displayName
The name of the service template as displayed in the developer interface.
String encryptionKey
A customer provided encryption key that's used to encrypt data.
String name
The name of the service template.
String pipelineProvisioning
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.
List<E> tags
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.
ServiceTemplate serviceTemplate
The service template detail data that's returned by Proton.
String clientToken
When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.
List<E> compatibleEnvironmentTemplates
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.
String description
A description of the new version of a service template.
String majorVersion
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.
TemplateVersionSourceInput source
An object that includes the template bundle S3 bucket path and name for the new version of a service template.
List<E> supportedComponentSources
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.
List<E> tags
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.
String templateName
The name of the service template.
ServiceTemplateVersion serviceTemplateVersion
The service template version summary of detail data that's returned by Proton.
String branch
The repository branch for your template.
String repositoryName
The repository name (for example, myrepos/myrepo).
String repositoryProvider
The provider type for your repository.
String subdirectory
A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.
String templateName
The name of your registered template.
String templateType
The type of the registered template.
TemplateSyncConfig templateSyncConfig
The template sync configuration detail data that's returned by Proton.
String name
The name of the component to delete.
Component component
The detailed data of the component being deleted.
String id
The ID of the deployment to delete.
Deployment deployment
The detailed data of the deployment being deleted.
String id
The ID of the environment account connection to delete.
EnvironmentAccountConnection environmentAccountConnection
The detailed data of the environment account connection being deleted.
String name
The name of the environment to delete.
Environment environment
The detailed data of the environment being deleted.
String name
The name of the environment template to delete.
EnvironmentTemplate environmentTemplate
The detailed data of the environment template being deleted.
EnvironmentTemplateVersion environmentTemplateVersion
The detailed data of the environment template version being deleted.
Repository repository
The deleted repository link's detail data that's returned by Proton.
String name
The name of the service to delete.
Service service
The detailed data of the service being deleted.
String serviceName
The name of the service that you want to delete the service sync configuration for.
ServiceSyncConfig serviceSyncConfig
The detailed data for the service sync config.
String name
The name of the service template to delete.
ServiceTemplate serviceTemplate
The detailed data of the service template being deleted.
ServiceTemplateVersion serviceTemplateVersion
The detailed data of the service template version being deleted.
TemplateSyncConfig templateSyncConfig
The template sync configuration detail data that's returned by Proton.
String arn
The Amazon Resource Name (ARN) of the deployment.
Date completedAt
The date and time the deployment was completed.
String componentName
The name of the component associated with this deployment.
Date createdAt
The date and time the deployment was created.
String deploymentStatus
The status of the deployment.
String deploymentStatusMessage
The deployment status message.
String environmentName
The name of the environment associated with this deployment.
String id
The ID of the deployment.
DeploymentState initialState
The initial state of the target resource at the time of the deployment.
String lastAttemptedDeploymentId
The ID of the last attempted deployment.
Date lastModifiedAt
The date and time the deployment was last modified.
String lastSucceededDeploymentId
The ID of the last successful deployment.
String serviceInstanceName
The name of the deployment's service instance.
String serviceName
The name of the service in this deployment.
String targetArn
The Amazon Resource Name (ARN) of the target of the deployment.
Date targetResourceCreatedAt
The date and time the depoyment target was created.
String targetResourceType
The resource type of the deployment target. It can be an environment, service, service instance, or component.
DeploymentState targetState
The target state of the target resource at the time of the deployment.
ComponentState component
The state of the component associated with the deployment.
EnvironmentState environment
The state of the environment associated with the deployment.
ServiceInstanceState serviceInstance
The state of the service instance associated with the deployment.
ServicePipelineState servicePipeline
The state of the service pipeline associated with the deployment.
String arn
The Amazon Resource Name (ARN) of the deployment.
Date completedAt
The date and time the deployment was completed.
String componentName
The name of the component associated with the deployment.
Date createdAt
The date and time the deployment was created.
String deploymentStatus
The current status of the deployment.
String environmentName
The name of the environment associated with the deployment.
String id
The ID of the deployment.
String lastAttemptedDeploymentId
The ID of the last attempted deployment.
Date lastModifiedAt
The date and time the deployment was last modified.
String lastSucceededDeploymentId
The ID of the last successful deployment.
String serviceInstanceName
The name of the service instance associated with the deployment.
String serviceName
The name of the service associated with the deployment.
String targetArn
The Amazon Resource Name (ARN) of the target of the deployment.
Date targetResourceCreatedAt
The date and time the target resource was created.
String targetResourceType
The resource type of the deployment target. It can be an environment, service, service instance, or component.
String arn
The Amazon Resource Name (ARN) of the environment.
String codebuildRoleArn
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
String componentRoleArn
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.
Date createdAt
The time when the environment was created.
String deploymentStatus
The environment deployment status.
String deploymentStatusMessage
An environment deployment status message.
String description
The description of the environment.
String environmentAccountConnectionId
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
String environmentAccountId
The ID of the environment account that the environment infrastructure resources are provisioned in.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this environment.
Date lastDeploymentAttemptedAt
The time when a deployment of the environment was last attempted.
Date lastDeploymentSucceededAt
The time when the environment was last deployed successfully.
String lastSucceededDeploymentId
The ID of the last successful deployment of this environment.
String name
The name of the environment.
String protonServiceRoleArn
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
String provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
RepositoryBranch provisioningRepository
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.
String spec
The environment spec.
String templateMajorVersion
The major version of the environment template.
String templateMinorVersion
The minor version of the environment template.
String templateName
The Amazon Resource Name (ARN) of the environment template.
String arn
The Amazon Resource Name (ARN) of the environment account connection.
String codebuildRoleArn
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.
String componentRoleArn
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.
String environmentAccountId
The environment account that's connected to the environment account connection.
String environmentName
The name of the environment that's associated with the environment account connection.
String id
The ID of the environment account connection.
Date lastModifiedAt
The time when the environment account connection was last modified.
String managementAccountId
The ID of the management account that's connected to the environment account connection.
Date requestedAt
The time when the environment account connection request was made.
String roleArn
The IAM service role that's associated with the environment account connection.
String status
The status of the environment account connection.
String arn
The Amazon Resource Name (ARN) of the environment account connection.
String componentRoleArn
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.
String environmentAccountId
The ID of the environment account that's connected to the environment account connection.
String environmentName
The name of the environment that's associated with the environment account connection.
String id
The ID of the environment account connection.
Date lastModifiedAt
The time when the environment account connection was last modified.
String managementAccountId
The ID of the management account that's connected to the environment account connection.
Date requestedAt
The time when the environment account connection request was made.
String roleArn
The IAM service role that's associated with the environment account connection.
String status
The status of the environment account connection.
String spec
The environment spec that was used to create the environment.
String templateMajorVersion
The major version of the environment template that was used to create the environment.
String templateMinorVersion
The minor version of the environment template that was used to create the environment.
String templateName
The name of the environment template that was used to create the environment.
String arn
The Amazon Resource Name (ARN) of the environment.
String componentRoleArn
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.
Date createdAt
The time when the environment was created.
String deploymentStatus
The environment deployment status.
String deploymentStatusMessage
An environment deployment status message.
String description
The description of the environment.
String environmentAccountConnectionId
The ID of the environment account connection that the environment is associated with.
String environmentAccountId
The ID of the environment account that the environment infrastructure resources are provisioned in.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this environment.
Date lastDeploymentAttemptedAt
The time when a deployment of the environment was last attempted.
Date lastDeploymentSucceededAt
The time when the environment was last deployed successfully.
String lastSucceededDeploymentId
The ID of the last successful deployment of this environment.
String name
The name of the environment.
String protonServiceRoleArn
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
String provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
String templateMajorVersion
The major version of the environment template.
String templateMinorVersion
The minor version of the environment template.
String templateName
The name of the environment template.
String arn
The Amazon Resource Name (ARN) of the environment template.
Date createdAt
The time when the environment template was created.
String description
A description of the environment template.
String displayName
The name of the environment template as displayed in the developer interface.
String encryptionKey
The customer provided encryption key for the environment template.
Date lastModifiedAt
The time when the environment template was last modified.
String name
The name of the environment template.
String provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
String recommendedVersion
The ID of the recommended version of the environment template.
String arn
The Amazon Resource Name (ARN) of the environment template.
Date createdAt
The time when the environment template was created.
String description
A description of the environment template.
String displayName
The name of the environment template as displayed in the developer interface.
Date lastModifiedAt
The time when the environment template was last modified.
String name
The name of the environment template.
String provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
String recommendedVersion
The recommended version of the environment template.
String arn
The Amazon Resource Name (ARN) of the version of an environment template.
Date createdAt
The time when the version of an environment template was created.
String description
A description of the minor version of an environment template.
Date lastModifiedAt
The time when the version of an environment template was last modified.
String majorVersion
The latest major version that's associated with the version of an environment template.
String minorVersion
The minor version of an environment template.
String recommendedMinorVersion
The recommended minor version of the environment template.
String schema
The schema of the version of an environment template.
String status
The status of the version of an environment template.
String statusMessage
The status message of the version of an environment template.
String templateName
The name of the version of an environment template.
String arn
The Amazon Resource Name (ARN) of the version of an environment template.
Date createdAt
The time when the version of an environment template was created.
String description
A description of the version of an environment template.
Date lastModifiedAt
The time when the version of an environment template was last modified.
String majorVersion
The latest major version that's associated with the version of an environment template.
String minorVersion
The version of an environment template.
String recommendedMinorVersion
The recommended minor version of the environment template.
String status
The status of the version of an environment template.
String statusMessage
The status message of the version of an environment template.
String templateName
The name of the environment template.
AccountSettings accountSettings
The Proton pipeline service role detail data that's returned by Proton.
String name
The name of the component that you want to get the detailed data for.
Component component
The detailed data of the requested component.
String componentName
The name of a component that you want to get the detailed data for.
String environmentName
The name of a environment that you want to get the detailed data for.
String id
The ID of the deployment that you want to get the detailed data for.
String serviceInstanceName
The name of the service instance associated with the given deployment ID. serviceName must be
specified to identify the service instance.
String serviceName
The name of the service associated with the given deployment ID.
Deployment deployment
The detailed data of the requested deployment.
String id
The ID of the environment account connection that you want to get the detailed data for.
EnvironmentAccountConnection environmentAccountConnection
The detailed data of the requested environment account connection.
String name
The name of the environment that you want to get the detailed data for.
Environment environment
The detailed data of the requested environment.
String name
The name of the environment template that you want to get the detailed data for.
EnvironmentTemplate environmentTemplate
The detailed data of the requested environment template.
String majorVersion
To get environment template major version detail data, include major Version.
String minorVersion
To get environment template minor version detail data, include minorVersion.
String templateName
The name of the environment template a version of which you want to get detailed data for.
EnvironmentTemplateVersion environmentTemplateVersion
The detailed data of the requested environment template version.
Repository repository
The repository link's detail data that's returned by Proton.
RepositorySyncAttempt latestSync
The repository sync status detail data that's returned by Proton.
CountsSummary counts
Summary counts of each Proton resource type.
ServiceInstance serviceInstance
The detailed data of the requested service instance.
Revision desiredState
The service instance sync desired state that's returned by Proton
ResourceSyncAttempt latestSuccessfulSync
The detailed data of the latest successful sync with the service instance.
ResourceSyncAttempt latestSync
The detailed data of the latest sync with the service instance.
String name
The name of the service that you want to get the detailed data for.
Service service
The detailed data of the requested service.
String serviceInstanceName
The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.
String serviceName
The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.
ServiceSyncBlockerSummary serviceSyncBlockerSummary
The detailed data of the requested service sync blocker summary.
String serviceName
The name of the service that you want to get the service sync configuration for.
ServiceSyncConfig serviceSyncConfig
The detailed data of the requested service sync configuration.
String name
The name of the service template that you want to get detailed data for.
ServiceTemplate serviceTemplate
The detailed data of the requested service template.
String majorVersion
To get service template major version detail data, include major Version.
String minorVersion
To get service template minor version detail data, include minorVersion.
String templateName
The name of the service template a version of which you want to get detailed data for.
ServiceTemplateVersion serviceTemplateVersion
The detailed data of the requested service template version.
TemplateSyncConfig templateSyncConfig
The template sync configuration detail data that's returned by Proton.
Revision desiredState
The template sync desired state that's returned by Proton.
ResourceSyncAttempt latestSuccessfulSync
The details of the last successful sync that's returned by Proton.
ResourceSyncAttempt latestSync
The details of the last sync that's returned by Proton.
String componentName
The name of the component whose outputs you want.
String deploymentId
The ID of the deployment whose outputs you want.
String nextToken
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
String componentName
The name of the component whose provisioned resources you want.
String nextToken
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.
String environmentName
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
Integer maxResults
The maximum number of components to list.
String nextToken
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
String serviceInstanceName
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
String serviceName
The name of a service for result list filtering. Proton returns components attached to service instances of the service.
String componentName
The name of a component for result list filtering. Proton returns deployments associated with that component.
String environmentName
The name of an environment for result list filtering. Proton returns deployments associated with the environment.
Integer maxResults
The maximum number of deployments to list.
String nextToken
A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.
String serviceInstanceName
The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.
String serviceName
The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.
String environmentName
The environment name that's associated with each listed environment account connection.
Integer maxResults
The maximum number of environment account connections to list.
String nextToken
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.
String requestedBy
The type of account making the ListEnvironmentAccountConnections request.
List<E> statuses
The status details for each listed environment account connection.
List<E> environmentAccountConnections
An array of environment account connections with details that's returned by Proton.
String nextToken
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.
String deploymentId
The ID of the deployment whose outputs you want.
String environmentName
The environment name.
String nextToken
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.
String environmentName
The environment name.
String nextToken
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.
String nextToken
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.
List<E> provisionedResources
An array of environment provisioned resources.
List<E> environmentTemplates
An array of the versions of the environment template.
Integer maxResults
The maximum number of environments to list.
String nextToken
A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.
String majorVersion
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.
Integer maxResults
The maximum number of major or minor versions of an environment template to list.
String nextToken
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.
String templateName
The name of the environment template.
String nextToken
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.
List<E> templateVersions
An array of major or minor versions of an environment template detail data.
String nextToken
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.
String repositoryName
The repository name.
String repositoryProvider
The repository provider.
String syncType
The sync type. The only supported value is TEMPLATE_SYNC.
String deploymentId
The ID of the deployment whose outputs you want.
String nextToken
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
String serviceInstanceName
The name of the service instance whose outputs you want.
String serviceName
The name of the service that serviceInstanceName is associated to.
String nextToken
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.
String serviceInstanceName
The name of the service instance whose provisioned resources you want.
String serviceName
The name of the service that serviceInstanceName is associated to.
String nextToken
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.
List<E> provisionedResources
An array of provisioned resources for a service instance.
List<E> filters
An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
Integer maxResults
The maximum number of service instances to list.
String nextToken
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.
String serviceName
The name of the service that the service instance belongs to.
String sortBy
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
String sortOrder
Result list sort order.
Default: ASCENDING
String deploymentId
The ID of the deployment you want the outputs for.
String nextToken
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
String serviceName
The name of the service whose pipeline's outputs you want.
String nextToken
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.
String serviceName
The name of the service whose pipeline's provisioned resources you want.
String nextToken
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.
List<E> provisionedResources
An array of provisioned resources for a service and pipeline.
String majorVersion
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.
Integer maxResults
The maximum number of major or minor versions of a service template to list.
String nextToken
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.
String templateName
The name of the service template.
String nextToken
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.
List<E> templateVersions
An array of major or minor versions of a service template with detail data.
Integer maxResults
The maximum number of tags to list.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) of the resource for the listed tags.
String deploymentId
The deployment ID for your provisioned resource.
List<E> outputs
The provisioned resource state change detail data that's returned by Proton.
String resourceArn
The provisioned resource Amazon Resource Name (ARN).
String status
The status of your provisioned resource.
String statusMessage
The deployment status message for your provisioned resource.
String identifier
The provisioned resource identifier.
String name
The provisioned resource name.
String provisioningEngine
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.
String id
The ID of the environment account connection to reject.
EnvironmentAccountConnection environmentAccountConnection
The environment connection account detail data that's returned by Proton.
String arn
The Amazon Resource Name (ARN) of the linked repository.
String connectionArn
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.
String encryptionKey
Your customer Amazon Web Services KMS encryption key.
String name
The repository name.
String provider
The repository provider.
Integer behindMajor
The number of resources of this type in the Amazon Web Services account that need a major template version update.
Integer behindMinor
The number of resources of this type in the Amazon Web Services account that need a minor template version update.
Integer failed
The number of resources of this type in the Amazon Web Services account that failed to deploy.
Integer total
The total number of resources of this type in the Amazon Web Services account.
Integer upToDate
The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.
List<E> events
An array of events with detail data.
Revision initialRevision
Detail data for the initial repository commit, path and push.
Date startedAt
The time when the sync attempt started.
String status
The status of the sync attempt.
String target
The resource that is synced to.
Revision targetRevision
Detail data for the target revision.
String branch
The repository branch.
String directory
The repository directory changed by a commit and push that activated the sync attempt.
String repositoryName
The repository name.
String repositoryProvider
The repository provider.
String sha
The secure hash algorithm (SHA) hash for the revision.
String arn
The Amazon Resource Name (ARN) of the service.
String branchName
The name of the code repository branch that holds the code that's deployed in Proton.
Date createdAt
The time when the service was created.
String description
A description of the service.
Date lastModifiedAt
The time when the service was last modified.
String name
The name of the service.
ServicePipeline pipeline
The service pipeline detail data.
String repositoryConnectionArn
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.
String repositoryId
The ID of the source code repository.
String spec
The formatted specification that defines the service.
String status
The status of the service.
String statusMessage
A service status message.
String templateName
The name of the service template.
String arn
The Amazon Resource Name (ARN) of the service instance.
Date createdAt
The time when the service instance was created.
String deploymentStatus
The service instance deployment status.
String deploymentStatusMessage
The message associated with the service instance deployment status.
String environmentName
The name of the environment that the service instance was deployed into.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this service instance.
String lastClientRequestToken
The last client request token received.
Date lastDeploymentAttemptedAt
The time when a deployment of the service instance was last attempted.
Date lastDeploymentSucceededAt
The time when the service instance was last deployed successfully.
String lastSucceededDeploymentId
The ID of the last successful deployment of this service instance.
String name
The name of the service instance.
String serviceName
The name of the service that the service instance belongs to.
String spec
The service spec that was used to create the service instance.
String templateMajorVersion
The major version of the service template that was used to create the service instance.
String templateMinorVersion
The minor version of the service template that was used to create the service instance.
String templateName
The name of the service template that was used to create the service instance.
List<E> lastSuccessfulComponentDeploymentIds
The IDs for the last successful components deployed for this service instance.
String lastSuccessfulEnvironmentDeploymentId
The ID for the last successful environment deployed for this service instance.
String lastSuccessfulServicePipelineDeploymentId
The ID for the last successful service pipeline deployed for this service instance.
String spec
The service spec that was used to create the service instance.
String templateMajorVersion
The major version of the service template that was used to create the service pipeline.
String templateMinorVersion
The minor version of the service template that was used to create the service pipeline.
String templateName
The name of the service template that was used to create the service instance.
String arn
The Amazon Resource Name (ARN) of the service instance.
Date createdAt
The time when the service instance was created.
String deploymentStatus
The service instance deployment status.
String deploymentStatusMessage
A service instance deployment status message.
String environmentName
The name of the environment that the service instance was deployed into.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this service instance.
Date lastDeploymentAttemptedAt
The time when a deployment of the service was last attempted.
Date lastDeploymentSucceededAt
The time when the service was last deployed successfully.
String lastSucceededDeploymentId
The ID of the last successful deployment of this service instance.
String name
The name of the service instance.
String serviceName
The name of the service that the service instance belongs to.
String templateMajorVersion
The service instance template major version.
String templateMinorVersion
The service instance template minor version.
String templateName
The name of the service template.
String arn
The Amazon Resource Name (ARN) of the service pipeline.
Date createdAt
The time when the service pipeline was created.
String deploymentStatus
The deployment status of the service pipeline.
String deploymentStatusMessage
A service pipeline deployment status message.
String lastAttemptedDeploymentId
The ID of the last attempted deployment of this service pipeline.
Date lastDeploymentAttemptedAt
The time when a deployment of the service pipeline was last attempted.
Date lastDeploymentSucceededAt
The time when the service pipeline was last deployed successfully.
String lastSucceededDeploymentId
The ID of the last successful deployment of this service pipeline.
String spec
The service spec that was used to create the service pipeline.
String templateMajorVersion
The major version of the service template that was used to create the service pipeline.
String templateMinorVersion
The minor version of the service template that was used to create the service pipeline.
String templateName
The name of the service template that was used to create the service pipeline.
String spec
The service spec that was used to create the service pipeline.
String templateMajorVersion
The major version of the service template that was used to create the service pipeline.
String templateMinorVersion
The minor version of the service template that was used to create the service pipeline.
String templateName
The name of the service template that was used to create the service pipeline.
String arn
The Amazon Resource Name (ARN) of the service.
Date createdAt
The time when the service was created.
String description
A description of the service.
Date lastModifiedAt
The time when the service was last modified.
String name
The name of the service.
String status
The status of the service.
String statusMessage
A service status message.
String templateName
The name of the service template.
List<E> latestBlockers
The latest active blockers for the synced service.
String serviceInstanceName
The name of the service instance that you want sync your service configuration with.
String serviceName
The name of the service that you want to get the sync blocker summary for. If given a service instance name and a service name, it will return the blockers only applying to the instance that is blocked.
If given only a service name, it will return the blockers that apply to all of the instances. In order to get the blockers for a single instance, you will need to make two distinct calls, one to get the sync blocker summary for the service and the other to get the sync blocker for the service instance.
String branch
The name of the code repository branch that holds the service code Proton will sync with.
String filePath
The file path to the service sync configuration file.
String repositoryName
The name of the code repository that holds the service code Proton will sync with.
String repositoryProvider
The name of the repository provider that holds the repository Proton will sync with.
String serviceName
The name of the service that the service instance is added to.
String arn
The Amazon Resource Name (ARN) of the service template.
Date createdAt
The time when the service template was created.
String description
A description of the service template.
String displayName
The service template name as displayed in the developer interface.
String encryptionKey
The customer provided service template encryption key that's used to encrypt data.
Date lastModifiedAt
The time when the service template was last modified.
String name
The name of the service template.
String pipelineProvisioning
If pipelineProvisioning is true, a service pipeline is included in the service
template. Otherwise, a service pipeline isn't included in the service template.
String recommendedVersion
The recommended version of the service template.
String arn
The Amazon Resource Name (ARN) of the service template.
Date createdAt
The time when the service template was created.
String description
A description of the service template.
String displayName
The service template name as displayed in the developer interface.
Date lastModifiedAt
The time when the service template was last modified.
String name
The name of the service template.
String pipelineProvisioning
If pipelineProvisioning is true, a service pipeline is included in the service
template, otherwise a service pipeline isn't included in the service template.
String recommendedVersion
The recommended version of the service template.
String arn
The Amazon Resource Name (ARN) of the version of a service template.
List<E> compatibleEnvironmentTemplates
An array of compatible environment template names for the major version of a service template.
Date createdAt
The time when the version of a service template was created.
String description
A description of the version of a service template.
Date lastModifiedAt
The time when the version of a service template was last modified.
String majorVersion
The latest major version that's associated with the version of a service template.
String minorVersion
The minor version of a service template.
String recommendedMinorVersion
The recommended minor version of the service template.
String schema
The schema of the version of a service template.
String status
The service template version status.
String statusMessage
A service template version status message.
List<E> supportedComponentSources
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.
String templateName
The name of the version of a service template.
String arn
The Amazon Resource Name (ARN) of the version of a service template.
Date createdAt
The time when the version of a service template was created.
String description
A description of the version of a service template.
Date lastModifiedAt
The time when the version of a service template was last modified.
String majorVersion
The latest major version that's associated with the version of a service template.
String minorVersion
The minor version of a service template.
String recommendedMinorVersion
The recommended minor version of the service template.
String status
The service template minor version status.
String statusMessage
A service template minor version status message.
String templateName
The name of the service template.
List<E> contexts
The contexts for the sync blocker.
Date createdAt
The time when the sync blocker was created.
String createdReason
The reason why the sync blocker was created.
String id
The ID of the sync blocker.
Date resolvedAt
The time the sync blocker was resolved.
String resolvedReason
The reason the sync blocker was resolved.
String status
The status of the sync blocker.
String type
The type of the sync blocker.
String branch
The repository branch.
String repositoryName
The repository name (for example, myrepos/myrepo).
String repositoryProvider
The repository provider.
String subdirectory
A subdirectory path to your template bundle version.
String templateName
The template name.
String templateType
The template type.
S3ObjectSource s3
An S3 source object that includes the template bundle S3 path and name for a template minor version.
Boolean deletePipelineProvisioningRepository
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.
String pipelineCodebuildRoleArn
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.
RepositoryBranchInput pipelineProvisioningRepository
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.
String pipelineServiceRoleArn
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.
AccountSettings accountSettings
The Proton pipeline service role and repository data shared across the Amazon Web Services account.
String clientToken
The client token for the updated component.
String deploymentType
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.
String description
An optional customer-provided description of the component.
String name
The name of the component to update.
String serviceInstanceName
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.
String serviceName
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.
String serviceSpec
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.
String templateFile
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.
Component component
The detailed data of the updated component.
String codebuildRoleArn
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.
String componentRoleArn
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.
String id
The ID of the environment account connection to update.
String roleArn
The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection detail data that's returned by Proton.
String codebuildRoleArn
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
String componentRoleArn
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.
String deploymentType
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).
String description
A description of the environment update.
String environmentAccountConnectionId
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.
String name
The name of the environment to update.
String protonServiceRoleArn
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
RepositoryBranchInput provisioningRepository
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.
String spec
The formatted specification that defines the update.
String templateMajorVersion
The major version of the environment to update.
String templateMinorVersion
The minor version of the environment to update.
Environment environment
The environment detail data that's returned by Proton.
EnvironmentTemplate environmentTemplate
The environment template detail data that's returned by Proton.
String description
A description of environment template version to update.
String majorVersion
To update a major version of an environment template, include major Version.
String minorVersion
To update a minor version of an environment template, include minorVersion.
String status
The status of the environment template minor version to update.
String templateName
The name of the environment template.
EnvironmentTemplateVersion environmentTemplateVersion
The environment template version detail data that's returned by Proton.
String clientToken
The client token of the service instance to update.
String deploymentType
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.
String name
The name of the service instance to update.
String serviceName
The name of the service that the service instance belongs to.
String spec
The formatted specification that defines the service instance update.
String templateMajorVersion
The major version of the service template to update.
String templateMinorVersion
The minor version of the service template to update.
ServiceInstance serviceInstance
The service instance summary data that's returned by Proton.
String deploymentType
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.
String serviceName
The name of the service to that the pipeline is associated with.
String spec
The spec for the service pipeline to update.
String templateMajorVersion
The major version of the service template that was used to create the service that the pipeline is associated with.
String templateMinorVersion
The minor version of the service template that was used to create the service that the pipeline is associated with.
ServicePipeline pipeline
The pipeline details that are returned by Proton.
String description
The edited service description.
String name
The name of the service to edit.
String spec
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.
Service service
The service detail data that's returned by Proton.
String serviceInstanceName
The name of the service instance that you want to update the service sync blocker for.
String serviceName
The name of the service that you want to update the service sync blocker for.
SyncBlocker serviceSyncBlocker
The detailed data on the service sync blocker that was updated.
String branch
The name of the code repository branch where the Proton Ops file is found.
String filePath
The path to the Proton Ops file.
String repositoryName
The name of the repository where the Proton Ops file is found.
String repositoryProvider
The name of the repository provider where the Proton Ops file is found.
String serviceName
The name of the service the Proton Ops file is for.
ServiceSyncConfig serviceSyncConfig
The detailed data of the Proton Ops file.
ServiceTemplate serviceTemplate
The service template detail data that's returned by Proton.
List<E> compatibleEnvironmentTemplates
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.
String description
A description of a service template version to update.
String majorVersion
To update a major version of a service template, include major Version.
String minorVersion
To update a minor version of a service template, include minorVersion.
String status
The status of the service template minor version to update.
List<E> supportedComponentSources
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.
String templateName
The name of the service template.
ServiceTemplateVersion serviceTemplateVersion
The service template version detail data that's returned by Proton.
String branch
The repository branch for your template.
String repositoryName
The repository name (for example, myrepos/myrepo).
String repositoryProvider
The repository provider.
String subdirectory
A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
String templateName
The synced template name.
String templateType
The synced template type.
TemplateSyncConfig templateSyncConfig
The template sync configuration detail data that's returned by Proton.
Copyright © 2023. All rights reserved.