Package software.amazon.awscdk.services.qbusiness

Class CfnDataAccessor

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.qbusiness.CfnDataAccessor

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:05.805Z")
@Stability(Stable)
public class CfnDataAccessor
extends CfnResource
implements IInspectable, ITaggableV2

Definition of AWS::QBusiness::DataAccessor 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.qbusiness.*;
 AttributeFilterProperty attributeFilterProperty_;
 CfnDataAccessor cfnDataAccessor = CfnDataAccessor.Builder.create(this, "MyCfnDataAccessor")
         .actionConfigurations(List.of(ActionConfigurationProperty.builder()
                 .action("action")
                 // the properties below are optional
                 .filterConfiguration(ActionFilterConfigurationProperty.builder()
                         .documentAttributeFilter(AttributeFilterProperty.builder()
                                 .andAllFilters(List.of(attributeFilterProperty_))
                                 .containsAll(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .containsAny(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .equalsTo(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .greaterThan(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .greaterThanOrEquals(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .lessThan(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .lessThanOrEquals(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .notFilter(attributeFilterProperty_)
                                 .orAllFilters(List.of(attributeFilterProperty_))
                                 .build())
                         .build())
                 .build()))
         .displayName("displayName")
         .principal("principal")
         // the properties below are optional
         .applicationId("applicationId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataAccessor.ActionConfigurationProperty	Example:
static interface	CfnDataAccessor.ActionFilterConfigurationProperty	Example:
static interface	CfnDataAccessor.AttributeFilterProperty	Example:
static final class	CfnDataAccessor.Builder	A fluent builder for CfnDataAccessor.
static interface	CfnDataAccessor.DocumentAttributeProperty	Example:
static interface	CfnDataAccessor.DocumentAttributeValueProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataAccessor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataAccessor(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataAccessor(software.constructs.Construct scope, String id, CfnDataAccessorProps props)

Method Summary

Modifier and Type	Method	Description
Object	getActionConfigurations()
String	getApplicationId()
String	getAttrCreatedAt()
String	getAttrDataAccessorArn()
String	getAttrDataAccessorId()
String	getAttrIdcApplicationArn()
String	getAttrUpdatedAt()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDisplayName()
String	getPrincipal()
List<CfnTag>	getTags()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionConfigurations(List<Object> value)
void	setActionConfigurations(IResolvable value)
void	setApplicationId(String value)
void	setDisplayName(String value)
void	setPrincipal(String value)
void	setTags(List<CfnTag> value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnDataAccessor

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

CfnDataAccessor

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

CfnDataAccessor

@Stability(Stable)
public CfnDataAccessor(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataAccessorProps props)

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

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.

getAttrCreatedAt

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

getAttrDataAccessorArn

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

getAttrDataAccessorId

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

getAttrIdcApplicationArn

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

getAttrUpdatedAt

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

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

getActionConfigurations

@Stability(Stable)
@NotNull
public Object getActionConfigurations()

setActionConfigurations

@Stability(Stable)
public void setActionConfigurations(@NotNull
 IResolvable value)

setActionConfigurations

@Stability(Stable)
public void setActionConfigurations(@NotNull
 List<Object> value)

getDisplayName

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

setDisplayName

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

getPrincipal

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

setPrincipal

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

getApplicationId

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

setApplicationId

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

getTags

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

setTags

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