Interface AwsAppSyncGraphQlApiDetails.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>,SdkBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>,SdkPojo
- Enclosing class:
- AwsAppSyncGraphQlApiDetails
public static interface AwsAppSyncGraphQlApiDetails.Builder extends SdkPojo, CopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description AwsAppSyncGraphQlApiDetails.BuilderadditionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)A list of additional authentication providers for the GraphQL API.AwsAppSyncGraphQlApiDetails.BuilderadditionalAuthenticationProviders(Consumer<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.Builder>... additionalAuthenticationProviders)A list of additional authentication providers for the GraphQL API.AwsAppSyncGraphQlApiDetails.BuilderadditionalAuthenticationProviders(AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails... additionalAuthenticationProviders)A list of additional authentication providers for the GraphQL API.AwsAppSyncGraphQlApiDetails.BuilderapiId(String apiId)The unique identifier for the API.AwsAppSyncGraphQlApiDetails.Builderarn(String arn)The Amazon Resource Name (ARN) of the API.AwsAppSyncGraphQlApiDetails.BuilderauthenticationType(String authenticationType)The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.AwsAppSyncGraphQlApiDetails.Builderid(String id)The unique identifier for the API.default AwsAppSyncGraphQlApiDetails.BuilderlambdaAuthorizerConfig(Consumer<AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.Builder> lambdaAuthorizerConfig)Specifies the configuration for Lambda function authorization.AwsAppSyncGraphQlApiDetails.BuilderlambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)Specifies the configuration for Lambda function authorization.default AwsAppSyncGraphQlApiDetails.BuilderlogConfig(Consumer<AwsAppSyncGraphQlApiLogConfigDetails.Builder> logConfig)The Amazon CloudWatch Logs configuration.AwsAppSyncGraphQlApiDetails.BuilderlogConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)The Amazon CloudWatch Logs configuration.AwsAppSyncGraphQlApiDetails.Buildername(String name)The API name.default AwsAppSyncGraphQlApiDetails.BuilderopenIdConnectConfig(Consumer<AwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builder> openIdConnectConfig)Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.AwsAppSyncGraphQlApiDetails.BuilderopenIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.default AwsAppSyncGraphQlApiDetails.BuilderuserPoolConfig(Consumer<AwsAppSyncGraphQlApiUserPoolConfigDetails.Builder> userPoolConfig)The Amazon Cognito user pools configuration.AwsAppSyncGraphQlApiDetails.BuilderuserPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)The Amazon Cognito user pools configuration.AwsAppSyncGraphQlApiDetails.BuilderwafWebAclArn(String wafWebAclArn)The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.AwsAppSyncGraphQlApiDetails.BuilderxrayEnabled(Boolean xrayEnabled)Indicates whether to use X-Ray tracing for the GraphQL API.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
apiId
AwsAppSyncGraphQlApiDetails.Builder apiId(String apiId)
The unique identifier for the API.
- Parameters:
apiId- The unique identifier for the API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
id
AwsAppSyncGraphQlApiDetails.Builder id(String id)
The unique identifier for the API.
- Parameters:
id- The unique identifier for the API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openIdConnectConfig
AwsAppSyncGraphQlApiDetails.Builder openIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
- Parameters:
openIdConnectConfig- Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openIdConnectConfig
default AwsAppSyncGraphQlApiDetails.Builder openIdConnectConfig(Consumer<AwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builder> openIdConnectConfig)
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
This is a convenience method that creates an instance of theAwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builderavoiding the need to create one manually viaAwsAppSyncGraphQlApiOpenIdConnectConfigDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toopenIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails).- Parameters:
openIdConnectConfig- a consumer that will call methods onAwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
openIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails)
-
name
AwsAppSyncGraphQlApiDetails.Builder name(String name)
The API name.
- Parameters:
name- The API name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lambdaAuthorizerConfig
AwsAppSyncGraphQlApiDetails.Builder lambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)
Specifies the configuration for Lambda function authorization.
- Parameters:
lambdaAuthorizerConfig- Specifies the configuration for Lambda function authorization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lambdaAuthorizerConfig
default AwsAppSyncGraphQlApiDetails.Builder lambdaAuthorizerConfig(Consumer<AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.Builder> lambdaAuthorizerConfig)
Specifies the configuration for Lambda function authorization.
This is a convenience method that creates an instance of theAwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.Builderavoiding the need to create one manually viaAwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails).- Parameters:
lambdaAuthorizerConfig- a consumer that will call methods onAwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
lambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails)
-
xrayEnabled
AwsAppSyncGraphQlApiDetails.Builder xrayEnabled(Boolean xrayEnabled)
Indicates whether to use X-Ray tracing for the GraphQL API.
- Parameters:
xrayEnabled- Indicates whether to use X-Ray tracing for the GraphQL API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
AwsAppSyncGraphQlApiDetails.Builder arn(String arn)
The Amazon Resource Name (ARN) of the API.
- Parameters:
arn- The Amazon Resource Name (ARN) of the API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userPoolConfig
AwsAppSyncGraphQlApiDetails.Builder userPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)
The Amazon Cognito user pools configuration.
- Parameters:
userPoolConfig- The Amazon Cognito user pools configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userPoolConfig
default AwsAppSyncGraphQlApiDetails.Builder userPoolConfig(Consumer<AwsAppSyncGraphQlApiUserPoolConfigDetails.Builder> userPoolConfig)
The Amazon Cognito user pools configuration.
This is a convenience method that creates an instance of theAwsAppSyncGraphQlApiUserPoolConfigDetails.Builderavoiding the need to create one manually viaAwsAppSyncGraphQlApiUserPoolConfigDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed touserPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails).- Parameters:
userPoolConfig- a consumer that will call methods onAwsAppSyncGraphQlApiUserPoolConfigDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
userPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails)
-
authenticationType
AwsAppSyncGraphQlApiDetails.Builder authenticationType(String authenticationType)
The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- Parameters:
authenticationType- The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logConfig
AwsAppSyncGraphQlApiDetails.Builder logConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)
The Amazon CloudWatch Logs configuration.
- Parameters:
logConfig- The Amazon CloudWatch Logs configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logConfig
default AwsAppSyncGraphQlApiDetails.Builder logConfig(Consumer<AwsAppSyncGraphQlApiLogConfigDetails.Builder> logConfig)
The Amazon CloudWatch Logs configuration.
This is a convenience method that creates an instance of theAwsAppSyncGraphQlApiLogConfigDetails.Builderavoiding the need to create one manually viaAwsAppSyncGraphQlApiLogConfigDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tologConfig(AwsAppSyncGraphQlApiLogConfigDetails).- Parameters:
logConfig- a consumer that will call methods onAwsAppSyncGraphQlApiLogConfigDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
logConfig(AwsAppSyncGraphQlApiLogConfigDetails)
-
additionalAuthenticationProviders
AwsAppSyncGraphQlApiDetails.Builder additionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
- Parameters:
additionalAuthenticationProviders- A list of additional authentication providers for the GraphQL API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalAuthenticationProviders
AwsAppSyncGraphQlApiDetails.Builder additionalAuthenticationProviders(AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails... additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
- Parameters:
additionalAuthenticationProviders- A list of additional authentication providers for the GraphQL API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalAuthenticationProviders
AwsAppSyncGraphQlApiDetails.Builder additionalAuthenticationProviders(Consumer<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.Builder>... additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
This is a convenience method that creates an instance of theAwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.Builderavoiding the need to create one manually viaAwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#additionalAuthenticationProviders(List.) - Parameters:
additionalAuthenticationProviders- a consumer that will call methods onAwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#additionalAuthenticationProviders(java.util.Collection< AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails>)
-
wafWebAclArn
AwsAppSyncGraphQlApiDetails.Builder wafWebAclArn(String wafWebAclArn)
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
- Parameters:
wafWebAclArn- The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-