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>

  • Method Details

    • 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 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.

      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 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.

    • 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 the isEmpty() 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateEnvironmentAccountConnectionRequest.Builder,CreateEnvironmentAccountConnectionRequest>
      Specified by:
      toBuilder in class ProtonRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEnvironmentAccountConnectionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEnvironmentAccountConnectionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.