Package software.amazon.awssdk.services.appsync.model

Class CreateGraphqlApiRequest

    • Method Detail

      • name

        public final String name()

        A user-supplied name for the GraphqlApi.

        Returns:
        A user-supplied name for the GraphqlApi.

      • logConfig

        public final LogConfig logConfig()

        The Amazon CloudWatch Logs configuration.

        Returns:
        The Amazon CloudWatch Logs configuration.

      • authenticationType

        public final AuthenticationType authenticationType()

        The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

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

        Returns:
        The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
        See Also:
        AuthenticationType

      • authenticationTypeAsString

        public final String authenticationTypeAsString()

        The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

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

        Returns:
        The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
        See Also:
        AuthenticationType

      • userPoolConfig

        public final UserPoolConfig userPoolConfig()

        The Amazon Cognito user pool configuration.

        Returns:
        The Amazon Cognito user pool configuration.

      • openIDConnectConfig

        public final OpenIDConnectConfig openIDConnectConfig()

        The OIDC configuration.

        Returns:
        The OIDC configuration.

      • 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 Map<String,​String> tags()

        A TagMap object.

        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:
        A TagMap object.

      • hasAdditionalAuthenticationProviders

        public final boolean hasAdditionalAuthenticationProviders()
        For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders 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.

      • additionalAuthenticationProviders

        public final List<AdditionalAuthenticationProvider> additionalAuthenticationProviders()

        A list of additional authentication providers for the GraphqlApi API.

        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 hasAdditionalAuthenticationProviders() method.

        Returns:
        A list of additional authentication providers for the GraphqlApi API.

      • xrayEnabled

        public final Boolean xrayEnabled()

        A flag indicating whether to use X-Ray tracing for the GraphqlApi.

        Returns:
        A flag indicating whether to use X-Ray tracing for the GraphqlApi.

      • lambdaAuthorizerConfig

        public final LambdaAuthorizerConfig lambdaAuthorizerConfig()

        Configuration for Lambda function authorization.

        Returns:
        Configuration for Lambda function authorization.

      • visibility

        public final GraphQLApiVisibility visibility()

        Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

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

        Returns:
        Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
        See Also:
        GraphQLApiVisibility

      • visibilityAsString

        public final String visibilityAsString()

        Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

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

        Returns:
        Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.
        See Also:
        GraphQLApiVisibility

      • apiType

        public final GraphQLApiType apiType()

        The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

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

        Returns:
        The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
        See Also:
        GraphQLApiType

      • apiTypeAsString

        public final String apiTypeAsString()

        The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

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

        Returns:
        The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
        See Also:
        GraphQLApiType

      • mergedApiExecutionRoleArn

        public final String mergedApiExecutionRoleArn()

        The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

        Returns:
        The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

      • ownerContact

        public final String ownerContact()

        The owner contact information for an API resource.

        This field accepts any string input with a length of 0 - 256 characters.

        Returns:
        The owner contact information for an API resource.

        This field accepts any string input with a length of 0 - 256 characters.

      • 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