# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::Proton module Types # @!attribute [rw] id # The ID of the environment account connection. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AcceptEnvironmentAccountConnectionInput AWS API Documentation # class AcceptEnvironmentAccountConnectionInput < Struct.new( :id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connection # The environment account connection data that's returned by Proton. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AcceptEnvironmentAccountConnectionOutput AWS API Documentation # class AcceptEnvironmentAccountConnectionOutput < Struct.new( :environment_account_connection) SENSITIVE = [] include Aws::Structure end # There *isn't* sufficient access for performing this action. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end # Proton settings that are used for multiple services in the Amazon Web # Services account. # # @!attribute [rw] pipeline_codebuild_role_arn # The Amazon Resource Name (ARN) of the service role that Proton uses # for provisioning pipelines. Proton assumes this role for # CodeBuild-based provisioning. # @return [String] # # @!attribute [rw] pipeline_provisioning_repository # 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. # @return [Types::RepositoryBranch] # # @!attribute [rw] pipeline_service_role_arn # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AccountSettings AWS API Documentation # class AccountSettings < Struct.new( :pipeline_codebuild_role_arn, :pipeline_provisioning_repository, :pipeline_service_role_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] component_name # The name of the component with the deployment to cancel. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelComponentDeploymentInput AWS API Documentation # class CancelComponentDeploymentInput < Struct.new( :component_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] component # The detailed data of the component with the deployment that is being # canceled. # @return [Types::Component] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelComponentDeploymentOutput AWS API Documentation # class CancelComponentDeploymentOutput < Struct.new( :component) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_name # The name of the environment with the deployment to cancel. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelEnvironmentDeploymentInput AWS API Documentation # class CancelEnvironmentDeploymentInput < Struct.new( :environment_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment # The environment summary data that's returned by Proton. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelEnvironmentDeploymentOutput AWS API Documentation # class CancelEnvironmentDeploymentOutput < Struct.new( :environment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_instance_name # The name of the service instance with the deployment to cancel. # @return [String] # # @!attribute [rw] service_name # The name of the service with the service instance deployment to # cancel. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServiceInstanceDeploymentInput AWS API Documentation # class CancelServiceInstanceDeploymentInput < Struct.new( :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_instance # The service instance summary data that's returned by Proton. # @return [Types::ServiceInstance] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServiceInstanceDeploymentOutput AWS API Documentation # class CancelServiceInstanceDeploymentOutput < Struct.new( :service_instance) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_name # The name of the service with the service pipeline deployment to # cancel. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServicePipelineDeploymentInput AWS API Documentation # class CancelServicePipelineDeploymentInput < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] pipeline # The service pipeline detail data that's returned by Proton. # @return [Types::ServicePipeline] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServicePipelineDeploymentOutput AWS API Documentation # class CancelServicePipelineDeploymentOutput < Struct.new( :pipeline) SENSITIVE = [] include Aws::Structure end # Compatible environment template data. # # @!attribute [rw] major_version # The major version of the compatible environment template. # @return [String] # # @!attribute [rw] template_name # The compatible environment template name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CompatibleEnvironmentTemplate AWS API Documentation # class CompatibleEnvironmentTemplate < Struct.new( :major_version, :template_name) SENSITIVE = [] include Aws::Structure end # Compatible environment template data. # # @!attribute [rw] major_version # The major version of the compatible environment template. # @return [String] # # @!attribute [rw] template_name # The compatible environment template name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CompatibleEnvironmentTemplateInput AWS API Documentation # class CompatibleEnvironmentTemplateInput < Struct.new( :major_version, :template_name) SENSITIVE = [] include Aws::Structure end # Detailed data of an Proton component resource. # # For more information about components, see [Proton components][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the component. # @return [String] # # @!attribute [rw] created_at # The time when the component was created. # @return [Time] # # @!attribute [rw] deployment_status # The component deployment status. # @return [String] # # @!attribute [rw] deployment_status_message # The message associated with the component deployment status. # @return [String] # # @!attribute [rw] description # A description of the component. # @return [String] # # @!attribute [rw] environment_name # The name of the Proton environment that this component is associated # with. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this component. # @return [String] # # @!attribute [rw] last_client_request_token # The last token the client requested. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the component was last attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the component was last deployed successfully. # @return [Time] # # @!attribute [rw] last_modified_at # The time when the component was last modified. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this component. # @return [String] # # @!attribute [rw] name # The name of the component. # @return [String] # # @!attribute [rw] service_instance_name # The name of the service instance that this component is attached to. # Provided when a component is attached to a service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service that `serviceInstanceName` is associated # with. Provided when a component is attached to a service instance. # @return [String] # # @!attribute [rw] service_spec # The service spec that the component uses to access service inputs. # Provided when a component is attached to a service instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Component AWS API Documentation # class Component < Struct.new( :arn, :created_at, :deployment_status, :deployment_status_message, :description, :environment_name, :last_attempted_deployment_id, :last_client_request_token, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_modified_at, :last_succeeded_deployment_id, :name, :service_instance_name, :service_name, :service_spec) SENSITIVE = [:deployment_status_message, :description, :service_spec] include Aws::Structure end # The detailed data about the current state of the component. # # @!attribute [rw] service_instance_name # The name of the service instance that this component is attached to. # Provided when a component is attached to a service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service that `serviceInstanceName` is associated # with. Provided when a component is attached to a service instance. # @return [String] # # @!attribute [rw] service_spec # The service spec that the component uses to access service inputs. # Provided when a component is attached to a service instance. # @return [String] # # @!attribute [rw] template_file # The template file used. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ComponentState AWS API Documentation # class ComponentState < Struct.new( :service_instance_name, :service_name, :service_spec, :template_file) SENSITIVE = [:service_spec, :template_file] include Aws::Structure end # Summary data of an Proton component resource. # # For more information about components, see [Proton components][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the component. # @return [String] # # @!attribute [rw] created_at # The time when the component was created. # @return [Time] # # @!attribute [rw] deployment_status # The component deployment status. # @return [String] # # @!attribute [rw] deployment_status_message # The message associated with the component deployment status. # @return [String] # # @!attribute [rw] environment_name # The name of the Proton environment that this component is associated # with. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this component. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the component was last attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the component was last deployed successfully. # @return [Time] # # @!attribute [rw] last_modified_at # The time when the component was last modified. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this component. # @return [String] # # @!attribute [rw] name # The name of the component. # @return [String] # # @!attribute [rw] service_instance_name # The name of the service instance that this component is attached to. # Provided when a component is attached to a service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service that `serviceInstanceName` is associated # with. Provided when a component is attached to a service instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ComponentSummary AWS API Documentation # class ComponentSummary < Struct.new( :arn, :created_at, :deployment_status, :deployment_status_message, :environment_name, :last_attempted_deployment_id, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_modified_at, :last_succeeded_deployment_id, :name, :service_instance_name, :service_name) SENSITIVE = [:deployment_status_message] include Aws::Structure end # The request *couldn't* be made due to a conflicting operation or # resource. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end # Summary counts of each Proton resource type. # # @!attribute [rw] 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. # @return [Types::ResourceCountsSummary] # # @!attribute [rw] environment_templates # The total number of environment templates in the Amazon Web Services # account. The `environmentTemplates` object will only contain `total` # members. # @return [Types::ResourceCountsSummary] # # @!attribute [rw] environments # The staleness counts for Proton environments in the Amazon Web # Services account. The `environments` object will only contain # `total` members. # @return [Types::ResourceCountsSummary] # # @!attribute [rw] pipelines # The staleness counts for Proton pipelines in the Amazon Web Services # account. # @return [Types::ResourceCountsSummary] # # @!attribute [rw] service_instances # The staleness counts for Proton service instances in the Amazon Web # Services account. # @return [Types::ResourceCountsSummary] # # @!attribute [rw] service_templates # The total number of service templates in the Amazon Web Services # account. The `serviceTemplates` object will only contain `total` # members. # @return [Types::ResourceCountsSummary] # # @!attribute [rw] services # The staleness counts for Proton services in the Amazon Web Services # account. # @return [Types::ResourceCountsSummary] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CountsSummary AWS API Documentation # class CountsSummary < Struct.new( :components, :environment_templates, :environments, :pipelines, :service_instances, :service_templates, :services) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # The client token for the created component. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] description # An optional customer-provided description of the component. # @return [String] # # @!attribute [rw] environment_name # 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`. # @return [String] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] name # The customer-provided name of the component. # @return [String] # # @!attribute [rw] service_instance_name # 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. # @return [String] # # @!attribute [rw] service_name # 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. # @return [String] # # @!attribute [rw] service_spec # 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. # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @!attribute [rw] template_file # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateComponentInput AWS API Documentation # class CreateComponentInput < Struct.new( :client_token, :description, :environment_name, :manifest, :name, :service_instance_name, :service_name, :service_spec, :tags, :template_file) SENSITIVE = [:description, :manifest, :service_spec, :template_file] include Aws::Structure end # @!attribute [rw] component # The detailed data of the created component. # @return [Types::Component] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateComponentOutput AWS API Documentation # class CreateComponentOutput < Struct.new( :component) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # When included, if two identical requests are made with the same # client token, Proton returns the environment account connection that # the first request created. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] codebuild_role_arn # 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. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] environment_name # The name of the Proton environment that's created in the associated # management account. # @return [String] # # @!attribute [rw] management_account_id # 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. # @return [String] # # @!attribute [rw] role_arn # 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. # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentAccountConnectionInput AWS API Documentation # class CreateEnvironmentAccountConnectionInput < Struct.new( :client_token, :codebuild_role_arn, :component_role_arn, :environment_name, :management_account_id, :role_arn, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connection # The environment account connection detail data that's returned by # Proton. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentAccountConnectionOutput AWS API Documentation # class CreateEnvironmentAccountConnectionOutput < Struct.new( :environment_account_connection) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] codebuild_role_arn # 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. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] description # A description of the environment that's being created and deployed. # @return [String] # # @!attribute [rw] environment_account_connection_id # 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][1] 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. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html # @return [String] # # @!attribute [rw] name # The name of the environment. # @return [String] # # @!attribute [rw] proton_service_role_arn # 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. # @return [String] # # @!attribute [rw] provisioning_repository # 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. # @return [Types::RepositoryBranchInput] # # @!attribute [rw] spec # A YAML formatted string that provides inputs as defined in the # environment template bundle schema file. For more information, see # [Environments][1] in the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @!attribute [rw] template_major_version # The major version of the environment template. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the environment template. # @return [String] # # @!attribute [rw] template_name # The name of the environment template. For more information, see # [Environment Templates][1] in the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentInput AWS API Documentation # class CreateEnvironmentInput < Struct.new( :codebuild_role_arn, :component_role_arn, :description, :environment_account_connection_id, :name, :proton_service_role_arn, :provisioning_repository, :spec, :tags, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:description, :spec] include Aws::Structure end # @!attribute [rw] environment # The environment detail data that's returned by Proton. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentOutput AWS API Documentation # class CreateEnvironmentOutput < Struct.new( :environment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] description # A description of the environment template. # @return [String] # # @!attribute [rw] display_name # The environment template name as displayed in the developer # interface. # @return [String] # # @!attribute [rw] encryption_key # A customer provided encryption key that Proton uses to encrypt data. # @return [String] # # @!attribute [rw] name # The name of the environment template. # @return [String] # # @!attribute [rw] provisioning # When included, indicates that the environment template is for # customer provisioned and managed infrastructure. # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateInput AWS API Documentation # class CreateEnvironmentTemplateInput < Struct.new( :description, :display_name, :encryption_key, :name, :provisioning, :tags) SENSITIVE = [:description, :display_name] include Aws::Structure end # @!attribute [rw] environment_template # The environment template detail data that's returned by Proton. # @return [Types::EnvironmentTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateOutput AWS API Documentation # class CreateEnvironmentTemplateOutput < Struct.new( :environment_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # When included, if two identical requests are made with the same # client token, Proton returns the environment template version that # the first request created. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] description # A description of the new version of an environment template. # @return [String] # # @!attribute [rw] major_version # 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`. # @return [String] # # @!attribute [rw] source # An object that includes the template bundle S3 bucket path and name # for the new version of an template. # @return [Types::TemplateVersionSourceInput] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @!attribute [rw] template_name # The name of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateVersionInput AWS API Documentation # class CreateEnvironmentTemplateVersionInput < Struct.new( :client_token, :description, :major_version, :source, :tags, :template_name) SENSITIVE = [:description] include Aws::Structure end # @!attribute [rw] environment_template_version # The environment template detail data that's returned by Proton. # @return [Types::EnvironmentTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateVersionOutput AWS API Documentation # class CreateEnvironmentTemplateVersionOutput < Struct.new( :environment_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] connection_arn # 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][1] in the *Proton User # Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html # @return [String] # # @!attribute [rw] encryption_key # The ARN of your customer Amazon Web Services Key Management Service # (Amazon Web Services KMS) key. # @return [String] # # @!attribute [rw] name # The repository name (for example, `myrepos/myrepo`). # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateRepositoryInput AWS API Documentation # class CreateRepositoryInput < Struct.new( :connection_arn, :encryption_key, :name, :provider, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] repository # The repository link's detail data that's returned by Proton. # @return [Types::Repository] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateRepositoryOutput AWS API Documentation # class CreateRepositoryOutput < Struct.new( :repository) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] branch_name # 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. # @return [String] # # @!attribute [rw] description # A description of the Proton service. # @return [String] # # @!attribute [rw] name # The service name. # @return [String] # # @!attribute [rw] repository_connection_arn # The Amazon Resource Name (ARN) of the repository connection. For # more information, see [Setting up an AWS CodeStar connection][1] in # the *Proton User Guide*. *Don't* include this parameter if your # service template *doesn't* include a service pipeline. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol # @return [String] # # @!attribute [rw] repository_id # The ID of the code repository. *Don't* include this parameter if # your service template *doesn't* include a service pipeline. # @return [String] # # @!attribute [rw] 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][1] in the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @!attribute [rw] template_major_version # The major version of the service template that was used to create # the service. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template that was used to create # the service. # @return [String] # # @!attribute [rw] template_name # The name of the service template that's used to create the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceInput AWS API Documentation # class CreateServiceInput < Struct.new( :branch_name, :description, :name, :repository_connection_arn, :repository_id, :spec, :tags, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:description, :spec] include Aws::Structure end # @!attribute [rw] client_token # The client token of the service instance to create. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] name # The name of the service instance to create. # @return [String] # # @!attribute [rw] service_name # The name of the service the service instance is added to. # @return [String] # # @!attribute [rw] spec # The spec for the service instance you want to create. # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @!attribute [rw] template_major_version # To create a new major and minor version of the service template, # *exclude* `major Version`. # @return [String] # # @!attribute [rw] template_minor_version # To create a new minor version of the service template, include a # `major Version`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceInstanceInput AWS API Documentation # class CreateServiceInstanceInput < Struct.new( :client_token, :name, :service_name, :spec, :tags, :template_major_version, :template_minor_version) SENSITIVE = [:spec] include Aws::Structure end # @!attribute [rw] service_instance # The detailed data of the service instance being created. # @return [Types::ServiceInstance] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceInstanceOutput AWS API Documentation # class CreateServiceInstanceOutput < Struct.new( :service_instance) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service # The service detail data that's returned by Proton. # @return [Types::Service] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceOutput AWS API Documentation # class CreateServiceOutput < Struct.new( :service) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] branch # The repository branch for your Proton Ops file. # @return [String] # # @!attribute [rw] file_path # The path to the Proton Ops file. # @return [String] # # @!attribute [rw] repository_name # The repository name. # @return [String] # # @!attribute [rw] repository_provider # The provider type for your repository. # @return [String] # # @!attribute [rw] service_name # The name of the service the Proton Ops file is for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceSyncConfigInput AWS API Documentation # class CreateServiceSyncConfigInput < Struct.new( :branch, :file_path, :repository_name, :repository_provider, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_sync_config # The detailed data of the Proton Ops file. # @return [Types::ServiceSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceSyncConfigOutput AWS API Documentation # class CreateServiceSyncConfigOutput < Struct.new( :service_sync_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] description # A description of the service template. # @return [String] # # @!attribute [rw] display_name # The name of the service template as displayed in the developer # interface. # @return [String] # # @!attribute [rw] encryption_key # A customer provided encryption key that's used to encrypt data. # @return [String] # # @!attribute [rw] name # The name of the service template. # @return [String] # # @!attribute [rw] pipeline_provisioning # 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][1] in the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles # @return [String] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateInput AWS API Documentation # class CreateServiceTemplateInput < Struct.new( :description, :display_name, :encryption_key, :name, :pipeline_provisioning, :tags) SENSITIVE = [:description, :display_name] include Aws::Structure end # @!attribute [rw] service_template # The service template detail data that's returned by Proton. # @return [Types::ServiceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateOutput AWS API Documentation # class CreateServiceTemplateOutput < Struct.new( :service_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # When included, if two identical requests are made with the same # client token, Proton returns the service template version that the # first request created. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] compatible_environment_templates # 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. # @return [Array] # # @!attribute [rw] description # A description of the new version of a service template. # @return [String] # # @!attribute [rw] major_version # 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`. # @return [String] # # @!attribute [rw] source # An object that includes the template bundle S3 bucket path and name # for the new version of a service template. # @return [Types::TemplateVersionSourceInput] # # @!attribute [rw] supported_component_sources # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [Array] # # @!attribute [rw] 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html # @return [Array] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersionInput AWS API Documentation # class CreateServiceTemplateVersionInput < Struct.new( :client_token, :compatible_environment_templates, :description, :major_version, :source, :supported_component_sources, :tags, :template_name) SENSITIVE = [:description] include Aws::Structure end # @!attribute [rw] service_template_version # The service template version summary of detail data that's returned # by Proton. # @return [Types::ServiceTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersionOutput AWS API Documentation # class CreateServiceTemplateVersionOutput < Struct.new( :service_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] branch # The repository branch for your template. # @return [String] # # @!attribute [rw] repository_name # The repository name (for example, `myrepos/myrepo`). # @return [String] # # @!attribute [rw] repository_provider # The provider type for your repository. # @return [String] # # @!attribute [rw] subdirectory # A repository subdirectory path to your template bundle directory. # When included, Proton limits the template bundle search to this # repository directory. # @return [String] # # @!attribute [rw] template_name # The name of your registered template. # @return [String] # # @!attribute [rw] template_type # The type of the registered template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateTemplateSyncConfigInput AWS API Documentation # class CreateTemplateSyncConfigInput < Struct.new( :branch, :repository_name, :repository_provider, :subdirectory, :template_name, :template_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_sync_config # The template sync configuration detail data that's returned by # Proton. # @return [Types::TemplateSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateTemplateSyncConfigOutput AWS API Documentation # class CreateTemplateSyncConfigOutput < Struct.new( :template_sync_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the component to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteComponentInput AWS API Documentation # class DeleteComponentInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] component # The detailed data of the component being deleted. # @return [Types::Component] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteComponentOutput AWS API Documentation # class DeleteComponentOutput < Struct.new( :component) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] id # The ID of the deployment to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteDeploymentInput AWS API Documentation # class DeleteDeploymentInput < Struct.new( :id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment # The detailed data of the deployment being deleted. # @return [Types::Deployment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteDeploymentOutput AWS API Documentation # class DeleteDeploymentOutput < Struct.new( :deployment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] id # The ID of the environment account connection to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentAccountConnectionInput AWS API Documentation # class DeleteEnvironmentAccountConnectionInput < Struct.new( :id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connection # The detailed data of the environment account connection being # deleted. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentAccountConnectionOutput AWS API Documentation # class DeleteEnvironmentAccountConnectionOutput < Struct.new( :environment_account_connection) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the environment to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentInput AWS API Documentation # class DeleteEnvironmentInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment # The detailed data of the environment being deleted. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentOutput AWS API Documentation # class DeleteEnvironmentOutput < Struct.new( :environment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the environment template to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateInput AWS API Documentation # class DeleteEnvironmentTemplateInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_template # The detailed data of the environment template being deleted. # @return [Types::EnvironmentTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateOutput AWS API Documentation # class DeleteEnvironmentTemplateOutput < Struct.new( :environment_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] major_version # The environment template major version to delete. # @return [String] # # @!attribute [rw] minor_version # The environment template minor version to delete. # @return [String] # # @!attribute [rw] template_name # The name of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateVersionInput AWS API Documentation # class DeleteEnvironmentTemplateVersionInput < Struct.new( :major_version, :minor_version, :template_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_template_version # The detailed data of the environment template version being deleted. # @return [Types::EnvironmentTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateVersionOutput AWS API Documentation # class DeleteEnvironmentTemplateVersionOutput < Struct.new( :environment_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The repository name. # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteRepositoryInput AWS API Documentation # class DeleteRepositoryInput < Struct.new( :name, :provider) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] repository # The deleted repository link's detail data that's returned by # Proton. # @return [Types::Repository] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteRepositoryOutput AWS API Documentation # class DeleteRepositoryOutput < Struct.new( :repository) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the service to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceInput AWS API Documentation # class DeleteServiceInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service # The detailed data of the service being deleted. # @return [Types::Service] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceOutput AWS API Documentation # class DeleteServiceOutput < Struct.new( :service) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_name # The name of the service that you want to delete the service sync # configuration for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceSyncConfigInput AWS API Documentation # class DeleteServiceSyncConfigInput < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_sync_config # The detailed data for the service sync config. # @return [Types::ServiceSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceSyncConfigOutput AWS API Documentation # class DeleteServiceSyncConfigOutput < Struct.new( :service_sync_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the service template to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateInput AWS API Documentation # class DeleteServiceTemplateInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_template # The detailed data of the service template being deleted. # @return [Types::ServiceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateOutput AWS API Documentation # class DeleteServiceTemplateOutput < Struct.new( :service_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] major_version # The service template major version to delete. # @return [String] # # @!attribute [rw] minor_version # The service template minor version to delete. # @return [String] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersionInput AWS API Documentation # class DeleteServiceTemplateVersionInput < Struct.new( :major_version, :minor_version, :template_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_template_version # The detailed data of the service template version being deleted. # @return [Types::ServiceTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersionOutput AWS API Documentation # class DeleteServiceTemplateVersionOutput < Struct.new( :service_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_name # The template name. # @return [String] # # @!attribute [rw] template_type # The template type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteTemplateSyncConfigInput AWS API Documentation # class DeleteTemplateSyncConfigInput < Struct.new( :template_name, :template_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_sync_config # The template sync configuration detail data that's returned by # Proton. # @return [Types::TemplateSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteTemplateSyncConfigOutput AWS API Documentation # class DeleteTemplateSyncConfigOutput < Struct.new( :template_sync_config) SENSITIVE = [] include Aws::Structure end # The detailed information about a deployment. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the deployment. # @return [String] # # @!attribute [rw] completed_at # The date and time the deployment was completed. # @return [Time] # # @!attribute [rw] component_name # The name of the component associated with this deployment. # @return [String] # # @!attribute [rw] created_at # The date and time the deployment was created. # @return [Time] # # @!attribute [rw] deployment_status # The status of the deployment. # @return [String] # # @!attribute [rw] deployment_status_message # The deployment status message. # @return [String] # # @!attribute [rw] environment_name # The name of the environment associated with this deployment. # @return [String] # # @!attribute [rw] id # The ID of the deployment. # @return [String] # # @!attribute [rw] initial_state # The initial state of the target resource at the time of the # deployment. # @return [Types::DeploymentState] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment. # @return [String] # # @!attribute [rw] last_modified_at # The date and time the deployment was last modified. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment. # @return [String] # # @!attribute [rw] service_instance_name # The name of the deployment's service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service in this deployment. # @return [String] # # @!attribute [rw] target_arn # The Amazon Resource Name (ARN) of the target of the deployment. # @return [String] # # @!attribute [rw] target_resource_created_at # The date and time the depoyment target was created. # @return [Time] # # @!attribute [rw] target_resource_type # The resource type of the deployment target. It can be an # environment, service, service instance, or component. # @return [String] # # @!attribute [rw] target_state # The target state of the target resource at the time of the # deployment. # @return [Types::DeploymentState] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Deployment AWS API Documentation # class Deployment < Struct.new( :arn, :completed_at, :component_name, :created_at, :deployment_status, :deployment_status_message, :environment_name, :id, :initial_state, :last_attempted_deployment_id, :last_modified_at, :last_succeeded_deployment_id, :service_instance_name, :service_name, :target_arn, :target_resource_created_at, :target_resource_type, :target_state) SENSITIVE = [:deployment_status_message] include Aws::Structure end # The detailed data about the current state of the deployment. # # @note DeploymentState is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DeploymentState corresponding to the set member. # # @!attribute [rw] component # The state of the component associated with the deployment. # @return [Types::ComponentState] # # @!attribute [rw] environment # The state of the environment associated with the deployment. # @return [Types::EnvironmentState] # # @!attribute [rw] service_instance # The state of the service instance associated with the deployment. # @return [Types::ServiceInstanceState] # # @!attribute [rw] service_pipeline # The state of the service pipeline associated with the deployment. # @return [Types::ServicePipelineState] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeploymentState AWS API Documentation # class DeploymentState < Struct.new( :component, :environment, :service_instance, :service_pipeline, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class Component < DeploymentState; end class Environment < DeploymentState; end class ServiceInstance < DeploymentState; end class ServicePipeline < DeploymentState; end class Unknown < DeploymentState; end end # Summary data of the deployment. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the deployment. # @return [String] # # @!attribute [rw] completed_at # The date and time the deployment was completed. # @return [Time] # # @!attribute [rw] component_name # The name of the component associated with the deployment. # @return [String] # # @!attribute [rw] created_at # The date and time the deployment was created. # @return [Time] # # @!attribute [rw] deployment_status # The current status of the deployment. # @return [String] # # @!attribute [rw] environment_name # The name of the environment associated with the deployment. # @return [String] # # @!attribute [rw] id # The ID of the deployment. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment. # @return [String] # # @!attribute [rw] last_modified_at # The date and time the deployment was last modified. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment. # @return [String] # # @!attribute [rw] service_instance_name # The name of the service instance associated with the deployment. # @return [String] # # @!attribute [rw] service_name # The name of the service associated with the deployment. # @return [String] # # @!attribute [rw] target_arn # The Amazon Resource Name (ARN) of the target of the deployment. # @return [String] # # @!attribute [rw] target_resource_created_at # The date and time the target resource was created. # @return [Time] # # @!attribute [rw] target_resource_type # The resource type of the deployment target. It can be an # environment, service, service instance, or component. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeploymentSummary AWS API Documentation # class DeploymentSummary < Struct.new( :arn, :completed_at, :component_name, :created_at, :deployment_status, :environment_name, :id, :last_attempted_deployment_id, :last_modified_at, :last_succeeded_deployment_id, :service_instance_name, :service_name, :target_arn, :target_resource_created_at, :target_resource_type) SENSITIVE = [] include Aws::Structure end # Detailed data of an Proton environment resource. An Proton environment # is a set of resources shared across Proton services. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment. # @return [String] # # @!attribute [rw] codebuild_role_arn # The Amazon Resource Name (ARN) of the IAM service role that allows # Proton to provision infrastructure using CodeBuild-based # provisioning on your behalf. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] created_at # The time when the environment was created. # @return [Time] # # @!attribute [rw] deployment_status # The environment deployment status. # @return [String] # # @!attribute [rw] deployment_status_message # An environment deployment status message. # @return [String] # # @!attribute [rw] description # The description of the environment. # @return [String] # # @!attribute [rw] environment_account_connection_id # The ID of the environment account connection that's used to # provision infrastructure resources in an environment account. # @return [String] # # @!attribute [rw] environment_account_id # The ID of the environment account that the environment # infrastructure resources are provisioned in. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this environment. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the environment was last attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the environment was last deployed successfully. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this environment. # @return [String] # # @!attribute [rw] name # The name of the environment. # @return [String] # # @!attribute [rw] proton_service_role_arn # The Amazon Resource Name (ARN) of the Proton service role that # allows Proton to make calls to other services on your behalf. # @return [String] # # @!attribute [rw] provisioning # When included, indicates that the environment template is for # customer provisioned and managed infrastructure. # @return [String] # # @!attribute [rw] provisioning_repository # 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][1]. # # # # [1]: https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html # @return [Types::RepositoryBranch] # # @!attribute [rw] spec # The environment spec. # @return [String] # # @!attribute [rw] template_major_version # The major version of the environment template. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the environment template. # @return [String] # # @!attribute [rw] template_name # The Amazon Resource Name (ARN) of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Environment AWS API Documentation # class Environment < Struct.new( :arn, :codebuild_role_arn, :component_role_arn, :created_at, :deployment_status, :deployment_status_message, :description, :environment_account_connection_id, :environment_account_id, :last_attempted_deployment_id, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_succeeded_deployment_id, :name, :proton_service_role_arn, :provisioning, :provisioning_repository, :spec, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:deployment_status_message, :description, :spec] include Aws::Structure end # Detailed data of an Proton environment account connection resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment account # connection. # @return [String] # # @!attribute [rw] codebuild_role_arn # 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. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] environment_account_id # The environment account that's connected to the environment account # connection. # @return [String] # # @!attribute [rw] environment_name # The name of the environment that's associated with the environment # account connection. # @return [String] # # @!attribute [rw] id # The ID of the environment account connection. # @return [String] # # @!attribute [rw] last_modified_at # The time when the environment account connection was last modified. # @return [Time] # # @!attribute [rw] management_account_id # The ID of the management account that's connected to the # environment account connection. # @return [String] # # @!attribute [rw] requested_at # The time when the environment account connection request was made. # @return [Time] # # @!attribute [rw] role_arn # The IAM service role that's associated with the environment account # connection. # @return [String] # # @!attribute [rw] status # The status of the environment account connection. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentAccountConnection AWS API Documentation # class EnvironmentAccountConnection < Struct.new( :arn, :codebuild_role_arn, :component_role_arn, :environment_account_id, :environment_name, :id, :last_modified_at, :management_account_id, :requested_at, :role_arn, :status) SENSITIVE = [] include Aws::Structure end # Summary data of an Proton environment account connection resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment account # connection. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] environment_account_id # The ID of the environment account that's connected to the # environment account connection. # @return [String] # # @!attribute [rw] environment_name # The name of the environment that's associated with the environment # account connection. # @return [String] # # @!attribute [rw] id # The ID of the environment account connection. # @return [String] # # @!attribute [rw] last_modified_at # The time when the environment account connection was last modified. # @return [Time] # # @!attribute [rw] management_account_id # The ID of the management account that's connected to the # environment account connection. # @return [String] # # @!attribute [rw] requested_at # The time when the environment account connection request was made. # @return [Time] # # @!attribute [rw] role_arn # The IAM service role that's associated with the environment account # connection. # @return [String] # # @!attribute [rw] status # The status of the environment account connection. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentAccountConnectionSummary AWS API Documentation # class EnvironmentAccountConnectionSummary < Struct.new( :arn, :component_role_arn, :environment_account_id, :environment_name, :id, :last_modified_at, :management_account_id, :requested_at, :role_arn, :status) SENSITIVE = [] include Aws::Structure end # The detailed data about the current state of the environment. # # @!attribute [rw] spec # The environment spec that was used to create the environment. # @return [String] # # @!attribute [rw] template_major_version # The major version of the environment template that was used to # create the environment. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the environment template that was used to # create the environment. # @return [String] # # @!attribute [rw] template_name # The name of the environment template that was used to create the # environment. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentState AWS API Documentation # class EnvironmentState < Struct.new( :spec, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:spec] include Aws::Structure end # Summary data of an Proton environment resource. An Proton environment # is a set of resources shared across Proton services. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] created_at # The time when the environment was created. # @return [Time] # # @!attribute [rw] deployment_status # The environment deployment status. # @return [String] # # @!attribute [rw] deployment_status_message # An environment deployment status message. # @return [String] # # @!attribute [rw] description # The description of the environment. # @return [String] # # @!attribute [rw] environment_account_connection_id # The ID of the environment account connection that the environment is # associated with. # @return [String] # # @!attribute [rw] environment_account_id # The ID of the environment account that the environment # infrastructure resources are provisioned in. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this environment. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the environment was last attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the environment was last deployed successfully. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this environment. # @return [String] # # @!attribute [rw] name # The name of the environment. # @return [String] # # @!attribute [rw] proton_service_role_arn # The Amazon Resource Name (ARN) of the Proton service role that # allows Proton to make calls to other services on your behalf. # @return [String] # # @!attribute [rw] provisioning # When included, indicates that the environment template is for # customer provisioned and managed infrastructure. # @return [String] # # @!attribute [rw] template_major_version # The major version of the environment template. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the environment template. # @return [String] # # @!attribute [rw] template_name # The name of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentSummary AWS API Documentation # class EnvironmentSummary < Struct.new( :arn, :component_role_arn, :created_at, :deployment_status, :deployment_status_message, :description, :environment_account_connection_id, :environment_account_id, :last_attempted_deployment_id, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_succeeded_deployment_id, :name, :proton_service_role_arn, :provisioning, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:deployment_status_message, :description] include Aws::Structure end # The environment template data. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment template. # @return [String] # # @!attribute [rw] created_at # The time when the environment template was created. # @return [Time] # # @!attribute [rw] description # A description of the environment template. # @return [String] # # @!attribute [rw] display_name # The name of the environment template as displayed in the developer # interface. # @return [String] # # @!attribute [rw] encryption_key # The customer provided encryption key for the environment template. # @return [String] # # @!attribute [rw] last_modified_at # The time when the environment template was last modified. # @return [Time] # # @!attribute [rw] name # The name of the environment template. # @return [String] # # @!attribute [rw] provisioning # When included, indicates that the environment template is for # customer provisioned and managed infrastructure. # @return [String] # # @!attribute [rw] recommended_version # The ID of the recommended version of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplate AWS API Documentation # class EnvironmentTemplate < Struct.new( :arn, :created_at, :description, :display_name, :encryption_key, :last_modified_at, :name, :provisioning, :recommended_version) SENSITIVE = [:description, :display_name] include Aws::Structure end # A search filter for environment templates. # # @!attribute [rw] major_version # Include `majorVersion` to filter search for a major version. # @return [String] # # @!attribute [rw] template_name # Include `templateName` to filter search for a template name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateFilter AWS API Documentation # class EnvironmentTemplateFilter < Struct.new( :major_version, :template_name) SENSITIVE = [] include Aws::Structure end # The environment template data. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the environment template. # @return [String] # # @!attribute [rw] created_at # The time when the environment template was created. # @return [Time] # # @!attribute [rw] description # A description of the environment template. # @return [String] # # @!attribute [rw] display_name # The name of the environment template as displayed in the developer # interface. # @return [String] # # @!attribute [rw] last_modified_at # The time when the environment template was last modified. # @return [Time] # # @!attribute [rw] name # The name of the environment template. # @return [String] # # @!attribute [rw] provisioning # When included, indicates that the environment template is for # customer provisioned and managed infrastructure. # @return [String] # # @!attribute [rw] recommended_version # The recommended version of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateSummary AWS API Documentation # class EnvironmentTemplateSummary < Struct.new( :arn, :created_at, :description, :display_name, :last_modified_at, :name, :provisioning, :recommended_version) SENSITIVE = [:description, :display_name] include Aws::Structure end # The environment template version data. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the version of an environment # template. # @return [String] # # @!attribute [rw] created_at # The time when the version of an environment template was created. # @return [Time] # # @!attribute [rw] description # A description of the minor version of an environment template. # @return [String] # # @!attribute [rw] last_modified_at # The time when the version of an environment template was last # modified. # @return [Time] # # @!attribute [rw] major_version # The latest major version that's associated with the version of an # environment template. # @return [String] # # @!attribute [rw] minor_version # The minor version of an environment template. # @return [String] # # @!attribute [rw] recommended_minor_version # The recommended minor version of the environment template. # @return [String] # # @!attribute [rw] schema # The schema of the version of an environment template. # @return [String] # # @!attribute [rw] status # The status of the version of an environment template. # @return [String] # # @!attribute [rw] status_message # The status message of the version of an environment template. # @return [String] # # @!attribute [rw] template_name # The name of the version of an environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateVersion AWS API Documentation # class EnvironmentTemplateVersion < Struct.new( :arn, :created_at, :description, :last_modified_at, :major_version, :minor_version, :recommended_minor_version, :schema, :status, :status_message, :template_name) SENSITIVE = [:description, :schema, :status_message] include Aws::Structure end # A summary of the version of an environment template detail data. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the version of an environment # template. # @return [String] # # @!attribute [rw] created_at # The time when the version of an environment template was created. # @return [Time] # # @!attribute [rw] description # A description of the version of an environment template. # @return [String] # # @!attribute [rw] last_modified_at # The time when the version of an environment template was last # modified. # @return [Time] # # @!attribute [rw] major_version # The latest major version that's associated with the version of an # environment template. # @return [String] # # @!attribute [rw] minor_version # The version of an environment template. # @return [String] # # @!attribute [rw] recommended_minor_version # The recommended minor version of the environment template. # @return [String] # # @!attribute [rw] status # The status of the version of an environment template. # @return [String] # # @!attribute [rw] status_message # The status message of the version of an environment template. # @return [String] # # @!attribute [rw] template_name # The name of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateVersionSummary AWS API Documentation # class EnvironmentTemplateVersionSummary < Struct.new( :arn, :created_at, :description, :last_modified_at, :major_version, :minor_version, :recommended_minor_version, :status, :status_message, :template_name) SENSITIVE = [:description, :status_message] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetAccountSettingsInput AWS API Documentation # class GetAccountSettingsInput < Aws::EmptyStructure; end # @!attribute [rw] account_settings # The Proton pipeline service role detail data that's returned by # Proton. # @return [Types::AccountSettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetAccountSettingsOutput AWS API Documentation # class GetAccountSettingsOutput < Struct.new( :account_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the component that you want to get the detailed data # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetComponentInput AWS API Documentation # class GetComponentInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] component # The detailed data of the requested component. # @return [Types::Component] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetComponentOutput AWS API Documentation # class GetComponentOutput < Struct.new( :component) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] component_name # The name of a component that you want to get the detailed data for. # @return [String] # # @!attribute [rw] environment_name # The name of a environment that you want to get the detailed data # for. # @return [String] # # @!attribute [rw] id # The ID of the deployment that you want to get the detailed data for. # @return [String] # # @!attribute [rw] service_instance_name # The name of the service instance associated with the given # deployment ID. `serviceName` must be specified to identify the # service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service associated with the given deployment ID. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetDeploymentInput AWS API Documentation # class GetDeploymentInput < Struct.new( :component_name, :environment_name, :id, :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment # The detailed data of the requested deployment. # @return [Types::Deployment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetDeploymentOutput AWS API Documentation # class GetDeploymentOutput < Struct.new( :deployment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] id # The ID of the environment account connection that you want to get # the detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnectionInput AWS API Documentation # class GetEnvironmentAccountConnectionInput < Struct.new( :id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connection # The detailed data of the requested environment account connection. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnectionOutput AWS API Documentation # class GetEnvironmentAccountConnectionOutput < Struct.new( :environment_account_connection) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the environment that you want to get the detailed data # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentInput AWS API Documentation # class GetEnvironmentInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment # The detailed data of the requested environment. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentOutput AWS API Documentation # class GetEnvironmentOutput < Struct.new( :environment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the environment template that you want to get the # detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateInput AWS API Documentation # class GetEnvironmentTemplateInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_template # The detailed data of the requested environment template. # @return [Types::EnvironmentTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateOutput AWS API Documentation # class GetEnvironmentTemplateOutput < Struct.new( :environment_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] major_version # To get environment template major version detail data, include # `major Version`. # @return [String] # # @!attribute [rw] minor_version # To get environment template minor version detail data, include # `minorVersion`. # @return [String] # # @!attribute [rw] template_name # The name of the environment template a version of which you want to # get detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersionInput AWS API Documentation # class GetEnvironmentTemplateVersionInput < Struct.new( :major_version, :minor_version, :template_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_template_version # The detailed data of the requested environment template version. # @return [Types::EnvironmentTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersionOutput AWS API Documentation # class GetEnvironmentTemplateVersionOutput < Struct.new( :environment_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The repository name, for example `myrepos/myrepo`. # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetRepositoryInput AWS API Documentation # class GetRepositoryInput < Struct.new( :name, :provider) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] repository # The repository link's detail data that's returned by Proton. # @return [Types::Repository] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetRepositoryOutput AWS API Documentation # class GetRepositoryOutput < Struct.new( :repository) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] branch # The repository branch. # @return [String] # # @!attribute [rw] repository_name # The repository name. # @return [String] # # @!attribute [rw] repository_provider # The repository provider. # @return [String] # # @!attribute [rw] sync_type # The repository sync type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetRepositorySyncStatusInput AWS API Documentation # class GetRepositorySyncStatusInput < Struct.new( :branch, :repository_name, :repository_provider, :sync_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] latest_sync # The repository sync status detail data that's returned by Proton. # @return [Types::RepositorySyncAttempt] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetRepositorySyncStatusOutput AWS API Documentation # class GetRepositorySyncStatusOutput < Struct.new( :latest_sync) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetResourcesSummaryInput AWS API Documentation # class GetResourcesSummaryInput < Aws::EmptyStructure; end # @!attribute [rw] counts # Summary counts of each Proton resource type. # @return [Types::CountsSummary] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetResourcesSummaryOutput AWS API Documentation # class GetResourcesSummaryOutput < Struct.new( :counts) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the service that you want to get the detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInput AWS API Documentation # class GetServiceInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of a service instance that you want to get the detailed # data for. # @return [String] # # @!attribute [rw] service_name # The name of the service that you want the service instance input # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceInput AWS API Documentation # class GetServiceInstanceInput < Struct.new( :name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_instance # The detailed data of the requested service instance. # @return [Types::ServiceInstance] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceOutput AWS API Documentation # class GetServiceInstanceOutput < Struct.new( :service_instance) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_instance_name # The name of the service instance that you want the sync status input # for. # @return [String] # # @!attribute [rw] service_name # The name of the service that the service instance belongs to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceSyncStatusInput AWS API Documentation # class GetServiceInstanceSyncStatusInput < Struct.new( :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] desired_state # The service instance sync desired state that's returned by Proton # @return [Types::Revision] # # @!attribute [rw] latest_successful_sync # The detailed data of the latest successful sync with the service # instance. # @return [Types::ResourceSyncAttempt] # # @!attribute [rw] latest_sync # The detailed data of the latest sync with the service instance. # @return [Types::ResourceSyncAttempt] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceSyncStatusOutput AWS API Documentation # class GetServiceInstanceSyncStatusOutput < Struct.new( :desired_state, :latest_successful_sync, :latest_sync) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service # The detailed data of the requested service. # @return [Types::Service] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceOutput AWS API Documentation # class GetServiceOutput < Struct.new( :service) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_instance_name # 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. # @return [String] # # @!attribute [rw] service_name # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceSyncBlockerSummaryInput AWS API Documentation # class GetServiceSyncBlockerSummaryInput < Struct.new( :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_sync_blocker_summary # The detailed data of the requested service sync blocker summary. # @return [Types::ServiceSyncBlockerSummary] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceSyncBlockerSummaryOutput AWS API Documentation # class GetServiceSyncBlockerSummaryOutput < Struct.new( :service_sync_blocker_summary) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_name # The name of the service that you want to get the service sync # configuration for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceSyncConfigInput AWS API Documentation # class GetServiceSyncConfigInput < Struct.new( :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_sync_config # The detailed data of the requested service sync configuration. # @return [Types::ServiceSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceSyncConfigOutput AWS API Documentation # class GetServiceSyncConfigOutput < Struct.new( :service_sync_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the service template that you want to get detailed data # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateInput AWS API Documentation # class GetServiceTemplateInput < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_template # The detailed data of the requested service template. # @return [Types::ServiceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateOutput AWS API Documentation # class GetServiceTemplateOutput < Struct.new( :service_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] major_version # To get service template major version detail data, include `major # Version`. # @return [String] # # @!attribute [rw] minor_version # To get service template minor version detail data, include # `minorVersion`. # @return [String] # # @!attribute [rw] template_name # The name of the service template a version of which you want to get # detailed data for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersionInput AWS API Documentation # class GetServiceTemplateVersionInput < Struct.new( :major_version, :minor_version, :template_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_template_version # The detailed data of the requested service template version. # @return [Types::ServiceTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersionOutput AWS API Documentation # class GetServiceTemplateVersionOutput < Struct.new( :service_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_name # The template name. # @return [String] # # @!attribute [rw] template_type # The template type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetTemplateSyncConfigInput AWS API Documentation # class GetTemplateSyncConfigInput < Struct.new( :template_name, :template_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_sync_config # The template sync configuration detail data that's returned by # Proton. # @return [Types::TemplateSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetTemplateSyncConfigOutput AWS API Documentation # class GetTemplateSyncConfigOutput < Struct.new( :template_sync_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_name # The template name. # @return [String] # # @!attribute [rw] template_type # The template type. # @return [String] # # @!attribute [rw] template_version # The template major version. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetTemplateSyncStatusInput AWS API Documentation # class GetTemplateSyncStatusInput < Struct.new( :template_name, :template_type, :template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] desired_state # The template sync desired state that's returned by Proton. # @return [Types::Revision] # # @!attribute [rw] latest_successful_sync # The details of the last successful sync that's returned by Proton. # @return [Types::ResourceSyncAttempt] # # @!attribute [rw] latest_sync # The details of the last sync that's returned by Proton. # @return [Types::ResourceSyncAttempt] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetTemplateSyncStatusOutput AWS API Documentation # class GetTemplateSyncStatusOutput < Struct.new( :desired_state, :latest_successful_sync, :latest_sync) SENSITIVE = [] include Aws::Structure end # The request failed to register with the service. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/InternalServerException AWS API Documentation # class InternalServerException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end # @!attribute [rw] component_name # The name of the component whose outputs you want. # @return [String] # # @!attribute [rw] deployment_id # The ID of the deployment whose outputs you want. # @return [String] # # @!attribute [rw] next_token # A token that indicates the location of the next output in the array # of outputs, after the list of outputs that was previously requested. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentOutputsInput AWS API Documentation # class ListComponentOutputsInput < Struct.new( :component_name, :deployment_id, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next output in the array # of outputs, after the list of outputs that was previously requested. # @return [String] # # @!attribute [rw] outputs # An array of component Infrastructure as Code (IaC) outputs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentOutputsOutput AWS API Documentation # class ListComponentOutputsOutput < Struct.new( :next_token, :outputs) SENSITIVE = [:outputs] include Aws::Structure end # @!attribute [rw] component_name # The name of the component whose provisioned resources you want. # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentProvisionedResourcesInput AWS API Documentation # class ListComponentProvisionedResourcesInput < Struct.new( :component_name, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] provisioned_resources # An array of provisioned resources for a component. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentProvisionedResourcesOutput AWS API Documentation # class ListComponentProvisionedResourcesOutput < Struct.new( :next_token, :provisioned_resources) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_name # The name of an environment for result list filtering. Proton returns # components associated with the environment or attached to service # instances running in it. # @return [String] # # @!attribute [rw] max_results # The maximum number of components to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next component in the # array of components, after the list of components that was # previously requested. # @return [String] # # @!attribute [rw] service_instance_name # The name of a service instance for result list filtering. Proton # returns the component attached to the service instance, if any. # @return [String] # # @!attribute [rw] service_name # The name of a service for result list filtering. Proton returns # components attached to service instances of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentsInput AWS API Documentation # class ListComponentsInput < Struct.new( :environment_name, :max_results, :next_token, :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] components # An array of components with summary data. # @return [Array] # # @!attribute [rw] next_token # A token that indicates the location of the next component in the # array of components, after the current requested list of components. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentsOutput AWS API Documentation # class ListComponentsOutput < Struct.new( :components, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] component_name # The name of a component for result list filtering. Proton returns # deployments associated with that component. # @return [String] # # @!attribute [rw] environment_name # The name of an environment for result list filtering. Proton returns # deployments associated with the environment. # @return [String] # # @!attribute [rw] max_results # The maximum number of deployments to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next deployment in the # array of deployment, after the list of deployment that was # previously requested. # @return [String] # # @!attribute [rw] service_instance_name # The name of a service instance for result list filtering. Proton # returns the deployments associated with the service instance. # @return [String] # # @!attribute [rw] service_name # The name of a service for result list filtering. Proton returns # deployments associated with service instances of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListDeploymentsInput AWS API Documentation # class ListDeploymentsInput < Struct.new( :component_name, :environment_name, :max_results, :next_token, :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployments # An array of deployment with summary data. # @return [Array] # # @!attribute [rw] next_token # A token that indicates the location of the next deployment in the # array of deployment, after the current requested list of deployment. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListDeploymentsOutput AWS API Documentation # class ListDeploymentsOutput < Struct.new( :deployments, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_name # The environment name that's associated with each listed environment # account connection. # @return [String] # # @!attribute [rw] max_results # The maximum number of environment account connections to list. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] requested_by # The type of account making the `ListEnvironmentAccountConnections` # request. # @return [String] # # @!attribute [rw] statuses # The status details for each listed environment account connection. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentAccountConnectionsInput AWS API Documentation # class ListEnvironmentAccountConnectionsInput < Struct.new( :environment_name, :max_results, :next_token, :requested_by, :statuses) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connections # An array of environment account connections with details that's # returned by Proton. # @return [Array] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentAccountConnectionsOutput AWS API Documentation # class ListEnvironmentAccountConnectionsOutput < Struct.new( :environment_account_connections, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment_id # The ID of the deployment whose outputs you want. # @return [String] # # @!attribute [rw] environment_name # The environment name. # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentOutputsInput AWS API Documentation # class ListEnvironmentOutputsInput < Struct.new( :deployment_id, :environment_name, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next environment output # in the array of environment outputs, after the current requested # list of environment outputs. # @return [String] # # @!attribute [rw] outputs # An array of environment outputs with detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentOutputsOutput AWS API Documentation # class ListEnvironmentOutputsOutput < Struct.new( :next_token, :outputs) SENSITIVE = [:outputs] include Aws::Structure end # @!attribute [rw] environment_name # The environment name. # @return [String] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentProvisionedResourcesInput AWS API Documentation # class ListEnvironmentProvisionedResourcesInput < Struct.new( :environment_name, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] provisioned_resources # An array of environment provisioned resources. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentProvisionedResourcesOutput AWS API Documentation # class ListEnvironmentProvisionedResourcesOutput < Struct.new( :next_token, :provisioned_resources) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] major_version # 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`. # @return [String] # # @!attribute [rw] max_results # The maximum number of major or minor versions of an environment # template to list. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] template_name # The name of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplateVersionsInput AWS API Documentation # class ListEnvironmentTemplateVersionsInput < Struct.new( :major_version, :max_results, :next_token, :template_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] template_versions # An array of major or minor versions of an environment template # detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplateVersionsOutput AWS API Documentation # class ListEnvironmentTemplateVersionsOutput < Struct.new( :next_token, :template_versions) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of environment templates to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next environment template # in the array of environment templates, after the list of environment # templates that was previously requested. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplatesInput AWS API Documentation # class ListEnvironmentTemplatesInput < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next environment template # in the array of environment templates, after the current requested # list of environment templates. # @return [String] # # @!attribute [rw] templates # An array of environment templates with detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplatesOutput AWS API Documentation # class ListEnvironmentTemplatesOutput < Struct.new( :next_token, :templates) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_templates # An array of the versions of the environment template. # @return [Array] # # @!attribute [rw] max_results # The maximum number of environments to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next environment in the # array of environments, after the list of environments that was # previously requested. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentsInput AWS API Documentation # class ListEnvironmentsInput < Struct.new( :environment_templates, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environments # An array of environment detail data summaries. # @return [Array] # # @!attribute [rw] next_token # A token that indicates the location of the next environment in the # array of environments, after the current requested list of # environments. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentsOutput AWS API Documentation # class ListEnvironmentsOutput < Struct.new( :environments, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of repositories to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next repository in the # array of repositories, after the list of repositories previously # requested. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListRepositoriesInput AWS API Documentation # class ListRepositoriesInput < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next repository in the # array of repositories, after the current requested list of # repositories. # @return [String] # # @!attribute [rw] repositories # An array of repository links. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListRepositoriesOutput AWS API Documentation # class ListRepositoriesOutput < Struct.new( :next_token, :repositories) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] repository_name # The repository name. # @return [String] # # @!attribute [rw] repository_provider # The repository provider. # @return [String] # # @!attribute [rw] sync_type # The sync type. The only supported value is `TEMPLATE_SYNC`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListRepositorySyncDefinitionsInput AWS API Documentation # class ListRepositorySyncDefinitionsInput < Struct.new( :next_token, :repository_name, :repository_provider, :sync_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next repository sync # definition in the array of repository sync definitions, after the # current requested list of repository sync definitions. # @return [String] # # @!attribute [rw] sync_definitions # An array of repository sync definitions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListRepositorySyncDefinitionsOutput AWS API Documentation # class ListRepositorySyncDefinitionsOutput < Struct.new( :next_token, :sync_definitions) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment_id # The ID of the deployment whose outputs you want. # @return [String] # # @!attribute [rw] next_token # A token that indicates the location of the next output in the array # of outputs, after the list of outputs that was previously requested. # @return [String] # # @!attribute [rw] service_instance_name # The name of the service instance whose outputs you want. # @return [String] # # @!attribute [rw] service_name # The name of the service that `serviceInstanceName` is associated to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceOutputsInput AWS API Documentation # class ListServiceInstanceOutputsInput < Struct.new( :deployment_id, :next_token, :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next output in the array # of outputs, after the current requested list of outputs. # @return [String] # # @!attribute [rw] outputs # An array of service instance Infrastructure as Code (IaC) outputs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceOutputsOutput AWS API Documentation # class ListServiceInstanceOutputsOutput < Struct.new( :next_token, :outputs) SENSITIVE = [:outputs] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] service_instance_name # The name of the service instance whose provisioned resources you # want. # @return [String] # # @!attribute [rw] service_name # The name of the service that `serviceInstanceName` is associated to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceProvisionedResourcesInput AWS API Documentation # class ListServiceInstanceProvisionedResourcesInput < Struct.new( :next_token, :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] provisioned_resources # An array of provisioned resources for a service instance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstanceProvisionedResourcesOutput AWS API Documentation # class ListServiceInstanceProvisionedResourcesOutput < Struct.new( :next_token, :provisioned_resources) SENSITIVE = [] include Aws::Structure end # A filtering criterion to scope down the result list of the # ListServiceInstances action. # # @!attribute [rw] key # The name of a filtering criterion. # @return [String] # # @!attribute [rw] value # A value to filter by. # # With the date/time keys (`*At\{Before,After\}`), the value is a # valid [RFC 3339][1] string with no UTC offset and with an optional # fractional precision (for example, `1985-04-12T23:20:50.52Z`). # # # # [1]: https://datatracker.ietf.org/doc/html/rfc3339.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstancesFilter AWS API Documentation # class ListServiceInstancesFilter < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] 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. # @return [Array] # # @!attribute [rw] max_results # The maximum number of service instances to list. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] service_name # The name of the service that the service instance belongs to. # @return [String] # # @!attribute [rw] sort_by # 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` # @return [String] # # @!attribute [rw] sort_order # Result list sort order. # # Default: `ASCENDING` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstancesInput AWS API Documentation # class ListServiceInstancesInput < Struct.new( :filters, :max_results, :next_token, :service_name, :sort_by, :sort_order) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next service instance in # the array of service instances, after the current requested list of # service instances. # @return [String] # # @!attribute [rw] service_instances # An array of service instances with summary data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstancesOutput AWS API Documentation # class ListServiceInstancesOutput < Struct.new( :next_token, :service_instances) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment_id # The ID of the deployment you want the outputs for. # @return [String] # # @!attribute [rw] next_token # A token that indicates the location of the next output in the array # of outputs, after the list of outputs that was previously requested. # @return [String] # # @!attribute [rw] service_name # The name of the service whose pipeline's outputs you want. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineOutputsInput AWS API Documentation # class ListServicePipelineOutputsInput < Struct.new( :deployment_id, :next_token, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next output in the array # of outputs, after the current requested list of outputs. # @return [String] # # @!attribute [rw] outputs # An array of service pipeline Infrastructure as Code (IaC) outputs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineOutputsOutput AWS API Documentation # class ListServicePipelineOutputsOutput < Struct.new( :next_token, :outputs) SENSITIVE = [:outputs] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] service_name # The name of the service whose pipeline's provisioned resources you # want. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineProvisionedResourcesInput AWS API Documentation # class ListServicePipelineProvisionedResourcesInput < Struct.new( :next_token, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] provisioned_resources # An array of provisioned resources for a service and pipeline. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicePipelineProvisionedResourcesOutput AWS API Documentation # class ListServicePipelineProvisionedResourcesOutput < Struct.new( :next_token, :provisioned_resources) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] major_version # 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`. # @return [String] # # @!attribute [rw] max_results # The maximum number of major or minor versions of a service template # to list. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplateVersionsInput AWS API Documentation # class ListServiceTemplateVersionsInput < Struct.new( :major_version, :max_results, :next_token, :template_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] template_versions # An array of major or minor versions of a service template with # detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplateVersionsOutput AWS API Documentation # class ListServiceTemplateVersionsOutput < Struct.new( :next_token, :template_versions) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of service templates to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next service template in # the array of service templates, after the list of service templates # previously requested. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplatesInput AWS API Documentation # class ListServiceTemplatesInput < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next service template in # the array of service templates, after the current requested list of # service templates. # @return [String] # # @!attribute [rw] templates # An array of service templates with detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplatesOutput AWS API Documentation # class ListServiceTemplatesOutput < Struct.new( :next_token, :templates) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of services to list. # @return [Integer] # # @!attribute [rw] next_token # A token that indicates the location of the next service in the array # of services, after the list of services that was previously # requested. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicesInput AWS API Documentation # class ListServicesInput < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next service in the array # of services, after the current requested list of services. # @return [String] # # @!attribute [rw] services # An array of services with summaries of detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicesOutput AWS API Documentation # class ListServicesOutput < Struct.new( :next_token, :services) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of tags to list. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource for the listed tags. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListTagsForResourceInput AWS API Documentation # class ListTagsForResourceInput < Struct.new( :max_results, :next_token, :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # A token that indicates the location of the next resource tag in the # array of resource tags, after the current requested list of resource # tags. # @return [String] # # @!attribute [rw] tags # A list of resource tags with detail data. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListTagsForResourceOutput AWS API Documentation # class ListTagsForResourceOutput < Struct.new( :next_token, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment_id # The deployment ID for your provisioned resource. # @return [String] # # @!attribute [rw] outputs # The provisioned resource state change detail data that's returned # by Proton. # @return [Array] # # @!attribute [rw] resource_arn # The provisioned resource Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] status # The status of your provisioned resource. # @return [String] # # @!attribute [rw] status_message # The deployment status message for your provisioned resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/NotifyResourceDeploymentStatusChangeInput AWS API Documentation # class NotifyResourceDeploymentStatusChangeInput < Struct.new( :deployment_id, :outputs, :resource_arn, :status, :status_message) SENSITIVE = [:outputs, :status_message] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/NotifyResourceDeploymentStatusChangeOutput AWS API Documentation # class NotifyResourceDeploymentStatusChangeOutput < Aws::EmptyStructure; end # An infrastructure as code defined resource output. # # @!attribute [rw] key # The output key. # @return [String] # # @!attribute [rw] value_string # The output value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Output AWS API Documentation # class Output < Struct.new( :key, :value_string) SENSITIVE = [] include Aws::Structure end # Detail data for a provisioned resource. # # @!attribute [rw] identifier # The provisioned resource identifier. # @return [String] # # @!attribute [rw] name # The provisioned resource name. # @return [String] # # @!attribute [rw] provisioning_engine # 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][1] in the # *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ProvisionedResource AWS API Documentation # class ProvisionedResource < Struct.new( :identifier, :name, :provisioning_engine) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] id # The ID of the environment account connection to reject. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RejectEnvironmentAccountConnectionInput AWS API Documentation # class RejectEnvironmentAccountConnectionInput < Struct.new( :id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connection # The environment connection account detail data that's returned by # Proton. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RejectEnvironmentAccountConnectionOutput AWS API Documentation # class RejectEnvironmentAccountConnectionOutput < Struct.new( :environment_account_connection) SENSITIVE = [] include Aws::Structure end # Detailed data of a linked repository—a repository that has been # registered with Proton. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the linked repository. # @return [String] # # @!attribute [rw] connection_arn # The Amazon Resource Name (ARN) of your AWS CodeStar connection that # connects Proton to your repository provider account. # @return [String] # # @!attribute [rw] encryption_key # Your customer Amazon Web Services KMS encryption key. # @return [String] # # @!attribute [rw] name # The repository name. # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Repository AWS API Documentation # class Repository < Struct.new( :arn, :connection_arn, :encryption_key, :name, :provider) SENSITIVE = [] include Aws::Structure end # Detail data for a linked repository branch. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the linked repository. # @return [String] # # @!attribute [rw] branch # The repository branch. # @return [String] # # @!attribute [rw] name # The repository name. # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RepositoryBranch AWS API Documentation # class RepositoryBranch < Struct.new( :arn, :branch, :name, :provider) SENSITIVE = [] include Aws::Structure end # Detail input data for a linked repository branch. # # @!attribute [rw] branch # The repository branch. # @return [String] # # @!attribute [rw] name # The repository name. # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RepositoryBranchInput AWS API Documentation # class RepositoryBranchInput < Struct.new( :branch, :name, :provider) SENSITIVE = [] include Aws::Structure end # Summary data of a linked repository—a repository that has been # registered with Proton. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the linked repository. # @return [String] # # @!attribute [rw] connection_arn # The Amazon Resource Name (ARN) of the of your connection that # connects Proton to your repository. # @return [String] # # @!attribute [rw] name # The repository name. # @return [String] # # @!attribute [rw] provider # The repository provider. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RepositorySummary AWS API Documentation # class RepositorySummary < Struct.new( :arn, :connection_arn, :name, :provider) SENSITIVE = [] include Aws::Structure end # Detail data for a repository sync attempt activated by a push to a # repository. # # @!attribute [rw] events # Detail data for sync attempt events. # @return [Array] # # @!attribute [rw] started_at # The time when the sync attempt started. # @return [Time] # # @!attribute [rw] status # The sync attempt status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RepositorySyncAttempt AWS API Documentation # class RepositorySyncAttempt < Struct.new( :events, :started_at, :status) SENSITIVE = [] include Aws::Structure end # A repository sync definition. # # @!attribute [rw] branch # The repository branch. # @return [String] # # @!attribute [rw] directory # The directory in the repository. # @return [String] # # @!attribute [rw] parent # The resource that is synced from. # @return [String] # # @!attribute [rw] target # The resource that is synced to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RepositorySyncDefinition AWS API Documentation # class RepositorySyncDefinition < Struct.new( :branch, :directory, :parent, :target) SENSITIVE = [] include Aws::Structure end # Repository sync event detail data for a sync attempt. # # @!attribute [rw] event # Event detail for a repository sync attempt. # @return [String] # # @!attribute [rw] external_id # The external ID of the sync event. # @return [String] # # @!attribute [rw] time # The time that the sync event occurred. # @return [Time] # # @!attribute [rw] type # The type of event. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RepositorySyncEvent AWS API Documentation # class RepositorySyncEvent < Struct.new( :event, :external_id, :time, :type) SENSITIVE = [] include Aws::Structure end # Summary counts of each Proton resource types. # # @!attribute [rw] behind_major # The number of resources of this type in the Amazon Web Services # account that need a major template version update. # @return [Integer] # # @!attribute [rw] behind_minor # The number of resources of this type in the Amazon Web Services # account that need a minor template version update. # @return [Integer] # # @!attribute [rw] failed # The number of resources of this type in the Amazon Web Services # account that failed to deploy. # @return [Integer] # # @!attribute [rw] total # The total number of resources of this type in the Amazon Web # Services account. # @return [Integer] # # @!attribute [rw] up_to_date # The number of resources of this type in the Amazon Web Services # account that are up-to-date with their template. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ResourceCountsSummary AWS API Documentation # class ResourceCountsSummary < Struct.new( :behind_major, :behind_minor, :failed, :total, :up_to_date) SENSITIVE = [] include Aws::Structure end # The requested resource *wasn't* found. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end # Detail data for a resource sync attempt activated by a push to a # repository. # # @!attribute [rw] events # An array of events with detail data. # @return [Array] # # @!attribute [rw] initial_revision # Detail data for the initial repository commit, path and push. # @return [Types::Revision] # # @!attribute [rw] started_at # The time when the sync attempt started. # @return [Time] # # @!attribute [rw] status # The status of the sync attempt. # @return [String] # # @!attribute [rw] target # The resource that is synced to. # @return [String] # # @!attribute [rw] target_revision # Detail data for the target revision. # @return [Types::Revision] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ResourceSyncAttempt AWS API Documentation # class ResourceSyncAttempt < Struct.new( :events, :initial_revision, :started_at, :status, :target, :target_revision) SENSITIVE = [] include Aws::Structure end # Detail data for a resource sync event. # # @!attribute [rw] event # A resource sync event. # @return [String] # # @!attribute [rw] external_id # The external ID for the event. # @return [String] # # @!attribute [rw] time # The time when the event occurred. # @return [Time] # # @!attribute [rw] type # The type of event. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ResourceSyncEvent AWS API Documentation # class ResourceSyncEvent < Struct.new( :event, :external_id, :time, :type) SENSITIVE = [] include Aws::Structure end # Revision detail data for a commit and push that activates a sync # attempt # # @!attribute [rw] branch # The repository branch. # @return [String] # # @!attribute [rw] directory # The repository directory changed by a commit and push that activated # the sync attempt. # @return [String] # # @!attribute [rw] repository_name # The repository name. # @return [String] # # @!attribute [rw] repository_provider # The repository provider. # @return [String] # # @!attribute [rw] sha # The secure hash algorithm (SHA) hash for the revision. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Revision AWS API Documentation # class Revision < Struct.new( :branch, :directory, :repository_name, :repository_provider, :sha) SENSITIVE = [] include Aws::Structure end # Template bundle S3 bucket data. # # @!attribute [rw] bucket # The name of the S3 bucket that contains a template bundle. # @return [String] # # @!attribute [rw] key # The path to the S3 bucket that contains a template bundle. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/S3ObjectSource AWS API Documentation # class S3ObjectSource < Struct.new( :bucket, :key) SENSITIVE = [] include Aws::Structure end # Detailed data of an Proton service resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] branch_name # The name of the code repository branch that holds the code that's # deployed in Proton. # @return [String] # # @!attribute [rw] created_at # The time when the service was created. # @return [Time] # # @!attribute [rw] description # A description of the service. # @return [String] # # @!attribute [rw] last_modified_at # The time when the service was last modified. # @return [Time] # # @!attribute [rw] name # The name of the service. # @return [String] # # @!attribute [rw] pipeline # The service pipeline detail data. # @return [Types::ServicePipeline] # # @!attribute [rw] repository_connection_arn # The Amazon Resource Name (ARN) of the repository connection. For # more information, see [Setting up an AWS CodeStar connection][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol # @return [String] # # @!attribute [rw] repository_id # The ID of the source code repository. # @return [String] # # @!attribute [rw] spec # The formatted specification that defines the service. # @return [String] # # @!attribute [rw] status # The status of the service. # @return [String] # # @!attribute [rw] status_message # A service status message. # @return [String] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Service AWS API Documentation # class Service < Struct.new( :arn, :branch_name, :created_at, :description, :last_modified_at, :name, :pipeline, :repository_connection_arn, :repository_id, :spec, :status, :status_message, :template_name) SENSITIVE = [:description, :spec, :status_message] include Aws::Structure end # Detailed data of an Proton service instance resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service instance. # @return [String] # # @!attribute [rw] created_at # The time when the service instance was created. # @return [Time] # # @!attribute [rw] deployment_status # The service instance deployment status. # @return [String] # # @!attribute [rw] deployment_status_message # The message associated with the service instance deployment status. # @return [String] # # @!attribute [rw] environment_name # The name of the environment that the service instance was deployed # into. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this service instance. # @return [String] # # @!attribute [rw] last_client_request_token # The last client request token received. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the service instance was last # attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the service instance was last deployed successfully. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this service instance. # @return [String] # # @!attribute [rw] name # The name of the service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service that the service instance belongs to. # @return [String] # # @!attribute [rw] spec # The service spec that was used to create the service instance. # @return [String] # # @!attribute [rw] template_major_version # The major version of the service template that was used to create # the service instance. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template that was used to create # the service instance. # @return [String] # # @!attribute [rw] template_name # The name of the service template that was used to create the service # instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceInstance AWS API Documentation # class ServiceInstance < Struct.new( :arn, :created_at, :deployment_status, :deployment_status_message, :environment_name, :last_attempted_deployment_id, :last_client_request_token, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_succeeded_deployment_id, :name, :service_name, :spec, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:deployment_status_message, :spec] include Aws::Structure end # The detailed data about the current state of this service instance. # # @!attribute [rw] last_successful_component_deployment_ids # The IDs for the last successful components deployed for this service # instance. # @return [Array] # # @!attribute [rw] last_successful_environment_deployment_id # The ID for the last successful environment deployed for this service # instance. # @return [String] # # @!attribute [rw] last_successful_service_pipeline_deployment_id # The ID for the last successful service pipeline deployed for this # service instance. # @return [String] # # @!attribute [rw] spec # The service spec that was used to create the service instance. # @return [String] # # @!attribute [rw] template_major_version # The major version of the service template that was used to create # the service pipeline. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template that was used to create # the service pipeline. # @return [String] # # @!attribute [rw] template_name # The name of the service template that was used to create the service # instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceInstanceState AWS API Documentation # class ServiceInstanceState < Struct.new( :last_successful_component_deployment_ids, :last_successful_environment_deployment_id, :last_successful_service_pipeline_deployment_id, :spec, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:spec] include Aws::Structure end # Summary data of an Proton service instance resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service instance. # @return [String] # # @!attribute [rw] created_at # The time when the service instance was created. # @return [Time] # # @!attribute [rw] deployment_status # The service instance deployment status. # @return [String] # # @!attribute [rw] deployment_status_message # A service instance deployment status message. # @return [String] # # @!attribute [rw] environment_name # The name of the environment that the service instance was deployed # into. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this service instance. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the service was last attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the service was last deployed successfully. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this service instance. # @return [String] # # @!attribute [rw] name # The name of the service instance. # @return [String] # # @!attribute [rw] service_name # The name of the service that the service instance belongs to. # @return [String] # # @!attribute [rw] template_major_version # The service instance template major version. # @return [String] # # @!attribute [rw] template_minor_version # The service instance template minor version. # @return [String] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceInstanceSummary AWS API Documentation # class ServiceInstanceSummary < Struct.new( :arn, :created_at, :deployment_status, :deployment_status_message, :environment_name, :last_attempted_deployment_id, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_succeeded_deployment_id, :name, :service_name, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:deployment_status_message] include Aws::Structure end # Detailed data of an Proton service instance pipeline resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service pipeline. # @return [String] # # @!attribute [rw] created_at # The time when the service pipeline was created. # @return [Time] # # @!attribute [rw] deployment_status # The deployment status of the service pipeline. # @return [String] # # @!attribute [rw] deployment_status_message # A service pipeline deployment status message. # @return [String] # # @!attribute [rw] last_attempted_deployment_id # The ID of the last attempted deployment of this service pipeline. # @return [String] # # @!attribute [rw] last_deployment_attempted_at # The time when a deployment of the service pipeline was last # attempted. # @return [Time] # # @!attribute [rw] last_deployment_succeeded_at # The time when the service pipeline was last deployed successfully. # @return [Time] # # @!attribute [rw] last_succeeded_deployment_id # The ID of the last successful deployment of this service pipeline. # @return [String] # # @!attribute [rw] spec # The service spec that was used to create the service pipeline. # @return [String] # # @!attribute [rw] template_major_version # The major version of the service template that was used to create # the service pipeline. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template that was used to create # the service pipeline. # @return [String] # # @!attribute [rw] template_name # The name of the service template that was used to create the service # pipeline. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServicePipeline AWS API Documentation # class ServicePipeline < Struct.new( :arn, :created_at, :deployment_status, :deployment_status_message, :last_attempted_deployment_id, :last_deployment_attempted_at, :last_deployment_succeeded_at, :last_succeeded_deployment_id, :spec, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:deployment_status_message, :spec] include Aws::Structure end # The detailed data about the current state of the service pipeline. # # @!attribute [rw] spec # The service spec that was used to create the service pipeline. # @return [String] # # @!attribute [rw] template_major_version # The major version of the service template that was used to create # the service pipeline. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template that was used to create # the service pipeline. # @return [String] # # @!attribute [rw] template_name # The name of the service template that was used to create the service # pipeline. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServicePipelineState AWS API Documentation # class ServicePipelineState < Struct.new( :spec, :template_major_version, :template_minor_version, :template_name) SENSITIVE = [:spec] include Aws::Structure end # A quota was exceeded. For more information, see [Proton Quotas][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end # Summary data of an Proton service resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] created_at # The time when the service was created. # @return [Time] # # @!attribute [rw] description # A description of the service. # @return [String] # # @!attribute [rw] last_modified_at # The time when the service was last modified. # @return [Time] # # @!attribute [rw] name # The name of the service. # @return [String] # # @!attribute [rw] status # The status of the service. # @return [String] # # @!attribute [rw] status_message # A service status message. # @return [String] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceSummary AWS API Documentation # class ServiceSummary < Struct.new( :arn, :created_at, :description, :last_modified_at, :name, :status, :status_message, :template_name) SENSITIVE = [:description, :status_message] include Aws::Structure end # If a service instance is manually updated, Proton wants to prevent # accidentally overriding a manual change. # # A blocker is created because of the manual update or deletion of a # service instance. The summary describes the blocker as being active or # resolved. # # @!attribute [rw] latest_blockers # The latest active blockers for the synced service. # @return [Array] # # @!attribute [rw] service_instance_name # The name of the service instance that you want sync your service # configuration with. # @return [String] # # @!attribute [rw] service_name # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceSyncBlockerSummary AWS API Documentation # class ServiceSyncBlockerSummary < Struct.new( :latest_blockers, :service_instance_name, :service_name) SENSITIVE = [] include Aws::Structure end # Detailed data of the service sync configuration. # # @!attribute [rw] branch # The name of the code repository branch that holds the service code # Proton will sync with. # @return [String] # # @!attribute [rw] file_path # The file path to the service sync configuration file. # @return [String] # # @!attribute [rw] repository_name # The name of the code repository that holds the service code Proton # will sync with. # @return [String] # # @!attribute [rw] repository_provider # The name of the repository provider that holds the repository Proton # will sync with. # @return [String] # # @!attribute [rw] service_name # The name of the service that the service instance is added to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceSyncConfig AWS API Documentation # class ServiceSyncConfig < Struct.new( :branch, :file_path, :repository_name, :repository_provider, :service_name) SENSITIVE = [] include Aws::Structure end # Detailed data of an Proton service template resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service template. # @return [String] # # @!attribute [rw] created_at # The time when the service template was created. # @return [Time] # # @!attribute [rw] description # A description of the service template. # @return [String] # # @!attribute [rw] display_name # The service template name as displayed in the developer interface. # @return [String] # # @!attribute [rw] encryption_key # The customer provided service template encryption key that's used # to encrypt data. # @return [String] # # @!attribute [rw] last_modified_at # The time when the service template was last modified. # @return [Time] # # @!attribute [rw] name # The name of the service template. # @return [String] # # @!attribute [rw] pipeline_provisioning # If `pipelineProvisioning` is `true`, a service pipeline is included # in the service template. Otherwise, a service pipeline *isn't* # included in the service template. # @return [String] # # @!attribute [rw] recommended_version # The recommended version of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplate AWS API Documentation # class ServiceTemplate < Struct.new( :arn, :created_at, :description, :display_name, :encryption_key, :last_modified_at, :name, :pipeline_provisioning, :recommended_version) SENSITIVE = [:description, :display_name] include Aws::Structure end # Summary data of an Proton service template resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service template. # @return [String] # # @!attribute [rw] created_at # The time when the service template was created. # @return [Time] # # @!attribute [rw] description # A description of the service template. # @return [String] # # @!attribute [rw] display_name # The service template name as displayed in the developer interface. # @return [String] # # @!attribute [rw] last_modified_at # The time when the service template was last modified. # @return [Time] # # @!attribute [rw] name # The name of the service template. # @return [String] # # @!attribute [rw] pipeline_provisioning # If `pipelineProvisioning` is `true`, a service pipeline is included # in the service template, otherwise a service pipeline *isn't* # included in the service template. # @return [String] # # @!attribute [rw] recommended_version # The recommended version of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplateSummary AWS API Documentation # class ServiceTemplateSummary < Struct.new( :arn, :created_at, :description, :display_name, :last_modified_at, :name, :pipeline_provisioning, :recommended_version) SENSITIVE = [:description, :display_name] include Aws::Structure end # Detailed data of an Proton service template version resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the version of a service template. # @return [String] # # @!attribute [rw] compatible_environment_templates # An array of compatible environment template names for the major # version of a service template. # @return [Array] # # @!attribute [rw] created_at # The time when the version of a service template was created. # @return [Time] # # @!attribute [rw] description # A description of the version of a service template. # @return [String] # # @!attribute [rw] last_modified_at # The time when the version of a service template was last modified. # @return [Time] # # @!attribute [rw] major_version # The latest major version that's associated with the version of a # service template. # @return [String] # # @!attribute [rw] minor_version # The minor version of a service template. # @return [String] # # @!attribute [rw] recommended_minor_version # The recommended minor version of the service template. # @return [String] # # @!attribute [rw] schema # The schema of the version of a service template. # @return [String] # # @!attribute [rw] status # The service template version status. # @return [String] # # @!attribute [rw] status_message # A service template version status message. # @return [String] # # @!attribute [rw] supported_component_sources # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [Array] # # @!attribute [rw] template_name # The name of the version of a service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplateVersion AWS API Documentation # class ServiceTemplateVersion < Struct.new( :arn, :compatible_environment_templates, :created_at, :description, :last_modified_at, :major_version, :minor_version, :recommended_minor_version, :schema, :status, :status_message, :supported_component_sources, :template_name) SENSITIVE = [:description, :schema, :status_message] include Aws::Structure end # Summary data of an Proton service template version resource. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the version of a service template. # @return [String] # # @!attribute [rw] created_at # The time when the version of a service template was created. # @return [Time] # # @!attribute [rw] description # A description of the version of a service template. # @return [String] # # @!attribute [rw] last_modified_at # The time when the version of a service template was last modified. # @return [Time] # # @!attribute [rw] major_version # The latest major version that's associated with the version of a # service template. # @return [String] # # @!attribute [rw] minor_version # The minor version of a service template. # @return [String] # # @!attribute [rw] recommended_minor_version # The recommended minor version of the service template. # @return [String] # # @!attribute [rw] status # The service template minor version status. # @return [String] # # @!attribute [rw] status_message # A service template minor version status message. # @return [String] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplateVersionSummary AWS API Documentation # class ServiceTemplateVersionSummary < Struct.new( :arn, :created_at, :description, :last_modified_at, :major_version, :minor_version, :recommended_minor_version, :status, :status_message, :template_name) SENSITIVE = [:description, :status_message] include Aws::Structure end # Detailed data of the sync blocker. # # @!attribute [rw] contexts # The contexts for the sync blocker. # @return [Array] # # @!attribute [rw] created_at # The time when the sync blocker was created. # @return [Time] # # @!attribute [rw] created_reason # The reason why the sync blocker was created. # @return [String] # # @!attribute [rw] id # The ID of the sync blocker. # @return [String] # # @!attribute [rw] resolved_at # The time the sync blocker was resolved. # @return [Time] # # @!attribute [rw] resolved_reason # The reason the sync blocker was resolved. # @return [String] # # @!attribute [rw] status # The status of the sync blocker. # @return [String] # # @!attribute [rw] type # The type of the sync blocker. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/SyncBlocker AWS API Documentation # class SyncBlocker < Struct.new( :contexts, :created_at, :created_reason, :id, :resolved_at, :resolved_reason, :status, :type) SENSITIVE = [] include Aws::Structure end # Detailed data of the context of the sync blocker. # # @!attribute [rw] key # The key for the sync blocker context. # @return [String] # # @!attribute [rw] value # The value of the sync blocker context. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/SyncBlockerContext AWS API Documentation # class SyncBlockerContext < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # A description of a resource tag. # # @!attribute [rw] key # The key of the resource tag. # @return [String] # # @!attribute [rw] value # The value of the resource tag. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Tag AWS API Documentation # class Tag < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the Proton resource to apply # customer tags to. # @return [String] # # @!attribute [rw] tags # A list of customer tags to apply to the Proton resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TagResourceInput AWS API Documentation # class TagResourceInput < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TagResourceOutput AWS API Documentation # class TagResourceOutput < Aws::EmptyStructure; end # The detail data for a template sync configuration. # # @!attribute [rw] branch # The repository branch. # @return [String] # # @!attribute [rw] repository_name # The repository name (for example, `myrepos/myrepo`). # @return [String] # # @!attribute [rw] repository_provider # The repository provider. # @return [String] # # @!attribute [rw] subdirectory # A subdirectory path to your template bundle version. # @return [String] # # @!attribute [rw] template_name # The template name. # @return [String] # # @!attribute [rw] template_type # The template type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TemplateSyncConfig AWS API Documentation # class TemplateSyncConfig < Struct.new( :branch, :repository_name, :repository_provider, :subdirectory, :template_name, :template_type) SENSITIVE = [] include Aws::Structure end # Template version source data. # # @note TemplateVersionSourceInput is a union - when making an API calls you must set exactly one of the members. # # @!attribute [rw] s3 # An S3 source object that includes the template bundle S3 path and # name for a template minor version. # @return [Types::S3ObjectSource] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TemplateVersionSourceInput AWS API Documentation # class TemplateVersionSourceInput < Struct.new( :s3, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class S3 < TemplateVersionSourceInput; end class Unknown < TemplateVersionSourceInput; end end # The request was denied due to request throttling. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ThrottlingException AWS API Documentation # class ThrottlingException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to remove customer # tags from. # @return [String] # # @!attribute [rw] tag_keys # A list of customer tag keys that indicate the customer tags to be # removed from the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UntagResourceInput AWS API Documentation # class UntagResourceInput < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UntagResourceOutput AWS API Documentation # class UntagResourceOutput < Aws::EmptyStructure; end # @!attribute [rw] delete_pipeline_provisioning_repository # 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. # @return [Boolean] # # @!attribute [rw] pipeline_codebuild_role_arn # The Amazon Resource Name (ARN) of the service role you want to use # for provisioning pipelines. Proton assumes this role for # CodeBuild-based provisioning. # @return [String] # # @!attribute [rw] pipeline_provisioning_repository # 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`. # @return [Types::RepositoryBranchInput] # # @!attribute [rw] pipeline_service_role_arn # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateAccountSettingsInput AWS API Documentation # class UpdateAccountSettingsInput < Struct.new( :delete_pipeline_provisioning_repository, :pipeline_codebuild_role_arn, :pipeline_provisioning_repository, :pipeline_service_role_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] account_settings # The Proton pipeline service role and repository data shared across # the Amazon Web Services account. # @return [Types::AccountSettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateAccountSettingsOutput AWS API Documentation # class UpdateAccountSettingsOutput < Struct.new( :account_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # The client token for the updated component. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] deployment_type # 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. # @return [String] # # @!attribute [rw] description # An optional customer-provided description of the component. # @return [String] # # @!attribute [rw] name # The name of the component to update. # @return [String] # # @!attribute [rw] service_instance_name # 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. # @return [String] # # @!attribute [rw] service_name # 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. # @return [String] # # @!attribute [rw] service_spec # 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. # @return [String] # # @!attribute [rw] template_file # 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. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateComponentInput AWS API Documentation # class UpdateComponentInput < Struct.new( :client_token, :deployment_type, :description, :name, :service_instance_name, :service_name, :service_spec, :template_file) SENSITIVE = [:description, :service_spec, :template_file] include Aws::Structure end # @!attribute [rw] component # The detailed data of the updated component. # @return [Types::Component] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateComponentOutput AWS API Documentation # class UpdateComponentOutput < Struct.new( :component) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] codebuild_role_arn # 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. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] id # The ID of the environment account connection to update. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the IAM service role that's # associated with the environment account connection to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentAccountConnectionInput AWS API Documentation # class UpdateEnvironmentAccountConnectionInput < Struct.new( :codebuild_role_arn, :component_role_arn, :id, :role_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] environment_account_connection # The environment account connection detail data that's returned by # Proton. # @return [Types::EnvironmentAccountConnection] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentAccountConnectionOutput AWS API Documentation # class UpdateEnvironmentAccountConnectionOutput < Struct.new( :environment_account_connection) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] codebuild_role_arn # The Amazon Resource Name (ARN) of the IAM service role that allows # Proton to provision infrastructure using CodeBuild-based # provisioning on your behalf. # @return [String] # # @!attribute [rw] component_role_arn # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [String] # # @!attribute [rw] deployment_type # 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). # @return [String] # # @!attribute [rw] description # A description of the environment update. # @return [String] # # @!attribute [rw] environment_account_connection_id # 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. # @return [String] # # @!attribute [rw] name # The name of the environment to update. # @return [String] # # @!attribute [rw] proton_service_role_arn # The Amazon Resource Name (ARN) of the Proton service role that # allows Proton to make API calls to other services your behalf. # @return [String] # # @!attribute [rw] provisioning_repository # 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. # @return [Types::RepositoryBranchInput] # # @!attribute [rw] spec # The formatted specification that defines the update. # @return [String] # # @!attribute [rw] template_major_version # The major version of the environment to update. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the environment to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentInput AWS API Documentation # class UpdateEnvironmentInput < Struct.new( :codebuild_role_arn, :component_role_arn, :deployment_type, :description, :environment_account_connection_id, :name, :proton_service_role_arn, :provisioning_repository, :spec, :template_major_version, :template_minor_version) SENSITIVE = [:description, :spec] include Aws::Structure end # @!attribute [rw] environment # The environment detail data that's returned by Proton. # @return [Types::Environment] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentOutput AWS API Documentation # class UpdateEnvironmentOutput < Struct.new( :environment) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] description # A description of the environment template update. # @return [String] # # @!attribute [rw] display_name # The name of the environment template to update as displayed in the # developer interface. # @return [String] # # @!attribute [rw] name # The name of the environment template to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateInput AWS API Documentation # class UpdateEnvironmentTemplateInput < Struct.new( :description, :display_name, :name) SENSITIVE = [:description, :display_name] include Aws::Structure end # @!attribute [rw] environment_template # The environment template detail data that's returned by Proton. # @return [Types::EnvironmentTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateOutput AWS API Documentation # class UpdateEnvironmentTemplateOutput < Struct.new( :environment_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] description # A description of environment template version to update. # @return [String] # # @!attribute [rw] major_version # To update a major version of an environment template, include `major # Version`. # @return [String] # # @!attribute [rw] minor_version # To update a minor version of an environment template, include # `minorVersion`. # @return [String] # # @!attribute [rw] status # The status of the environment template minor version to update. # @return [String] # # @!attribute [rw] template_name # The name of the environment template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateVersionInput AWS API Documentation # class UpdateEnvironmentTemplateVersionInput < Struct.new( :description, :major_version, :minor_version, :status, :template_name) SENSITIVE = [:description] include Aws::Structure end # @!attribute [rw] environment_template_version # The environment template version detail data that's returned by # Proton. # @return [Types::EnvironmentTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateVersionOutput AWS API Documentation # class UpdateEnvironmentTemplateVersionOutput < Struct.new( :environment_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] description # The edited service description. # @return [String] # # @!attribute [rw] name # The name of the service to edit. # @return [String] # # @!attribute [rw] 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][1] # in the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInput AWS API Documentation # class UpdateServiceInput < Struct.new( :description, :name, :spec) SENSITIVE = [:description, :spec] include Aws::Structure end # @!attribute [rw] client_token # The client token of the service instance to update. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] deployment_type # 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. # @return [String] # # @!attribute [rw] name # The name of the service instance to update. # @return [String] # # @!attribute [rw] service_name # The name of the service that the service instance belongs to. # @return [String] # # @!attribute [rw] spec # The formatted specification that defines the service instance # update. # @return [String] # # @!attribute [rw] template_major_version # The major version of the service template to update. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInstanceInput AWS API Documentation # class UpdateServiceInstanceInput < Struct.new( :client_token, :deployment_type, :name, :service_name, :spec, :template_major_version, :template_minor_version) SENSITIVE = [:spec] include Aws::Structure end # @!attribute [rw] service_instance # The service instance summary data that's returned by Proton. # @return [Types::ServiceInstance] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInstanceOutput AWS API Documentation # class UpdateServiceInstanceOutput < Struct.new( :service_instance) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service # The service detail data that's returned by Proton. # @return [Types::Service] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceOutput AWS API Documentation # class UpdateServiceOutput < Struct.new( :service) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] deployment_type # 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. # @return [String] # # @!attribute [rw] service_name # The name of the service to that the pipeline is associated with. # @return [String] # # @!attribute [rw] spec # The spec for the service pipeline to update. # @return [String] # # @!attribute [rw] template_major_version # The major version of the service template that was used to create # the service that the pipeline is associated with. # @return [String] # # @!attribute [rw] template_minor_version # The minor version of the service template that was used to create # the service that the pipeline is associated with. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServicePipelineInput AWS API Documentation # class UpdateServicePipelineInput < Struct.new( :deployment_type, :service_name, :spec, :template_major_version, :template_minor_version) SENSITIVE = [:spec] include Aws::Structure end # @!attribute [rw] pipeline # The pipeline details that are returned by Proton. # @return [Types::ServicePipeline] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServicePipelineOutput AWS API Documentation # class UpdateServicePipelineOutput < Struct.new( :pipeline) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] id # The ID of the service sync blocker. # @return [String] # # @!attribute [rw] resolved_reason # The reason the service sync blocker was resolved. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceSyncBlockerInput AWS API Documentation # class UpdateServiceSyncBlockerInput < Struct.new( :id, :resolved_reason) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_instance_name # The name of the service instance that you want to update the service # sync blocker for. # @return [String] # # @!attribute [rw] service_name # The name of the service that you want to update the service sync # blocker for. # @return [String] # # @!attribute [rw] service_sync_blocker # The detailed data on the service sync blocker that was updated. # @return [Types::SyncBlocker] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceSyncBlockerOutput AWS API Documentation # class UpdateServiceSyncBlockerOutput < Struct.new( :service_instance_name, :service_name, :service_sync_blocker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] branch # The name of the code repository branch where the Proton Ops file is # found. # @return [String] # # @!attribute [rw] file_path # The path to the Proton Ops file. # @return [String] # # @!attribute [rw] repository_name # The name of the repository where the Proton Ops file is found. # @return [String] # # @!attribute [rw] repository_provider # The name of the repository provider where the Proton Ops file is # found. # @return [String] # # @!attribute [rw] service_name # The name of the service the Proton Ops file is for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceSyncConfigInput AWS API Documentation # class UpdateServiceSyncConfigInput < Struct.new( :branch, :file_path, :repository_name, :repository_provider, :service_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_sync_config # The detailed data of the Proton Ops file. # @return [Types::ServiceSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceSyncConfigOutput AWS API Documentation # class UpdateServiceSyncConfigOutput < Struct.new( :service_sync_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] description # A description of the service template update. # @return [String] # # @!attribute [rw] display_name # The name of the service template to update that's displayed in the # developer interface. # @return [String] # # @!attribute [rw] name # The name of the service template to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateInput AWS API Documentation # class UpdateServiceTemplateInput < Struct.new( :description, :display_name, :name) SENSITIVE = [:description, :display_name] include Aws::Structure end # @!attribute [rw] service_template # The service template detail data that's returned by Proton. # @return [Types::ServiceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateOutput AWS API Documentation # class UpdateServiceTemplateOutput < Struct.new( :service_template) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] compatible_environment_templates # 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. # @return [Array] # # @!attribute [rw] description # A description of a service template version to update. # @return [String] # # @!attribute [rw] major_version # To update a major version of a service template, include `major # Version`. # @return [String] # # @!attribute [rw] minor_version # To update a minor version of a service template, include # `minorVersion`. # @return [String] # # @!attribute [rw] status # The status of the service template minor version to update. # @return [String] # # @!attribute [rw] supported_component_sources # 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][1] in # the *Proton User Guide*. # # # # [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html # @return [Array] # # @!attribute [rw] template_name # The name of the service template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersionInput AWS API Documentation # class UpdateServiceTemplateVersionInput < Struct.new( :compatible_environment_templates, :description, :major_version, :minor_version, :status, :supported_component_sources, :template_name) SENSITIVE = [:description] include Aws::Structure end # @!attribute [rw] service_template_version # The service template version detail data that's returned by Proton. # @return [Types::ServiceTemplateVersion] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersionOutput AWS API Documentation # class UpdateServiceTemplateVersionOutput < Struct.new( :service_template_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] branch # The repository branch for your template. # @return [String] # # @!attribute [rw] repository_name # The repository name (for example, `myrepos/myrepo`). # @return [String] # # @!attribute [rw] repository_provider # The repository provider. # @return [String] # # @!attribute [rw] subdirectory # A subdirectory path to your template bundle version. When included, # limits the template bundle search to this repository directory. # @return [String] # # @!attribute [rw] template_name # The synced template name. # @return [String] # # @!attribute [rw] template_type # The synced template type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateTemplateSyncConfigInput AWS API Documentation # class UpdateTemplateSyncConfigInput < Struct.new( :branch, :repository_name, :repository_provider, :subdirectory, :template_name, :template_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_sync_config # The template sync configuration detail data that's returned by # Proton. # @return [Types::TemplateSyncConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateTemplateSyncConfigOutput AWS API Documentation # class UpdateTemplateSyncConfigOutput < Struct.new( :template_sync_config) SENSITIVE = [] include Aws::Structure end # The input is invalid or an out-of-range value was supplied for the # input parameter. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ValidationException AWS API Documentation # class ValidationException < Struct.new( :message) SENSITIVE = [:message] include Aws::Structure end end end