software.amazon.awssdk.services.appfabric.model

Interface AppAuthorization.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AppAuthorization.Builder,AppAuthorization>, SdkBuilder<AppAuthorization.Builder,AppAuthorization>, SdkPojo

Enclosing class:

AppAuthorization

public static interface AppAuthorization.Builder
extends SdkPojo, CopyableBuilder<AppAuthorization.Builder,AppAuthorization>

Method Summary

Modifier and Type	Method and Description
AppAuthorization.Builder	app(String app) The name of the application.
AppAuthorization.Builder	appAuthorizationArn(String appAuthorizationArn) The Amazon Resource Name (ARN) of the app authorization.
AppAuthorization.Builder	appBundleArn(String appBundleArn) The Amazon Resource Name (ARN) of the app bundle for the app authorization.
AppAuthorization.Builder	authType(AuthType authType) The authorization type.
AppAuthorization.Builder	authType(String authType) The authorization type.
AppAuthorization.Builder	authUrl(String authUrl) The application URL for the OAuth flow.
AppAuthorization.Builder	createdAt(Instant createdAt) The timestamp of when the app authorization was created.
AppAuthorization.Builder	persona(Persona persona) The user persona of the app authorization.
AppAuthorization.Builder	persona(String persona) The user persona of the app authorization.
AppAuthorization.Builder	status(AppAuthorizationStatus status) The state of the app authorization.
AppAuthorization.Builder	status(String status) The state of the app authorization.
default AppAuthorization.Builder	tenant(Consumer<Tenant.Builder> tenant) Contains information about an application tenant, such as the application display name and identifier.
AppAuthorization.Builder	tenant(Tenant tenant) Contains information about an application tenant, such as the application display name and identifier.
AppAuthorization.Builder	updatedAt(Instant updatedAt) The timestamp of when the app authorization was last updated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

appAuthorizationArn

AppAuthorization.Builder appAuthorizationArn(String appAuthorizationArn)

The Amazon Resource Name (ARN) of the app authorization.

Parameters:

appAuthorizationArn - The Amazon Resource Name (ARN) of the app authorization.

Returns:

Returns a reference to this object so that method calls can be chained together.

appBundleArn

AppAuthorization.Builder appBundleArn(String appBundleArn)

The Amazon Resource Name (ARN) of the app bundle for the app authorization.

Parameters:

appBundleArn - The Amazon Resource Name (ARN) of the app bundle for the app authorization.

Returns:

Returns a reference to this object so that method calls can be chained together.

app

AppAuthorization.Builder app(String app)

The name of the application.

Parameters:

app - The name of the application.

Returns:

Returns a reference to this object so that method calls can be chained together.

tenant

AppAuthorization.Builder tenant(Tenant tenant)

Contains information about an application tenant, such as the application display name and identifier.

Parameters:

tenant - Contains information about an application tenant, such as the application display name and identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

tenant

default AppAuthorization.Builder tenant(Consumer<Tenant.Builder> tenant)

Contains information about an application tenant, such as the application display name and identifier.

This is a convenience method that creates an instance of the Tenant.Builder avoiding the need to create one manually via Tenant.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tenant(Tenant).

Parameters:

tenant - a consumer that will call methods on Tenant.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tenant(Tenant)

authType

AppAuthorization.Builder authType(String authType)

The authorization type.

Parameters:

authType - The authorization type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthType, AuthType

authType

AppAuthorization.Builder authType(AuthType authType)

The authorization type.

Parameters:

authType - The authorization type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthType, AuthType

status

AppAuthorization.Builder status(String status)

The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

Parameters:

status - The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppAuthorizationStatus, AppAuthorizationStatus

status

AppAuthorization.Builder status(AppAuthorizationStatus status)

The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

Parameters:

status - The state of the app authorization.

The following states are possible:

• PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.

• Connected: The app authorization is connected to the application, and is ready to be used.

• ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.

• TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AppAuthorizationStatus, AppAuthorizationStatus

createdAt

AppAuthorization.Builder createdAt(Instant createdAt)

The timestamp of when the app authorization was created.

Parameters:

createdAt - The timestamp of when the app authorization was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

AppAuthorization.Builder updatedAt(Instant updatedAt)

The timestamp of when the app authorization was last updated.

Parameters:

updatedAt - The timestamp of when the app authorization was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

persona

AppAuthorization.Builder persona(String persona)

The user persona of the app authorization.

This field should always be admin.

Parameters:

persona - The user persona of the app authorization.

This field should always be admin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Persona, Persona

persona

AppAuthorization.Builder persona(Persona persona)

The user persona of the app authorization.

This field should always be admin.

Parameters:

persona - The user persona of the app authorization.

This field should always be admin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Persona, Persona

authUrl

AppAuthorization.Builder authUrl(String authUrl)

The application URL for the OAuth flow.

Parameters:

authUrl - The application URL for the OAuth flow.

Returns:

Returns a reference to this object so that method calls can be chained together.