@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSProton extends Object implements AWSProton
AWSProton
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public AcceptEnvironmentAccountConnectionResult acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest request)
AWSProton
In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
For more information, see Environment account connections in the Proton Administrator guide.
acceptEnvironmentAccountConnection
in interface AWSProton
public CancelEnvironmentDeploymentResult cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest request)
AWSProton
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is
IN_PROGRESS
. For more information, see Update an environment in the
Proton Administrator guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED
.
If the cancellation attempt fails, the resulting deployment state is FAILED
.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED
and the cancellation attempt has no effect.
cancelEnvironmentDeployment
in interface AWSProton
public CancelServiceInstanceDeploymentResult cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest request)
AWSProton
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is
IN_PROGRESS
. For more information, see Update a service instance in the Proton Administrator
guide or the Proton
User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED
.
If the cancellation attempt fails, the resulting deployment state is FAILED
.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED
and the cancellation attempt has no effect.
cancelServiceInstanceDeployment
in interface AWSProton
public CancelServicePipelineDeploymentResult cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest request)
AWSProton
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is
IN_PROGRESS
. For more information, see Update a service pipeline in the Proton Administrator
guide or the Proton
User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED
.
If the cancellation attempt fails, the resulting deployment state is FAILED
.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED
and the cancellation attempt has no effect.
cancelServicePipelineDeployment
in interface AWSProton
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AWSProton
Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.
You can provision environments using the following methods:
Standard provisioning: Proton makes direct calls to provision your resources.
Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.
For more information, see the Environments in the Proton Administrator Guide.
createEnvironment
in interface AWSProton
public CreateEnvironmentAccountConnectionResult createEnvironmentAccountConnection(CreateEnvironmentAccountConnectionRequest request)
AWSProton
Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator guide.
createEnvironmentAccountConnection
in interface AWSProton
public CreateEnvironmentTemplateResult createEnvironmentTemplate(CreateEnvironmentTemplateRequest request)
AWSProton
Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide.
You can create an environment template in one of the two following ways:
Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.
Register and publish a customer managed environment template that connects Proton to your existing
provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned
infrastructure. To create an environment template for customer provisioned and managed infrastructure, include
the provisioning
parameter and set the value to CUSTOMER_MANAGED
. For more information,
see Register and publish an
environment template in the Proton Administrator Guide.
createEnvironmentTemplate
in interface AWSProton
public CreateEnvironmentTemplateVersionResult createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest request)
AWSProton
Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.
createEnvironmentTemplateVersion
in interface AWSProton
public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
AWSProton
Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the Proton Administrator Guide.
createRepository
in interface AWSProton
public CreateServiceResult createService(CreateServiceRequest request)
AWSProton
Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton Administrator Guide and Services in the Proton User Guide.
createService
in interface AWSProton
public CreateServiceTemplateResult createServiceTemplate(CreateServiceTemplateRequest request)
AWSProton
Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the Proton Administrator Guide.
createServiceTemplate
in interface AWSProton
public CreateServiceTemplateVersionResult createServiceTemplateVersion(CreateServiceTemplateVersionRequest request)
AWSProton
Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.
createServiceTemplateVersion
in interface AWSProton
public CreateTemplateSyncConfigResult createTemplateSyncConfig(CreateTemplateSyncConfigRequest request)
AWSProton
Set up a template for automated template version creation. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide.
createTemplateSyncConfig
in interface AWSProton
public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
AWSProton
Delete an environment.
deleteEnvironment
in interface AWSProton
public DeleteEnvironmentAccountConnectionResult deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest request)
AWSProton
In an environment account, delete an environment account connection.
After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.
For more information, see Environment account connections in the Proton Administrator guide.
deleteEnvironmentAccountConnection
in interface AWSProton
public DeleteEnvironmentTemplateResult deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest request)
AWSProton
If no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplate
in interface AWSProton
public DeleteEnvironmentTemplateVersionResult deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest request)
AWSProton
If no other minor versions of an environment template exist, delete a major version of the environment template
if it's not the Recommended
version. Delete the Recommended
version of the environment
template if no other major versions or minor versions of the environment template exist. A major version of an
environment template is a version that's not backward compatible.
Delete a minor version of an environment template if it isn't the Recommended
version. Delete
a Recommended
minor version of the environment template if no other minor versions of the
environment template exist. A minor version of an environment template is a version that's backward compatible.
deleteEnvironmentTemplateVersion
in interface AWSProton
public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
AWSProton
De-register and unlink your repository.
deleteRepository
in interface AWSProton
public DeleteServiceResult deleteService(DeleteServiceRequest request)
AWSProton
Delete a service.
deleteService
in interface AWSProton
public DeleteServiceTemplateResult deleteServiceTemplate(DeleteServiceTemplateRequest request)
AWSProton
If no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplate
in interface AWSProton
public DeleteServiceTemplateVersionResult deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest request)
AWSProton
If no other minor versions of a service template exist, delete a major version of the service template if it's
not the Recommended
version. Delete the Recommended
version of the service template if
no other major versions or minor versions of the service template exist. A major version of a service template is
a version that isn't backwards compatible.
Delete a minor version of a service template if it's not the Recommended
version. Delete a
Recommended
minor version of the service template if no other minor versions of the service template
exist. A minor version of a service template is a version that's backwards compatible.
deleteServiceTemplateVersion
in interface AWSProton
public DeleteTemplateSyncConfigResult deleteTemplateSyncConfig(DeleteTemplateSyncConfigRequest request)
AWSProton
Delete a template sync configuration.
deleteTemplateSyncConfig
in interface AWSProton
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
AWSProton
Get detail data for the Proton pipeline service role.
getAccountSettings
in interface AWSProton
public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
AWSProton
Get detail data for an environment.
getEnvironment
in interface AWSProton
public GetEnvironmentAccountConnectionResult getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest request)
AWSProton
In an environment account, view the detail data for an environment account connection.
For more information, see Environment account connections in the Proton Administrator guide.
getEnvironmentAccountConnection
in interface AWSProton
public GetEnvironmentTemplateResult getEnvironmentTemplate(GetEnvironmentTemplateRequest request)
AWSProton
Get detail data for an environment template.
getEnvironmentTemplate
in interface AWSProton
public GetEnvironmentTemplateVersionResult getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest request)
AWSProton
View detail data for a major or minor version of an environment template.
getEnvironmentTemplateVersion
in interface AWSProton
public GetRepositoryResult getRepository(GetRepositoryRequest request)
AWSProton
Get detail data for a repository.
getRepository
in interface AWSProton
public GetRepositorySyncStatusResult getRepositorySyncStatus(GetRepositorySyncStatusRequest request)
AWSProton
Get the repository sync status.
getRepositorySyncStatus
in interface AWSProton
public GetServiceResult getService(GetServiceRequest request)
AWSProton
Get detail data for a service.
getService
in interface AWSProton
public GetServiceInstanceResult getServiceInstance(GetServiceInstanceRequest request)
AWSProton
Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
getServiceInstance
in interface AWSProton
public GetServiceTemplateResult getServiceTemplate(GetServiceTemplateRequest request)
AWSProton
Get detail data for a service template.
getServiceTemplate
in interface AWSProton
public GetServiceTemplateVersionResult getServiceTemplateVersion(GetServiceTemplateVersionRequest request)
AWSProton
View detail data for a major or minor version of a service template.
getServiceTemplateVersion
in interface AWSProton
public GetTemplateSyncConfigResult getTemplateSyncConfig(GetTemplateSyncConfigRequest request)
AWSProton
Get detail data for a template sync configuration.
getTemplateSyncConfig
in interface AWSProton
public GetTemplateSyncStatusResult getTemplateSyncStatus(GetTemplateSyncStatusRequest request)
AWSProton
Get the status of a template sync.
getTemplateSyncStatus
in interface AWSProton
public ListEnvironmentAccountConnectionsResult listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest request)
AWSProton
View a list of environment account connections.
For more information, see Environment account connections in the Proton Administrator guide.
listEnvironmentAccountConnections
in interface AWSProton
public ListEnvironmentOutputsResult listEnvironmentOutputs(ListEnvironmentOutputsRequest request)
AWSProton
List the infrastructure as code outputs for your environment.
listEnvironmentOutputs
in interface AWSProton
public ListEnvironmentProvisionedResourcesResult listEnvironmentProvisionedResources(ListEnvironmentProvisionedResourcesRequest request)
AWSProton
List the provisioned resources for your environment.
listEnvironmentProvisionedResources
in interface AWSProton
public ListEnvironmentTemplateVersionsResult listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest request)
AWSProton
List major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersions
in interface AWSProton
public ListEnvironmentTemplatesResult listEnvironmentTemplates(ListEnvironmentTemplatesRequest request)
AWSProton
List environment templates.
listEnvironmentTemplates
in interface AWSProton
public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
AWSProton
List environments with detail data summaries.
listEnvironments
in interface AWSProton
public ListRepositoriesResult listRepositories(ListRepositoriesRequest request)
AWSProton
List repositories with detail data.
listRepositories
in interface AWSProton
public ListRepositorySyncDefinitionsResult listRepositorySyncDefinitions(ListRepositorySyncDefinitionsRequest request)
AWSProton
List repository sync definitions with detail data.
listRepositorySyncDefinitions
in interface AWSProton
public ListServiceInstanceOutputsResult listServiceInstanceOutputs(ListServiceInstanceOutputsRequest request)
AWSProton
View a list service instance infrastructure as code outputs with detail data.
listServiceInstanceOutputs
in interface AWSProton
public ListServiceInstanceProvisionedResourcesResult listServiceInstanceProvisionedResources(ListServiceInstanceProvisionedResourcesRequest request)
AWSProton
List provisioned resources for a service instance with details.
listServiceInstanceProvisionedResources
in interface AWSProton
public ListServiceInstancesResult listServiceInstances(ListServiceInstancesRequest request)
AWSProton
List service instances with summaries of detail data.
listServiceInstances
in interface AWSProton
public ListServicePipelineOutputsResult listServicePipelineOutputs(ListServicePipelineOutputsRequest request)
AWSProton
View a list service pipeline infrastructure as code outputs with detail.
listServicePipelineOutputs
in interface AWSProton
public ListServicePipelineProvisionedResourcesResult listServicePipelineProvisionedResources(ListServicePipelineProvisionedResourcesRequest request)
AWSProton
List provisioned resources for a service and pipeline with details.
listServicePipelineProvisionedResources
in interface AWSProton
public ListServiceTemplateVersionsResult listServiceTemplateVersions(ListServiceTemplateVersionsRequest request)
AWSProton
List major or minor versions of a service template with detail data.
listServiceTemplateVersions
in interface AWSProton
public ListServiceTemplatesResult listServiceTemplates(ListServiceTemplatesRequest request)
AWSProton
List service templates with detail data.
listServiceTemplates
in interface AWSProton
public ListServicesResult listServices(ListServicesRequest request)
AWSProton
List services with summaries of detail data.
listServices
in interface AWSProton
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSProton
List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
listTagsForResource
in interface AWSProton
public NotifyResourceDeploymentStatusChangeResult notifyResourceDeploymentStatusChange(NotifyResourceDeploymentStatusChangeRequest request)
AWSProton
Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.
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.
notifyResourceDeploymentStatusChange
in interface AWSProton
public RejectEnvironmentAccountConnectionResult rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest request)
AWSProton
In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.
You can’t reject an environment account connection that is connected to an environment.
For more information, see Environment account connections in the Proton Administrator guide.
rejectEnvironmentAccountConnection
in interface AWSProton
public TagResourceResult tagResource(TagResourceRequest request)
AWSProton
Tag a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
tagResource
in interface AWSProton
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSProton
Remove a tag from a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
untagResource
in interface AWSProton
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AWSProton
Update the Proton service pipeline role or repository settings.
updateAccountSettings
in interface AWSProton
public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AWSProton
Update an environment.
If the environment is associated with an environment account connection, don't update or include the
protonServiceRoleArn
and provisioningRepository
parameter to update or connect to an
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.
If the environment isn't associated with an environment account connection, don't update or include
the environmentAccountConnectionId
parameter to update or connect to an environment account
connection.
You can update either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and value. You can’t update both.
If the environment was provisioned with pull request provisioning, include the
provisioningRepository
parameter and omit the protonServiceRoleArn
and
environmentAccountConnectionId
parameters.
If the environment wasn't provisioned with pull request provisioning, omit the
provisioningRepository
parameter.
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's higher than the major version in use and a minor version (optional).
updateEnvironment
in interface AWSProton
public UpdateEnvironmentAccountConnectionResult updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest request)
AWSProton
In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton Administrator guide.
updateEnvironmentAccountConnection
in interface AWSProton
public UpdateEnvironmentTemplateResult updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest request)
AWSProton
Update an environment template.
updateEnvironmentTemplate
in interface AWSProton
public UpdateEnvironmentTemplateVersionResult updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest request)
AWSProton
Update a major or minor version of an environment template.
updateEnvironmentTemplateVersion
in interface AWSProton
public UpdateServiceResult updateService(UpdateServiceRequest request)
AWSProton
Edit a service description or use a spec to add and delete service instances.
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the description
parameter to modify the description.
Edit the spec
parameter to add or delete instances.
updateService
in interface AWSProton
public UpdateServiceInstanceResult updateServiceInstance(UpdateServiceInstanceRequest request)
AWSProton
Update a service instance.
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).
updateServiceInstance
in interface AWSProton
public UpdateServicePipelineResult updateServicePipeline(UpdateServicePipelineRequest request)
AWSProton
Update the service pipeline.
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).
updateServicePipeline
in interface AWSProton
public UpdateServiceTemplateResult updateServiceTemplate(UpdateServiceTemplateRequest request)
AWSProton
Update a service template.
updateServiceTemplate
in interface AWSProton
public UpdateServiceTemplateVersionResult updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest request)
AWSProton
Update a major or minor version of a service template.
updateServiceTemplateVersion
in interface AWSProton
public UpdateTemplateSyncConfigResult updateTemplateSyncConfig(UpdateTemplateSyncConfigRequest request)
AWSProton
Update template sync configuration parameters, except for the templateName
and
templateType
.
updateTemplateSyncConfig
in interface AWSProton
public void shutdown()
AWSProton
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSProton
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSProton
request
- The originally executed request.public AWSProtonWaiters waiters()