| 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.CreateEnvironmentAccountConnection
Description
Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton User guide.
Synopsis
- data CreateEnvironmentAccountConnection = CreateEnvironmentAccountConnection' {
- clientToken :: Maybe Text
- codebuildRoleArn :: Maybe Text
- componentRoleArn :: Maybe Text
- roleArn :: Maybe Text
- tags :: Maybe [Tag]
- environmentName :: Text
- managementAccountId :: Text
- newCreateEnvironmentAccountConnection :: Text -> Text -> CreateEnvironmentAccountConnection
- createEnvironmentAccountConnection_clientToken :: Lens' CreateEnvironmentAccountConnection (Maybe Text)
- createEnvironmentAccountConnection_codebuildRoleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text)
- createEnvironmentAccountConnection_componentRoleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text)
- createEnvironmentAccountConnection_roleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text)
- createEnvironmentAccountConnection_tags :: Lens' CreateEnvironmentAccountConnection (Maybe [Tag])
- createEnvironmentAccountConnection_environmentName :: Lens' CreateEnvironmentAccountConnection Text
- createEnvironmentAccountConnection_managementAccountId :: Lens' CreateEnvironmentAccountConnection Text
- data CreateEnvironmentAccountConnectionResponse = CreateEnvironmentAccountConnectionResponse' {}
- newCreateEnvironmentAccountConnectionResponse :: Int -> EnvironmentAccountConnection -> CreateEnvironmentAccountConnectionResponse
- createEnvironmentAccountConnectionResponse_httpStatus :: Lens' CreateEnvironmentAccountConnectionResponse Int
- createEnvironmentAccountConnectionResponse_environmentAccountConnection :: Lens' CreateEnvironmentAccountConnectionResponse EnvironmentAccountConnection
Creating a Request
data CreateEnvironmentAccountConnection Source #
See: newCreateEnvironmentAccountConnection smart constructor.
Constructors
| CreateEnvironmentAccountConnection' | |
Fields
| |
Instances
newCreateEnvironmentAccountConnection Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateEnvironmentAccountConnection |
Create a value of CreateEnvironmentAccountConnection 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:clientToken:CreateEnvironmentAccountConnection', createEnvironmentAccountConnection_clientToken - When included, if two identical requests are made with the same client
token, Proton returns the environment account connection that the first
request created.
CreateEnvironmentAccountConnection, createEnvironmentAccountConnection_codebuildRoleArn - 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.
CreateEnvironmentAccountConnection, createEnvironmentAccountConnection_componentRoleArn - 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 in the Proton User Guide.
CreateEnvironmentAccountConnection, createEnvironmentAccountConnection_roleArn - The Amazon Resource Name (ARN) of the IAM service role that's created
in the environment account. Proton uses this role to provision
infrastructure resources in the associated environment account.
$sel:tags:CreateEnvironmentAccountConnection', createEnvironmentAccountConnection_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 in the Proton User Guide.
CreateEnvironmentAccountConnection, createEnvironmentAccountConnection_environmentName - The name of the Proton environment that's created in the associated
management account.
CreateEnvironmentAccountConnection, createEnvironmentAccountConnection_managementAccountId - 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.
Request Lenses
createEnvironmentAccountConnection_clientToken :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #
When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
createEnvironmentAccountConnection_codebuildRoleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #
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.
createEnvironmentAccountConnection_componentRoleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #
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 in the Proton User Guide.
createEnvironmentAccountConnection_roleArn :: Lens' CreateEnvironmentAccountConnection (Maybe Text) Source #
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.
createEnvironmentAccountConnection_tags :: Lens' CreateEnvironmentAccountConnection (Maybe [Tag]) Source #
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 in the Proton User Guide.
createEnvironmentAccountConnection_environmentName :: Lens' CreateEnvironmentAccountConnection Text Source #
The name of the Proton environment that's created in the associated management account.
createEnvironmentAccountConnection_managementAccountId :: Lens' CreateEnvironmentAccountConnection Text Source #
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.
Destructuring the Response
data CreateEnvironmentAccountConnectionResponse Source #
See: newCreateEnvironmentAccountConnectionResponse smart constructor.
Constructors
| CreateEnvironmentAccountConnectionResponse' | |
Fields
| |
Instances
newCreateEnvironmentAccountConnectionResponse Source #
Arguments
| :: Int | |
| -> EnvironmentAccountConnection |
|
| -> CreateEnvironmentAccountConnectionResponse |
Create a value of CreateEnvironmentAccountConnectionResponse 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:httpStatus:CreateEnvironmentAccountConnectionResponse', createEnvironmentAccountConnectionResponse_httpStatus - The response's http status code.
$sel:environmentAccountConnection:CreateEnvironmentAccountConnectionResponse', createEnvironmentAccountConnectionResponse_environmentAccountConnection - The environment account connection detail data that's returned by
Proton.
Response Lenses
createEnvironmentAccountConnectionResponse_httpStatus :: Lens' CreateEnvironmentAccountConnectionResponse Int Source #
The response's http status code.
createEnvironmentAccountConnectionResponse_environmentAccountConnection :: Lens' CreateEnvironmentAccountConnectionResponse EnvironmentAccountConnection Source #
The environment account connection detail data that's returned by Proton.