Package software.amazon.awscdk.services.quicksight

Class CfnRefreshSchedule

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.CfnRefreshSchedule

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:11.863Z")
@Stability(Stable)
public class CfnRefreshSchedule
extends CfnResource
implements IInspectable

Creates a refresh schedule for a dataset in Amazon QuickSight .

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.*;
 CfnRefreshSchedule cfnRefreshSchedule = CfnRefreshSchedule.Builder.create(this, "MyCfnRefreshSchedule")
         .awsAccountId("awsAccountId")
         .dataSetId("dataSetId")
         .schedule(RefreshScheduleMapProperty.builder()
                 .refreshType("refreshType")
                 .scheduleFrequency(ScheduleFrequencyProperty.builder()
                         .interval("interval")
                         .refreshOnDay(RefreshOnDayProperty.builder()
                                 .dayOfMonth("dayOfMonth")
                                 .dayOfWeek("dayOfWeek")
                                 .build())
                         .timeOfTheDay("timeOfTheDay")
                         .timeZone("timeZone")
                         .build())
                 .scheduleId("scheduleId")
                 .startAfterDateTime("startAfterDateTime")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRefreshSchedule.Builder	A fluent builder for CfnRefreshSchedule.
static interface	CfnRefreshSchedule.RefreshOnDayProperty	The day that you want yout dataset to refresh.
static interface	CfnRefreshSchedule.RefreshScheduleMapProperty	A summary of a configured refresh schedule for a dataset.
static interface	CfnRefreshSchedule.ScheduleFrequencyProperty	The frequency for the refresh schedule.

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

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	CfnRefreshSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRefreshSchedule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnRefreshSchedule(software.constructs.Construct scope, String id)
	CfnRefreshSchedule(software.constructs.Construct scope, String id, CfnRefreshScheduleProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) for the refresh schedule.
String	getAwsAccountId()	The AWS account ID of the account that you are creating a schedule in.
protected Map<String,Object>	getCfnProperties()
String	getDataSetId()	The ID of the dataset that you are creating a refresh schedule for.
Object	getSchedule()	The refresh schedule of a dataset.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value)	The AWS account ID of the account that you are creating a schedule in.
void	setDataSetId(String value)	The ID of the dataset that you are creating a refresh schedule for.
void	setSchedule(IResolvable value)	The refresh schedule of a dataset.
void	setSchedule(CfnRefreshSchedule.RefreshScheduleMapProperty value)	The refresh schedule of a dataset.

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

CfnRefreshSchedule

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

CfnRefreshSchedule

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

CfnRefreshSchedule

@Stability(Stable)
public CfnRefreshSchedule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnRefreshScheduleProps 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.

CfnRefreshSchedule

@Stability(Stable)
public CfnRefreshSchedule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

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.

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.

getAttrArn

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

The Amazon Resource Name (ARN) for the refresh schedule.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAwsAccountId

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

The AWS account ID of the account that you are creating a schedule in.

setAwsAccountId

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

The AWS account ID of the account that you are creating a schedule in.

getDataSetId

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

The ID of the dataset that you are creating a refresh schedule for.

setDataSetId

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

The ID of the dataset that you are creating a refresh schedule for.

getSchedule

@Stability(Stable)
@Nullable
public Object getSchedule()

The refresh schedule of a dataset.

setSchedule

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

The refresh schedule of a dataset.

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 CfnRefreshSchedule.RefreshScheduleMapProperty value)

The refresh schedule of a dataset.