Skip to content

Latest commit

 

History

History
1238 lines (772 loc) · 64.9 KB

dataPagerdutyAlertGroupingSetting.java.md

File metadata and controls

1238 lines (772 loc) · 64.9 KB

dataPagerdutyAlertGroupingSetting Submodule

Constructs

DataPagerdutyAlertGroupingSetting

Represents a {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting pagerduty_alert_grouping_setting}.

Initializers

import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSetting;

DataPagerdutyAlertGroupingSetting.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .config(DataPagerdutyAlertGroupingSettingConfigA)
    .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 com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#name DataPagerdutyAlertGroupingSetting#name}.
config DataPagerdutyAlertGroupingSettingConfigA config block.

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: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#name DataPagerdutyAlertGroupingSetting#name}.


configOptional

config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#config DataPagerdutyAlertGroupingSetting#config}


Methods

Name Description
toString Returns a string representation of 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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putConfig No description.
resetConfig No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

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()

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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 terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

putConfig
public void putConfig(DataPagerdutyAlertGroupingSettingConfigA value)
valueRequired

resetConfig
public void resetConfig()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataPagerdutyAlertGroupingSetting resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSetting;

DataPagerdutyAlertGroupingSetting.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 com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSetting;

DataPagerdutyAlertGroupingSetting.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformDataSource
import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSetting;

DataPagerdutyAlertGroupingSetting.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSetting;

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

Generates CDKTF code for importing a DataPagerdutyAlertGroupingSetting resource upon running "cdktf 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 DataPagerdutyAlertGroupingSetting to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing DataPagerdutyAlertGroupingSetting that should be imported.

Refer to the {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.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 com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
config DataPagerdutyAlertGroupingSettingConfigAOutputReference No description.
description java.lang.String No description.
id java.lang.String No description.
services java.util.List<java.lang.String> No description.
type java.lang.String No description.
configInput com.hashicorp.cdktf.IResolvable OR DataPagerdutyAlertGroupingSettingConfigA No description.
nameInput java.lang.String No description.
name java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.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: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

configRequired
public DataPagerdutyAlertGroupingSettingConfigAOutputReference getConfig();

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

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

servicesRequired
public java.util.List<java.lang.String> getServices();
  • Type: java.util.List<java.lang.String>

typeRequired
public java.lang.String getType();
  • Type: java.lang.String

configInputOptional
public java.lang.Object getConfigInput();

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DataPagerdutyAlertGroupingSettingConfig

Initializer

import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSettingConfig;

DataPagerdutyAlertGroupingSettingConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .config(DataPagerdutyAlertGroupingSettingConfigA)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#name DataPagerdutyAlertGroupingSetting#name}.
config DataPagerdutyAlertGroupingSettingConfigA config block.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#name DataPagerdutyAlertGroupingSetting#name}.


configOptional
public DataPagerdutyAlertGroupingSettingConfigA getConfig();

config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#config DataPagerdutyAlertGroupingSetting#config}


DataPagerdutyAlertGroupingSettingConfigA

Initializer

import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSettingConfigA;

DataPagerdutyAlertGroupingSettingConfigA.builder()
//  .aggregate(java.lang.String)
//  .fields(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
aggregate java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#aggregate DataPagerdutyAlertGroupingSetting#aggregate}.
fields java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#fields DataPagerdutyAlertGroupingSetting#fields}.

aggregateOptional
public java.lang.String getAggregate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#aggregate DataPagerdutyAlertGroupingSetting#aggregate}.


fieldsOptional
public java.util.List<java.lang.String> getFields();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/pagerduty/pagerduty/3.19.2/docs/data-sources/alert_grouping_setting#fields DataPagerdutyAlertGroupingSetting#fields}.


Classes

DataPagerdutyAlertGroupingSettingConfigAOutputReference

Initializers

import com.hashicorp.cdktf.providers.pagerduty.data_pagerduty_alert_grouping_setting.DataPagerdutyAlertGroupingSettingConfigAOutputReference;

new DataPagerdutyAlertGroupingSettingConfigAOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.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.
resetAggregate No description.
resetFields 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: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAggregate
public void resetAggregate()
resetFields
public void resetFields()

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.
timeout java.lang.Number No description.
timeWindow java.lang.Number No description.
aggregateInput java.lang.String No description.
fieldsInput java.util.List<java.lang.String> No description.
aggregate java.lang.String No description.
fields java.util.List<java.lang.String> No description.
internalValue com.hashicorp.cdktf.IResolvable OR DataPagerdutyAlertGroupingSettingConfigA 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

timeoutRequired
public java.lang.Number getTimeout();
  • Type: java.lang.Number

timeWindowRequired
public java.lang.Number getTimeWindow();
  • Type: java.lang.Number

aggregateInputOptional
public java.lang.String getAggregateInput();
  • Type: java.lang.String

fieldsInputOptional
public java.util.List<java.lang.String> getFieldsInput();
  • Type: java.util.List<java.lang.String>

aggregateRequired
public java.lang.String getAggregate();
  • Type: java.lang.String

fieldsRequired
public java.util.List<java.lang.String> getFields();
  • Type: java.util.List<java.lang.String>

internalValueOptional
public java.lang.Object getInternalValue();