Package software.amazon.awssdk.services.proton.model

Interface Environment.Builder

    • Method Detail

      • arn

        Environment.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the environment.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • codebuildRoleArn

        Environment.Builder codebuildRoleArn​(String codebuildRoleArn)

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

        Parameters:
        codebuildRoleArn - The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • componentRoleArn

        Environment.Builder componentRoleArn​(String componentRoleArn)

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

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

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

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        Environment.Builder createdAt​(Instant createdAt)

        The time when the environment was created.

        Parameters:
        createdAt - The time when the environment was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deploymentStatus

        Environment.Builder deploymentStatus​(String deploymentStatus)

        The environment deployment status.

        Parameters:
        deploymentStatus - The environment deployment status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DeploymentStatus, DeploymentStatus

      • deploymentStatusMessage

        Environment.Builder deploymentStatusMessage​(String deploymentStatusMessage)

        An environment deployment status message.

        Parameters:
        deploymentStatusMessage - An environment deployment status message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        Environment.Builder description​(String description)

        The description of the environment.

        Parameters:
        description - The description of the environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentAccountConnectionId

        Environment.Builder environmentAccountConnectionId​(String environmentAccountConnectionId)

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

        Parameters:
        environmentAccountConnectionId - The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentAccountId

        Environment.Builder environmentAccountId​(String environmentAccountId)

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

        Parameters:
        environmentAccountId - The ID of the environment account that the environment infrastructure resources are provisioned in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastAttemptedDeploymentId

        Environment.Builder lastAttemptedDeploymentId​(String lastAttemptedDeploymentId)

        The ID of the last attempted deployment of this environment.

        Parameters:
        lastAttemptedDeploymentId - The ID of the last attempted deployment of this environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastDeploymentAttemptedAt

        Environment.Builder lastDeploymentAttemptedAt​(Instant lastDeploymentAttemptedAt)

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

        Parameters:
        lastDeploymentAttemptedAt - The time when a deployment of the environment was last attempted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastDeploymentSucceededAt

        Environment.Builder lastDeploymentSucceededAt​(Instant lastDeploymentSucceededAt)

        The time when the environment was last deployed successfully.

        Parameters:
        lastDeploymentSucceededAt - The time when the environment was last deployed successfully.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastSucceededDeploymentId

        Environment.Builder lastSucceededDeploymentId​(String lastSucceededDeploymentId)

        The ID of the last successful deployment of this environment.

        Parameters:
        lastSucceededDeploymentId - The ID of the last successful deployment of this environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        Environment.Builder name​(String name)

        The name of the environment.

        Parameters:
        name - The name of the environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • protonServiceRoleArn

        Environment.Builder protonServiceRoleArn​(String protonServiceRoleArn)

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

        Parameters:
        protonServiceRoleArn - The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • provisioning

        Environment.Builder provisioning​(String provisioning)

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

        Parameters:
        provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Provisioning, Provisioning

      • provisioning

        Environment.Builder provisioning​(Provisioning provisioning)

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

        Parameters:
        provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Provisioning, Provisioning

      • provisioningRepository

        Environment.Builder provisioningRepository​(RepositoryBranch provisioningRepository)

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

        Parameters:
        provisioningRepository - The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • spec

        Environment.Builder spec​(String spec)

        The environment spec.

        Parameters:
        spec - The environment spec.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateMajorVersion

        Environment.Builder templateMajorVersion​(String templateMajorVersion)

        The major version of the environment template.

        Parameters:
        templateMajorVersion - The major version of the environment template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateMinorVersion

        Environment.Builder templateMinorVersion​(String templateMinorVersion)

        The minor version of the environment template.

        Parameters:
        templateMinorVersion - The minor version of the environment template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateName

        Environment.Builder templateName​(String templateName)

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

        Parameters:
        templateName - The Amazon Resource Name (ARN) of the environment template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.