create_environment_account_connection
¶
create_environment_account_connection(
management_account_id: AwsAccountId,
environment_name: ResourceName,
*,
config_overrides: Optional[ProtonClientConfig] = None,
client_token: Optional[ClientToken] = None,
role_arn: Optional[RoleArn] = None,
tags: Optional[TagList] = None,
component_role_arn: Optional[RoleArn] = None,
codebuild_role_arn: Optional[RoleArn] = None,
) -> CreateEnvironmentAccountConnectionOutput
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.
Parameters:
-
client_token(Optional[ClientToken], default:None) –When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
-
management_account_id(AwsAccountId) –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.
-
role_arn(Optional[RoleArn], default:None) –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.
-
environment_name(ResourceName) –The name of the Proton environment that's created in the associated management account.
-
tags(Optional[TagList], default:None) –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.
-
component_role_arn(Optional[RoleArn], default:None) –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
componentRoleArnto 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.
-
codebuild_role_arn(Optional[RoleArn], default:None) –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.
Raises:
-
AccessDeniedException–There isn't sufficient access for performing this action.
-
ConflictException–The request couldn't be made due to a conflicting operation or resource.
-
InternalServerException–The request failed to register with the service.
-
ServiceQuotaExceededException–A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input is invalid or an out-of-range value was supplied for the input parameter.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_proton/_services/proton.py
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 | |