Class SourceAwsConfiguration

java.lang.Object
software.amazon.awssdk.services.devopsagent.model.SourceAwsConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SourceAwsConfiguration.Builder,SourceAwsConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SourceAwsConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SourceAwsConfiguration.Builder,SourceAwsConfiguration>

Configuration for AWS source account integration. Setting the role ARNs on this configuration requires the caller to have at least the iam:PassRole permission (see assumableRoleArn).

See Also:

  • Method Details

    • accountId

      public final String accountId()

      AWS Account Id corresponding to provided resources.

      Returns:
      AWS Account Id corresponding to provided resources.

    • accountType

      public final SourceAccountType accountType()

      Account Type 'source' for AIDevOps monitoring.

      If the service returns an enum value that is not available in the current SDK version, accountType will return SourceAccountType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountTypeAsString().

      Returns:
      Account Type 'source' for AIDevOps monitoring.
      See Also:

    • accountTypeAsString

      public final String accountTypeAsString()

      Account Type 'source' for AIDevOps monitoring.

      If the service returns an enum value that is not available in the current SDK version, accountType will return SourceAccountType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountTypeAsString().

      Returns:
      Account Type 'source' for AIDevOps monitoring.
      See Also:

    • assumableRoleArn

      public final String assumableRoleArn()

      Role ARN to be assumed by AIDevOps to operate on behalf of customer. To set this role ARN on AssociateService or UpdateAssociation, the caller must have at least the iam:PassRole permission on arn:aws:iam::<account-id>:role/* in the caller's own account, with the condition iam:PassedToService set to aidevops.amazonaws.com. A broader iam:PassRole grant also satisfies this requirement.

      Returns:
      Role ARN to be assumed by AIDevOps to operate on behalf of customer. To set this role ARN on AssociateService or UpdateAssociation, the caller must have at least the iam:PassRole permission on arn:aws:iam::<account-id>:role/* in the caller's own account, with the condition iam:PassedToService set to aidevops.amazonaws.com. A broader iam:PassRole grant also satisfies this requirement.

    • externalId

      public final String externalId()

      External ID for additional security when assuming the role. Used to prevent the confused deputy problem.

      Returns:
      External ID for additional security when assuming the role. Used to prevent the confused deputy problem.

    • agentElevatedRoleArn

      public final String agentElevatedRoleArn()

      Optional IAM role ARN to be assumed by AIDevOps for elevated directed actions on behalf of the customer. Used for mutating operations gated by elevatedActionsEnabled on the AgentSpace. When not provided, only non-elevated directed actions are available for this AWS account. Setting this role is subject to the same minimum iam:PassRole requirement described on assumableRoleArn.

      Returns:
      Optional IAM role ARN to be assumed by AIDevOps for elevated directed actions on behalf of the customer. Used for mutating operations gated by elevatedActionsEnabled on the AgentSpace. When not provided, only non-elevated directed actions are available for this AWS account. Setting this role is subject to the same minimum iam:PassRole requirement described on assumableRoleArn.

    • agentElevatedRoleArnStatus

      public final ValidationStatus agentElevatedRoleArnStatus()

      Validation status of the agentElevatedRoleArn. Updated asynchronously after the customer registers an elevated role. Possible values: PENDING_CONFIRMATION (validation in progress), VALID (role validated), INVALID (validation failed).

      If the service returns an enum value that is not available in the current SDK version, agentElevatedRoleArnStatus will return ValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentElevatedRoleArnStatusAsString().

      Returns:
      Validation status of the agentElevatedRoleArn. Updated asynchronously after the customer registers an elevated role. Possible values: PENDING_CONFIRMATION (validation in progress), VALID (role validated), INVALID (validation failed).
      See Also:

    • agentElevatedRoleArnStatusAsString

      public final String agentElevatedRoleArnStatusAsString()

      Validation status of the agentElevatedRoleArn. Updated asynchronously after the customer registers an elevated role. Possible values: PENDING_CONFIRMATION (validation in progress), VALID (role validated), INVALID (validation failed).

      If the service returns an enum value that is not available in the current SDK version, agentElevatedRoleArnStatus will return ValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentElevatedRoleArnStatusAsString().

      Returns:
      Validation status of the agentElevatedRoleArn. Updated asynchronously after the customer registers an elevated role. Possible values: PENDING_CONFIRMATION (validation in progress), VALID (role validated), INVALID (validation failed).
      See Also:

    • toBuilder

      public SourceAwsConfiguration.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<SourceAwsConfiguration.Builder,SourceAwsConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SourceAwsConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.