Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Proton.Types.Environment

Description

Synopsis

data Environment = Environment' {
- codebuildRoleArn :: Maybe Text
- componentRoleArn :: Maybe Text
- deploymentStatusMessage :: Maybe (Sensitive Text)
- description :: Maybe (Sensitive Text)
- environmentAccountConnectionId :: Maybe Text
- environmentAccountId :: Maybe Text
- protonServiceRoleArn :: Maybe Text
- provisioning :: Maybe Provisioning
- provisioningRepository :: Maybe RepositoryBranch
- spec :: Maybe (Sensitive Text)
- arn :: Text
- createdAt :: POSIX
- deploymentStatus :: DeploymentStatus
- lastDeploymentAttemptedAt :: POSIX
- lastDeploymentSucceededAt :: POSIX
- name :: Text
- templateMajorVersion :: Text
- templateMinorVersion :: Text
- templateName :: Text
}
newEnvironment :: Text -> UTCTime -> DeploymentStatus -> UTCTime -> UTCTime -> Text -> Text -> Text -> Text -> Environment
environment_codebuildRoleArn :: Lens' Environment (Maybe Text)
environment_componentRoleArn :: Lens' Environment (Maybe Text)
environment_deploymentStatusMessage :: Lens' Environment (Maybe Text)
environment_description :: Lens' Environment (Maybe Text)
environment_environmentAccountConnectionId :: Lens' Environment (Maybe Text)
environment_environmentAccountId :: Lens' Environment (Maybe Text)
environment_protonServiceRoleArn :: Lens' Environment (Maybe Text)
environment_provisioning :: Lens' Environment (Maybe Provisioning)
environment_provisioningRepository :: Lens' Environment (Maybe RepositoryBranch)
environment_spec :: Lens' Environment (Maybe Text)
environment_arn :: Lens' Environment Text
environment_createdAt :: Lens' Environment UTCTime
environment_deploymentStatus :: Lens' Environment DeploymentStatus
environment_lastDeploymentAttemptedAt :: Lens' Environment UTCTime
environment_lastDeploymentSucceededAt :: Lens' Environment UTCTime
environment_name :: Lens' Environment Text
environment_templateMajorVersion :: Lens' Environment Text
environment_templateMinorVersion :: Lens' Environment Text
environment_templateName :: Lens' Environment Text

Documentation

data Environment Source #

Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

See: newEnvironment smart constructor.

Constructors

Environment'

Fields

codebuildRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn :: Maybe Text
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.
deploymentStatusMessage :: Maybe (Sensitive Text)
An environment deployment status message.
description :: Maybe (Sensitive Text)
The description of the environment.
environmentAccountConnectionId :: Maybe Text
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
environmentAccountId :: Maybe Text
The ID of the environment account that the environment infrastructure resources are provisioned in.
protonServiceRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
provisioning :: Maybe Provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
provisioningRepository :: Maybe RepositoryBranch
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.
spec :: Maybe (Sensitive Text)
The environment spec.
arn :: Text
The Amazon Resource Name (ARN) of the environment.
createdAt :: POSIX
The time when the environment was created.
deploymentStatus :: DeploymentStatus
The environment deployment status.
lastDeploymentAttemptedAt :: POSIX
The time when a deployment of the environment was last attempted.
lastDeploymentSucceededAt :: POSIX
The time when the environment was last deployed successfully.
name :: Text
The name of the environment.
templateMajorVersion :: Text
The major version of the environment template.
templateMinorVersion :: Text
The minor version of the environment template.
templateName :: Text
The Amazon Resource Name (ARN) of the environment template.

Instances

Instances details

