Class CreateEnvironmentAccountConnectionRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.proton.model.ProtonRequest
-
- software.amazon.awssdk.services.proton.model.CreateEnvironmentAccountConnectionRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateEnvironmentAccountConnectionRequest.Builder,CreateEnvironmentAccountConnectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEnvironmentAccountConnectionRequest extends ProtonRequest implements ToCopyableBuilder<CreateEnvironmentAccountConnectionRequest.Builder,CreateEnvironmentAccountConnectionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateEnvironmentAccountConnectionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateEnvironmentAccountConnectionRequest.Builderbuilder()StringclientToken()When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.StringcodebuildRoleArn()The Amazon Resource Name (ARN) of an IAM service role in the environment account.StringcomponentRoleArn()The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account.StringenvironmentName()The name of the Proton environment that's created in the associated management account.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringmanagementAccountId()The ID of the management account that accepts or rejects the environment account connection.StringroleArn()The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account.List<SdkField<?>>sdkFields()static Class<? extends CreateEnvironmentAccountConnectionRequest.Builder>serializableBuilderClass()List<Tag>tags()An optional list of metadata items that you can associate with the Proton environment account connection.CreateEnvironmentAccountConnectionRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
clientToken
public final String 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.
- Returns:
- When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
-
codebuildRoleArn
public final String 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.
- Returns:
- 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.
-
componentRoleArn
public final String 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
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.
- Returns:
- 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.
-
environmentName
public final String environmentName()
The name of the Proton environment that's created in the associated management account.
- Returns:
- The name of the Proton environment that's created in the associated management account.
-
managementAccountId
public final String 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.
- Returns:
- 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.
-
roleArn
public final String 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.
- Returns:
- 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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- 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.
-
toBuilder
public CreateEnvironmentAccountConnectionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateEnvironmentAccountConnectionRequest.Builder,CreateEnvironmentAccountConnectionRequest>- Specified by:
toBuilderin classProtonRequest
-
builder
public static CreateEnvironmentAccountConnectionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateEnvironmentAccountConnectionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-