Package software.amazon.awscdk.services.quicksight

Class CfnOAuthClientApplication

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnOAuthClientApplication
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IOAuthClientApplicationRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-22T17:37:32.283Z") @Stability(Stable) public class CfnOAuthClientApplication extends CfnResource implements IInspectable, IOAuthClientApplicationRef, ITaggableV2
Definition of AWS::QuickSight::OAuthClientApplication Resource Type.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnOAuthClientApplication cfnOAuthClientApplication = CfnOAuthClientApplication.Builder.create(this, "MyCfnOAuthClientApplication")
         .name("name")
         .oAuthClientApplicationId("oAuthClientApplicationId")
         .oAuthClientAuthenticationType("oAuthClientAuthenticationType")
         .oAuthTokenEndpointUrl("oAuthTokenEndpointUrl")
         // the properties below are optional
         .clientId("clientId")
         .clientSecret("clientSecret")
         .dataSourceType("dataSourceType")
         .identityProviderVpcConnectionProperties(IdentityProviderVpcConnectionPropertiesProperty.builder()
                 .vpcConnectionArn("vpcConnectionArn")
                 .build())
         .oAuthAuthorizationEndpointUrl("oAuthAuthorizationEndpointUrl")
         .oAuthScopes("oAuthScopes")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOAuthClientApplication

      protected CfnOAuthClientApplication(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOAuthClientApplication

      protected CfnOAuthClientApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOAuthClientApplication

      @Stability(Stable) public CfnOAuthClientApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOAuthClientApplicationProps props)
      Create a new AWS::QuickSight::OAuthClientApplication.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForOAuthClientApplication

      @Stability(Stable) @NotNull public static String arnForOAuthClientApplication(@NotNull IOAuthClientApplicationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnOAuthClientApplication

      @Stability(Stable) @NotNull public static Boolean isCfnOAuthClientApplication(@NotNull Object x)
      Checks whether the given object is a CfnOAuthClientApplication.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getOAuthClientApplicationRef

      @Stability(Stable) @NotNull public OAuthClientApplicationReference getOAuthClientApplicationRef()
      A reference to a OAuthClientApplication resource.
      Specified by:
      getOAuthClientApplicationRef in interface IOAuthClientApplicationRef

    • getName

      @Stability(Stable) @NotNull public String getName()

    • setName

      @Stability(Stable) public void setName(@NotNull String value)

    • getOAuthClientApplicationId

      @Stability(Stable) @NotNull public String getOAuthClientApplicationId()

    • setOAuthClientApplicationId

      @Stability(Stable) public void setOAuthClientApplicationId(@NotNull String value)

    • getOAuthClientAuthenticationType

      @Stability(Stable) @NotNull public String getOAuthClientAuthenticationType()

    • setOAuthClientAuthenticationType

      @Stability(Stable) public void setOAuthClientAuthenticationType(@NotNull String value)

    • getOAuthTokenEndpointUrl

      @Stability(Stable) @NotNull public String getOAuthTokenEndpointUrl()

    • setOAuthTokenEndpointUrl

      @Stability(Stable) public void setOAuthTokenEndpointUrl(@NotNull String value)

    • getClientId

      @Stability(Stable) @Nullable public String getClientId()

    • setClientId

      @Stability(Stable) public void setClientId(@Nullable String value)

    • getClientSecret

      @Stability(Stable) @Nullable public String getClientSecret()

    • setClientSecret

      @Stability(Stable) public void setClientSecret(@Nullable String value)

    • getDataSourceType

      @Stability(Stable) @Nullable public String getDataSourceType()

    • setDataSourceType

      @Stability(Stable) public void setDataSourceType(@Nullable String value)

    • getIdentityProviderVpcConnectionProperties

      @Stability(Stable) @Nullable public Object getIdentityProviderVpcConnectionProperties()
      Returns union: either IResolvable or CfnOAuthClientApplication.IdentityProviderVpcConnectionPropertiesProperty

    • setIdentityProviderVpcConnectionProperties

      @Stability(Stable) public void setIdentityProviderVpcConnectionProperties(@Nullable IResolvable value)

    • setIdentityProviderVpcConnectionProperties

      @Stability(Stable) public void setIdentityProviderVpcConnectionProperties(@Nullable CfnOAuthClientApplication.IdentityProviderVpcConnectionPropertiesProperty value)

    • getOAuthAuthorizationEndpointUrl

      @Stability(Stable) @Nullable public String getOAuthAuthorizationEndpointUrl()

    • setOAuthAuthorizationEndpointUrl

      @Stability(Stable) public void setOAuthAuthorizationEndpointUrl(@Nullable String value)

    • getOAuthScopes

      @Stability(Stable) @Nullable public String getOAuthScopes()

    • setOAuthScopes

      @Stability(Stable) public void setOAuthScopes(@Nullable String value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)