FromJSON Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment Methods parseJSON :: Value -> Parser Environment # parseJSONList :: Value -> Parser [Environment] #
Generic Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment Associated Types type Rep Environment :: Type -> Type # Methods from :: Environment -> Rep Environment x # to :: Rep Environment x -> Environment #
Show Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
NFData Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment Methods rnf :: Environment -> () #
Eq Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Hashable Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment Methods hashWithSalt :: Int -> Environment -> Int # hash :: Environment -> Int #
type Rep Environment Source #
Instance details Defined in Amazonka.Proton.Types.Environment type Rep Environment = D1 ('MetaData "Environment" "Amazonka.Proton.Types.Environment" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "Environment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "codebuildRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "componentRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deploymentStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "environmentAccountConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environmentAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "protonServiceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "provisioning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Provisioning)) :: S1 ('MetaSel ('Just "provisioningRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RepositoryBranch)))))) :: (((S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentStatus) :: S1 ('MetaSel ('Just "lastDeploymentAttemptedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))) :: ((S1 ('MetaSel ('Just "lastDeploymentSucceededAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "templateMajorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "templateMinorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newEnvironment Source #

Arguments

:: Text	`Environment`
-> UTCTime	`$sel:createdAt:Environment'`
-> DeploymentStatus	`$sel:deploymentStatus:Environment'`
-> UTCTime	`$sel:lastDeploymentAttemptedAt:Environment'`
-> UTCTime	`$sel:lastDeploymentSucceededAt:Environment'`
-> Text	`Environment`
-> Text	`$sel:templateMajorVersion:Environment'`
-> Text	`$sel:templateMinorVersion:Environment'`
-> Text	`$sel:templateName:Environment'`
-> Environment

Create a value of Environment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:codebuildRoleArn:Environment', environment_codebuildRoleArn - The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

$sel:componentRoleArn:Environment', environment_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.

$sel:deploymentStatusMessage:Environment', environment_deploymentStatusMessage - An environment deployment status message.

$sel:description:Environment', environment_description - The description of the environment.

$sel:environmentAccountConnectionId:Environment', environment_environmentAccountConnectionId - The ID of the environment account connection that's used to provision infrastructure resources in an environment account.

$sel:environmentAccountId:Environment', environment_environmentAccountId - The ID of the environment account that the environment infrastructure resources are provisioned in.

$sel:protonServiceRoleArn:Environment', environment_protonServiceRoleArn - The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

$sel:provisioning:Environment', environment_provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.

$sel:provisioningRepository:Environment', environment_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.

$sel:spec:Environment', environment_spec - The environment spec.

Environment, environment_arn - The Amazon Resource Name (ARN) of the environment.

$sel:createdAt:Environment', environment_createdAt - The time when the environment was created.

$sel:deploymentStatus:Environment', environment_deploymentStatus - The environment deployment status.

$sel:lastDeploymentAttemptedAt:Environment', environment_lastDeploymentAttemptedAt - The time when a deployment of the environment was last attempted.

$sel:lastDeploymentSucceededAt:Environment', environment_lastDeploymentSucceededAt - The time when the environment was last deployed successfully.

Environment, environment_name - The name of the environment.

$sel:templateMajorVersion:Environment', environment_templateMajorVersion - The major version of the environment template.

$sel:templateMinorVersion:Environment', environment_templateMinorVersion - The minor version of the environment template.

$sel:templateName:Environment', environment_templateName - The Amazon Resource Name (ARN) of the environment template.

environment_codebuildRoleArn :: Lens' Environment (Maybe Text) Source #

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

environment_componentRoleArn :: Lens' Environment (Maybe Text) Source #

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.

environment_deploymentStatusMessage :: Lens' Environment (Maybe Text) Source #

An environment deployment status message.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

environment_environmentAccountConnectionId :: Lens' Environment (Maybe Text) Source #

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

environment_environmentAccountId :: Lens' Environment (Maybe Text) Source #

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

environment_protonServiceRoleArn :: Lens' Environment (Maybe Text) Source #

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

environment_provisioning :: Lens' Environment (Maybe Provisioning) Source #

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

environment_provisioningRepository :: Lens' Environment (Maybe RepositoryBranch) Source #

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.

environment_spec :: Lens' Environment (Maybe Text) Source #

The environment spec.

environment_arn :: Lens' Environment Text Source #

The Amazon Resource Name (ARN) of the environment.

environment_createdAt :: Lens' Environment UTCTime Source #

The time when the environment was created.

environment_deploymentStatus :: Lens' Environment DeploymentStatus Source #

The environment deployment status.

environment_lastDeploymentAttemptedAt :: Lens' Environment UTCTime Source #

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

environment_lastDeploymentSucceededAt :: Lens' Environment UTCTime Source #

The time when the environment was last deployed successfully.