String id
The ID of the environment account connection.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection data that's returned by Proton.
RepositoryBranch pipelineProvisioningRepository
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
String pipelineServiceRoleArn
The Amazon Resource Name (ARN) of the Proton pipeline service role.
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 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 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 an 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
Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection detail data that's returned by Proton.
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. You must include either the
environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the
provisioningRepository parameter and values. For more information, see Environment account
connections in the Proton Administrator guide.
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. You must include either the environmentAccountConnectionId or
protonServiceRoleArn parameter and value and omit the provisioningRepository parameter
when you use standard provisioning.
RepositoryBranchInput provisioningRepository
The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the
environmentAccountConnectionId and protonServiceRoleArn parameters.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
String spec
A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.
List<E> tags
Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or 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 Administrator 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
Create tags for your environment template. For more information, see Proton resources and tagging in the Proton Administrator Guide or 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 a 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
Create tags for a new version of an environment template.
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 Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator 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.
Repository repository
The repository detail data that's returned by Proton.
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 Set up repository connection in the Proton Administrator Guide and Setting up with Proton 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 Administrator Guide and Create a service in the Proton User Guide.
List<E> tags
Create tags for your service. For more information, see Proton resources and tagging in the Proton Administrator Guide or 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 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
Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline won't be included for your service. Once specified, this parameter can't be changed. For more information, see Service template bundles in the Proton Administrator Guide.
List<E> tags
Create tags for your service template. For more information, see Proton resources and tagging in the Proton Administrator Guide or 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 compatible environment template objects for the new version of a service template.
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> tags
Create tags for a new version of a service template.
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 branch of the registered repository for your template.
String repositoryName
The name of your repository, 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 id
The ID of the environment account connection to delete.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection detail data that's returned by Proton.
String name
The name of the environment to delete.
Environment environment
The environment detail data that's returned by Proton.
String name
The name of the environment template to delete.
EnvironmentTemplate environmentTemplate
The environment template detail data that's returned by Proton.
EnvironmentTemplateVersion environmentTemplateVersion
The environment template version detail data that's returned by Proton.
Repository repository
The repository detail data that's returned by Proton.
String name
The name of the service to delete.
Service service
The service detail data that's returned by Proton.
String name
The name of the service template to delete.
ServiceTemplate serviceTemplate
The service template detail data that's returned by Proton.
ServiceTemplateVersion serviceTemplateVersion
The service template version detail data that's returned by Proton.
TemplateSyncConfig templateSyncConfig
The template sync configuration detail data that's returned by Proton.
String arn
The Amazon Resource Name (ARN) of the environment.
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.
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 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 repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
String spec
The environment spec.
String templateMajorVersion
The ID of the major version of the environment template.
String templateMinorVersion
The ID of 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 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 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 arn
The Amazon Resource Name (ARN) of the environment.
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.
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 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 version of an environment template.
AccountSettings accountSettings
The Proton pipeline service role detail data that's returned by Proton.
String id
The ID of the environment account connection.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection detail data that's returned by Proton.
String name
The name of the environment that you want to get the detail data for.
Environment environment
The environment detail data that's returned by Proton.
String name
The name of the environment template that you want to get the detail data for.
EnvironmentTemplate environmentTemplate
The environment template detail data that's returned by Proton.
EnvironmentTemplateVersion environmentTemplateVersion
The environment template version detail data that's returned by Proton.
Repository repository
The repository detail data that's returned by Proton.
RepositorySyncAttempt latestSync
The repository sync status detail data that's returned by Proton.
ServiceInstance serviceInstance
The service instance detail data that's returned by Proton.
String name
The name of the service that you want to get the detail data for.
Service service
The service detail data that's returned by Proton.
String name
The name of the service template that you want to get detail data for.
ServiceTemplate serviceTemplate
The service template detail data that's returned by Proton.
ServiceTemplateVersion serviceTemplateVersion
The service template version detail data that's returned by Proton.
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 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 to indicate 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 to indicate 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 nextToken
A token to indicate 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 to indicate 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 to indicate 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 to indicate 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 to indicate 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 nextToken
A token to indicate 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 service instance name.
String serviceName
The service name.
Integer maxResults
The maximum number of service instances to list.
String nextToken
A token to indicate 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 nextToken
A token to indicate 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 to indicate 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 to indicate 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 to indicate 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.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
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 repository Amazon Resource Name (ARN).
String connectionArn
The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
String encryptionKey
Your customer Amazon Web Services KMS encryption key.
String name
The repository name.
String provider
The repository provider.
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 a 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 Set up a repository connection in the Proton Administrator Guide and Setting up with Proton 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
A service instance deployment status message.
String environmentName
The name of the environment that the service instance was deployed into.
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 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.
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.
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 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.
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 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.
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.
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.
String branch
The repository branch.
String repositoryName
The name of the repository, 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.
RepositoryBranchInput pipelineProvisioningRepository
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
String pipelineServiceRoleArn
The Amazon Resource Name (ARN) of the Proton pipeline service role.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
AccountSettings accountSettings
The Proton pipeline service role repository detail data that's returned by Proton.
EnvironmentAccountConnection environmentAccountConnection
The environment account connection detail data that's returned by Proton.
String deploymentType
There are four modes for updating an environment as described in the following. 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 minor or major 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 repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
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 deploymentType
The deployment type.
There are four modes for updating a service instance as described in the following. 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 instance is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include minor or major 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
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 returned by Proton.
String deploymentType
The deployment type.
There are four modes for updating a service pipeline as described in the following. 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 minor or major 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 also 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 also specify a different major version that is higher than the major version in use and a minor version (optional).
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 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 Administrator Guide or the Proton User Guide.
Service service
The service detail data that's returned by Proton.
ServiceTemplate serviceTemplate
The service template detail data that's returned by Proton.
List<E> compatibleEnvironmentTemplates
An array of compatible environment names for a service template major or minor version to update.
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.
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.
String repositoryName
The name of the repository, 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 © 2022. All rights reserved.