Skip to content

backupReportPlan.java.md

Latest commit

 

History

History
2230 lines (1391 loc) · 106 KB

backupReportPlan.java.md

File metadata and controls

2230 lines (1391 loc) · 106 KB

backupReportPlan Submodule

Constructs

BackupReportPlan

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan aws_backup_report_plan}.

Initializers 

import io.cdktn.providers.aws.backup_report_plan.BackupReportPlan;

BackupReportPlan.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .name(java.lang.String)
    .reportDeliveryChannel(BackupReportPlanReportDeliveryChannel)
    .reportSetting(BackupReportPlanReportSetting)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .region(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#name BackupReportPlan#name}.
reportDeliveryChannel BackupReportPlanReportDeliveryChannel report_delivery_channel block.
reportSetting BackupReportPlanReportSetting report_setting block.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#description BackupReportPlan#description}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#id BackupReportPlan#id}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags BackupReportPlan#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags_all BackupReportPlan#tags_all}.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
nameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#name BackupReportPlan#name}.

reportDeliveryChannelRequired

report_delivery_channel block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#report_delivery_channel BackupReportPlan#report_delivery_channel}

reportSettingRequired

report_setting block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#report_setting BackupReportPlan#report_setting}

descriptionOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#description BackupReportPlan#description}.

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#id BackupReportPlan#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

regionOptional
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#region BackupReportPlan#region}

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags BackupReportPlan#tags}.

tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags_all BackupReportPlan#tags_all}.

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putReportDeliveryChannel No description.
putReportSetting No description.
resetDescription No description.
resetId No description.
resetRegion No description.
resetTags No description.
resetTagsAll No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String|java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putReportDeliveryChannel 
public void putReportDeliveryChannel(BackupReportPlanReportDeliveryChannel value)
valueRequired
putReportSetting 
public void putReportSetting(BackupReportPlanReportSetting value)
valueRequired
resetDescription 
public void resetDescription()
resetId 
public void resetId()
resetRegion 
public void resetRegion()
resetTags 
public void resetTags()
resetTagsAll 
public void resetTagsAll()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a BackupReportPlan resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.aws.backup_report_plan.BackupReportPlan;

BackupReportPlan.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import io.cdktn.providers.aws.backup_report_plan.BackupReportPlan;

BackupReportPlan.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import io.cdktn.providers.aws.backup_report_plan.BackupReportPlan;

BackupReportPlan.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.aws.backup_report_plan.BackupReportPlan;

BackupReportPlan.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),BackupReportPlan.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTN code for importing a BackupReportPlan resource upon running "cdktn plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the BackupReportPlan to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing BackupReportPlan that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

? Optional instance of the provider where the BackupReportPlan to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
arn java.lang.String No description.
creationTime java.lang.String No description.
deploymentStatus java.lang.String No description.
reportDeliveryChannel BackupReportPlanReportDeliveryChannelOutputReference No description.
reportSetting BackupReportPlanReportSettingOutputReference No description.
descriptionInput java.lang.String No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
regionInput java.lang.String No description.
reportDeliveryChannelInput BackupReportPlanReportDeliveryChannel No description.
reportSettingInput BackupReportPlanReportSetting No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
description java.lang.String No description.
id java.lang.String No description.
name java.lang.String No description.
region java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
arnRequired 
public java.lang.String getArn();
  • Type: java.lang.String
creationTimeRequired 
public java.lang.String getCreationTime();
  • Type: java.lang.String
deploymentStatusRequired 
public java.lang.String getDeploymentStatus();
  • Type: java.lang.String
reportDeliveryChannelRequired 
public BackupReportPlanReportDeliveryChannelOutputReference getReportDeliveryChannel();
reportSettingRequired 
public BackupReportPlanReportSettingOutputReference getReportSetting();
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
reportDeliveryChannelInputOptional 
public BackupReportPlanReportDeliveryChannel getReportDeliveryChannelInput();
reportSettingInputOptional 
public BackupReportPlanReportSetting getReportSettingInput();
tagsAllInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
regionRequired 
public java.lang.String getRegion();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsAllRequired 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

BackupReportPlanConfig

Initializer 

import io.cdktn.providers.aws.backup_report_plan.BackupReportPlanConfig;

BackupReportPlanConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .name(java.lang.String)
    .reportDeliveryChannel(BackupReportPlanReportDeliveryChannel)
    .reportSetting(BackupReportPlanReportSetting)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .region(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#name BackupReportPlan#name}.
reportDeliveryChannel BackupReportPlanReportDeliveryChannel report_delivery_channel block.
reportSetting BackupReportPlanReportSetting report_setting block.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#description BackupReportPlan#description}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#id BackupReportPlan#id}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags BackupReportPlan#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags_all BackupReportPlan#tags_all}.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#name BackupReportPlan#name}.

reportDeliveryChannelRequired 
public BackupReportPlanReportDeliveryChannel getReportDeliveryChannel();

report_delivery_channel block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#report_delivery_channel BackupReportPlan#report_delivery_channel}

reportSettingRequired 
public BackupReportPlanReportSetting getReportSetting();

report_setting block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#report_setting BackupReportPlan#report_setting}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#description BackupReportPlan#description}.

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#id BackupReportPlan#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#region BackupReportPlan#region}

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags BackupReportPlan#tags}.

tagsAllOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#tags_all BackupReportPlan#tags_all}.

BackupReportPlanReportDeliveryChannel

Initializer 

import io.cdktn.providers.aws.backup_report_plan.BackupReportPlanReportDeliveryChannel;

BackupReportPlanReportDeliveryChannel.builder()
    .s3BucketName(java.lang.String)
//  .formats(java.util.List<java.lang.String>)
//  .s3KeyPrefix(java.lang.String)
    .build();

Properties

Name Type Description
s3BucketName java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#s3_bucket_name BackupReportPlan#s3_bucket_name}.
formats java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#formats BackupReportPlan#formats}.
s3KeyPrefix java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#s3_key_prefix BackupReportPlan#s3_key_prefix}.
s3BucketNameRequired 
public java.lang.String getS3BucketName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#s3_bucket_name BackupReportPlan#s3_bucket_name}.

formatsOptional 
public java.util.List<java.lang.String> getFormats();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#formats BackupReportPlan#formats}.

s3KeyPrefixOptional 
public java.lang.String getS3KeyPrefix();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#s3_key_prefix BackupReportPlan#s3_key_prefix}.

BackupReportPlanReportSetting

Initializer 

import io.cdktn.providers.aws.backup_report_plan.BackupReportPlanReportSetting;

BackupReportPlanReportSetting.builder()
    .reportTemplate(java.lang.String)
//  .accounts(java.util.List<java.lang.String>)
//  .frameworkArns(java.util.List<java.lang.String>)
//  .numberOfFrameworks(java.lang.Number)
//  .organizationUnits(java.util.List<java.lang.String>)
//  .regions(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
reportTemplate java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#report_template BackupReportPlan#report_template}.
accounts java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#accounts BackupReportPlan#accounts}.
frameworkArns java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#framework_arns BackupReportPlan#framework_arns}.
numberOfFrameworks java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#number_of_frameworks BackupReportPlan#number_of_frameworks}.
organizationUnits java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#organization_units BackupReportPlan#organization_units}.
regions java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#regions BackupReportPlan#regions}.
reportTemplateRequired 
public java.lang.String getReportTemplate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#report_template BackupReportPlan#report_template}.

accountsOptional 
public java.util.List<java.lang.String> getAccounts();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#accounts BackupReportPlan#accounts}.

frameworkArnsOptional 
public java.util.List<java.lang.String> getFrameworkArns();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#framework_arns BackupReportPlan#framework_arns}.

numberOfFrameworksOptional 
public java.lang.Number getNumberOfFrameworks();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#number_of_frameworks BackupReportPlan#number_of_frameworks}.

organizationUnitsOptional 
public java.util.List<java.lang.String> getOrganizationUnits();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#organization_units BackupReportPlan#organization_units}.

regionsOptional 
public java.util.List<java.lang.String> getRegions();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/backup_report_plan#regions BackupReportPlan#regions}.

Classes

BackupReportPlanReportDeliveryChannelOutputReference

Initializers 

import io.cdktn.providers.aws.backup_report_plan.BackupReportPlanReportDeliveryChannelOutputReference;

new BackupReportPlanReportDeliveryChannelOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource io.cdktn.cdktn.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetFormats No description.
resetS3KeyPrefix No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: io.cdktn.cdktn.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetFormats 
public void resetFormats()
resetS3KeyPrefix 
public void resetS3KeyPrefix()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
formatsInput java.util.List<java.lang.String> No description.
s3BucketNameInput java.lang.String No description.
s3KeyPrefixInput java.lang.String No description.
formats java.util.List<java.lang.String> No description.
s3BucketName java.lang.String No description.
s3KeyPrefix java.lang.String No description.
internalValue BackupReportPlanReportDeliveryChannel No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
formatsInputOptional 
public java.util.List<java.lang.String> getFormatsInput();
  • Type: java.util.List<java.lang.String>
s3BucketNameInputOptional 
public java.lang.String getS3BucketNameInput();
  • Type: java.lang.String
s3KeyPrefixInputOptional 
public java.lang.String getS3KeyPrefixInput();
  • Type: java.lang.String
formatsRequired 
public java.util.List<java.lang.String> getFormats();
  • Type: java.util.List<java.lang.String>
s3BucketNameRequired 
public java.lang.String getS3BucketName();
  • Type: java.lang.String
s3KeyPrefixRequired 
public java.lang.String getS3KeyPrefix();
  • Type: java.lang.String
internalValueOptional 
public BackupReportPlanReportDeliveryChannel getInternalValue();

BackupReportPlanReportSettingOutputReference

Initializers 

import io.cdktn.providers.aws.backup_report_plan.BackupReportPlanReportSettingOutputReference;

new BackupReportPlanReportSettingOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource io.cdktn.cdktn.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetAccounts No description.
resetFrameworkArns No description.
resetNumberOfFrameworks No description.
resetOrganizationUnits No description.
resetRegions No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: io.cdktn.cdktn.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAccounts 
public void resetAccounts()
resetFrameworkArns 
public void resetFrameworkArns()
resetNumberOfFrameworks 
public void resetNumberOfFrameworks()
resetOrganizationUnits 
public void resetOrganizationUnits()
resetRegions 
public void resetRegions()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
accountsInput java.util.List<java.lang.String> No description.
frameworkArnsInput java.util.List<java.lang.String> No description.
numberOfFrameworksInput java.lang.Number No description.
organizationUnitsInput java.util.List<java.lang.String> No description.
regionsInput java.util.List<java.lang.String> No description.
reportTemplateInput java.lang.String No description.
accounts java.util.List<java.lang.String> No description.
frameworkArns java.util.List<java.lang.String> No description.
numberOfFrameworks java.lang.Number No description.
organizationUnits java.util.List<java.lang.String> No description.
regions java.util.List<java.lang.String> No description.
reportTemplate java.lang.String No description.
internalValue BackupReportPlanReportSetting No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
accountsInputOptional 
public java.util.List<java.lang.String> getAccountsInput();
  • Type: java.util.List<java.lang.String>
frameworkArnsInputOptional 
public java.util.List<java.lang.String> getFrameworkArnsInput();
  • Type: java.util.List<java.lang.String>
numberOfFrameworksInputOptional 
public java.lang.Number getNumberOfFrameworksInput();
  • Type: java.lang.Number
organizationUnitsInputOptional 
public java.util.List<java.lang.String> getOrganizationUnitsInput();
  • Type: java.util.List<java.lang.String>
regionsInputOptional 
public java.util.List<java.lang.String> getRegionsInput();
  • Type: java.util.List<java.lang.String>
reportTemplateInputOptional 
public java.lang.String getReportTemplateInput();
  • Type: java.lang.String
accountsRequired 
public java.util.List<java.lang.String> getAccounts();
  • Type: java.util.List<java.lang.String>
frameworkArnsRequired 
public java.util.List<java.lang.String> getFrameworkArns();
  • Type: java.util.List<java.lang.String>
numberOfFrameworksRequired 
public java.lang.Number getNumberOfFrameworks();
  • Type: java.lang.Number
organizationUnitsRequired 
public java.util.List<java.lang.String> getOrganizationUnits();
  • Type: java.util.List<java.lang.String>
regionsRequired 
public java.util.List<java.lang.String> getRegions();
  • Type: java.util.List<java.lang.String>
reportTemplateRequired 
public java.lang.String getReportTemplate();
  • Type: java.lang.String
internalValueOptional 
public BackupReportPlanReportSetting getInternalValue();