Skip to content

securityGroupRule.java.md

Latest commit

 

History

History
1898 lines (1185 loc) · 89.4 KB

securityGroupRule.java.md

File metadata and controls

1898 lines (1185 loc) · 89.4 KB

securityGroupRule Submodule

Constructs

SecurityGroupRule

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

Initializers 

import io.cdktn.providers.aws.security_group_rule.SecurityGroupRule;

SecurityGroupRule.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>)
    .fromPort(java.lang.Number)
    .protocol(java.lang.String)
    .securityGroupId(java.lang.String)
    .toPort(java.lang.Number)
    .type(java.lang.String)
//  .cidrBlocks(java.util.List<java.lang.String>)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .ipv6CidrBlocks(java.util.List<java.lang.String>)
//  .prefixListIds(java.util.List<java.lang.String>)
//  .region(java.lang.String)
//  .selfAttribute(java.lang.Boolean|IResolvable)
//  .sourceSecurityGroupId(java.lang.String)
//  .timeouts(SecurityGroupRuleTimeouts)
    .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.
fromPort java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#from_port SecurityGroupRule#from_port}.
protocol java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#protocol SecurityGroupRule#protocol}.
securityGroupId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#security_group_id SecurityGroupRule#security_group_id}.
toPort java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#to_port SecurityGroupRule#to_port}.
type java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#type SecurityGroupRule#type}.
cidrBlocks java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#cidr_blocks SecurityGroupRule#cidr_blocks}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#description SecurityGroupRule#description}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#id SecurityGroupRule#id}.
ipv6CidrBlocks java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#ipv6_cidr_blocks SecurityGroupRule#ipv6_cidr_blocks}.
prefixListIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#prefix_list_ids SecurityGroupRule#prefix_list_ids}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
selfAttribute java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#self SecurityGroupRule#self}.
sourceSecurityGroupId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#source_security_group_id SecurityGroupRule#source_security_group_id}.
timeouts SecurityGroupRuleTimeouts timeouts 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: 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>
fromPortRequired
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#from_port SecurityGroupRule#from_port}.

protocolRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#protocol SecurityGroupRule#protocol}.

securityGroupIdRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#security_group_id SecurityGroupRule#security_group_id}.

toPortRequired
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#to_port SecurityGroupRule#to_port}.

typeRequired
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#type SecurityGroupRule#type}.

cidrBlocksOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#cidr_blocks SecurityGroupRule#cidr_blocks}.

descriptionOptional
  • Type: java.lang.String

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

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#id SecurityGroupRule#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.

ipv6CidrBlocksOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#ipv6_cidr_blocks SecurityGroupRule#ipv6_cidr_blocks}.

prefixListIdsOptional
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#prefix_list_ids SecurityGroupRule#prefix_list_ids}.

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/security_group_rule#region SecurityGroupRule#region}

selfAttributeOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#self SecurityGroupRule#self}.

sourceSecurityGroupIdOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#source_security_group_id SecurityGroupRule#source_security_group_id}.

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#timeouts SecurityGroupRule#timeouts}

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".
putTimeouts No description.
resetCidrBlocks No description.
resetDescription No description.
resetId No description.
resetIpv6CidrBlocks No description.
resetPrefixListIds No description.
resetRegion No description.
resetSelfAttribute No description.
resetSourceSecurityGroupId No description.
resetTimeouts 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".

putTimeouts 
public void putTimeouts(SecurityGroupRuleTimeouts value)
valueRequired
resetCidrBlocks 
public void resetCidrBlocks()
resetDescription 
public void resetDescription()
resetId 
public void resetId()
resetIpv6CidrBlocks 
public void resetIpv6CidrBlocks()
resetPrefixListIds 
public void resetPrefixListIds()
resetRegion 
public void resetRegion()
resetSelfAttribute 
public void resetSelfAttribute()
resetSourceSecurityGroupId 
public void resetSourceSecurityGroupId()
resetTimeouts 
public void resetTimeouts()

Static Functions

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

SecurityGroupRule.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.security_group_rule.SecurityGroupRule;

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

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

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

Generates CDKTN code for importing a SecurityGroupRule 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 SecurityGroupRule to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing SecurityGroupRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#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 SecurityGroupRule 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.
securityGroupRuleId java.lang.String No description.
timeouts SecurityGroupRuleTimeoutsOutputReference No description.
cidrBlocksInput java.util.List<java.lang.String> No description.
descriptionInput java.lang.String No description.
fromPortInput java.lang.Number No description.
idInput java.lang.String No description.
ipv6CidrBlocksInput java.util.List<java.lang.String> No description.
prefixListIdsInput java.util.List<java.lang.String> No description.
protocolInput java.lang.String No description.
regionInput java.lang.String No description.
securityGroupIdInput java.lang.String No description.
selfAttributeInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
sourceSecurityGroupIdInput java.lang.String No description.
timeoutsInput io.cdktn.cdktn.IResolvable|SecurityGroupRuleTimeouts No description.
toPortInput java.lang.Number No description.
typeInput java.lang.String No description.
cidrBlocks java.util.List<java.lang.String> No description.
description java.lang.String No description.
fromPort java.lang.Number No description.
id java.lang.String No description.
ipv6CidrBlocks java.util.List<java.lang.String> No description.
prefixListIds java.util.List<java.lang.String> No description.
protocol java.lang.String No description.
region java.lang.String No description.
securityGroupId java.lang.String No description.
selfAttribute java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
sourceSecurityGroupId java.lang.String No description.
toPort java.lang.Number No description.
type 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>
securityGroupRuleIdRequired 
public java.lang.String getSecurityGroupRuleId();
  • Type: java.lang.String
timeoutsRequired 
public SecurityGroupRuleTimeoutsOutputReference getTimeouts();
cidrBlocksInputOptional 
public java.util.List<java.lang.String> getCidrBlocksInput();
  • Type: java.util.List<java.lang.String>
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
fromPortInputOptional 
public java.lang.Number getFromPortInput();
  • Type: java.lang.Number
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
ipv6CidrBlocksInputOptional 
public java.util.List<java.lang.String> getIpv6CidrBlocksInput();
  • Type: java.util.List<java.lang.String>
prefixListIdsInputOptional 
public java.util.List<java.lang.String> getPrefixListIdsInput();
  • Type: java.util.List<java.lang.String>
protocolInputOptional 
public java.lang.String getProtocolInput();
  • Type: java.lang.String
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
securityGroupIdInputOptional 
public java.lang.String getSecurityGroupIdInput();
  • Type: java.lang.String
selfAttributeInputOptional 
public java.lang.Boolean|IResolvable getSelfAttributeInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
sourceSecurityGroupIdInputOptional 
public java.lang.String getSourceSecurityGroupIdInput();
  • Type: java.lang.String
timeoutsInputOptional 
public IResolvable|SecurityGroupRuleTimeouts getTimeoutsInput();
toPortInputOptional 
public java.lang.Number getToPortInput();
  • Type: java.lang.Number
typeInputOptional 
public java.lang.String getTypeInput();
  • Type: java.lang.String
cidrBlocksRequired 
public java.util.List<java.lang.String> getCidrBlocks();
  • Type: java.util.List<java.lang.String>
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
fromPortRequired 
public java.lang.Number getFromPort();
  • Type: java.lang.Number
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
ipv6CidrBlocksRequired 
public java.util.List<java.lang.String> getIpv6CidrBlocks();
  • Type: java.util.List<java.lang.String>
prefixListIdsRequired 
public java.util.List<java.lang.String> getPrefixListIds();
  • Type: java.util.List<java.lang.String>
protocolRequired 
public java.lang.String getProtocol();
  • Type: java.lang.String
regionRequired 
public java.lang.String getRegion();
  • Type: java.lang.String
securityGroupIdRequired 
public java.lang.String getSecurityGroupId();
  • Type: java.lang.String
selfAttributeRequired 
public java.lang.Boolean|IResolvable getSelfAttribute();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
sourceSecurityGroupIdRequired 
public java.lang.String getSourceSecurityGroupId();
  • Type: java.lang.String
toPortRequired 
public java.lang.Number getToPort();
  • Type: java.lang.Number
typeRequired 
public java.lang.String getType();
  • 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

SecurityGroupRuleConfig

Initializer 

import io.cdktn.providers.aws.security_group_rule.SecurityGroupRuleConfig;

SecurityGroupRuleConfig.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>)
    .fromPort(java.lang.Number)
    .protocol(java.lang.String)
    .securityGroupId(java.lang.String)
    .toPort(java.lang.Number)
    .type(java.lang.String)
//  .cidrBlocks(java.util.List<java.lang.String>)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .ipv6CidrBlocks(java.util.List<java.lang.String>)
//  .prefixListIds(java.util.List<java.lang.String>)
//  .region(java.lang.String)
//  .selfAttribute(java.lang.Boolean|IResolvable)
//  .sourceSecurityGroupId(java.lang.String)
//  .timeouts(SecurityGroupRuleTimeouts)
    .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.
fromPort java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#from_port SecurityGroupRule#from_port}.
protocol java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#protocol SecurityGroupRule#protocol}.
securityGroupId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#security_group_id SecurityGroupRule#security_group_id}.
toPort java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#to_port SecurityGroupRule#to_port}.
type java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#type SecurityGroupRule#type}.
cidrBlocks java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#cidr_blocks SecurityGroupRule#cidr_blocks}.
description java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#description SecurityGroupRule#description}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#id SecurityGroupRule#id}.
ipv6CidrBlocks java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#ipv6_cidr_blocks SecurityGroupRule#ipv6_cidr_blocks}.
prefixListIds java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#prefix_list_ids SecurityGroupRule#prefix_list_ids}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
selfAttribute java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#self SecurityGroupRule#self}.
sourceSecurityGroupId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#source_security_group_id SecurityGroupRule#source_security_group_id}.
timeouts SecurityGroupRuleTimeouts timeouts block.
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>
fromPortRequired 
public java.lang.Number getFromPort();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#from_port SecurityGroupRule#from_port}.

protocolRequired 
public java.lang.String getProtocol();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#protocol SecurityGroupRule#protocol}.

securityGroupIdRequired 
public java.lang.String getSecurityGroupId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#security_group_id SecurityGroupRule#security_group_id}.

toPortRequired 
public java.lang.Number getToPort();
  • Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#to_port SecurityGroupRule#to_port}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#type SecurityGroupRule#type}.

cidrBlocksOptional 
public java.util.List<java.lang.String> getCidrBlocks();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#cidr_blocks SecurityGroupRule#cidr_blocks}.

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/security_group_rule#description SecurityGroupRule#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/security_group_rule#id SecurityGroupRule#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.

ipv6CidrBlocksOptional 
public java.util.List<java.lang.String> getIpv6CidrBlocks();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#ipv6_cidr_blocks SecurityGroupRule#ipv6_cidr_blocks}.

prefixListIdsOptional 
public java.util.List<java.lang.String> getPrefixListIds();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#prefix_list_ids SecurityGroupRule#prefix_list_ids}.

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/security_group_rule#region SecurityGroupRule#region}

selfAttributeOptional 
public java.lang.Boolean|IResolvable getSelfAttribute();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#self SecurityGroupRule#self}.

sourceSecurityGroupIdOptional 
public java.lang.String getSourceSecurityGroupId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#source_security_group_id SecurityGroupRule#source_security_group_id}.

timeoutsOptional 
public SecurityGroupRuleTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#timeouts SecurityGroupRule#timeouts}

SecurityGroupRuleTimeouts

Initializer 

import io.cdktn.providers.aws.security_group_rule.SecurityGroupRuleTimeouts;

SecurityGroupRuleTimeouts.builder()
//  .create(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#create SecurityGroupRule#create}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/security_group_rule#create SecurityGroupRule#create}.

Classes

SecurityGroupRuleTimeoutsOutputReference

Initializers 

import io.cdktn.providers.aws.security_group_rule.SecurityGroupRuleTimeoutsOutputReference;

new SecurityGroupRuleTimeoutsOutputReference(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.
resetCreate 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.

resetCreate 
public void resetCreate()

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.
createInput java.lang.String No description.
create java.lang.String No description.
internalValue io.cdktn.cdktn.IResolvable|SecurityGroupRuleTimeouts 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
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
internalValueOptional 
public IResolvable|SecurityGroupRuleTimeouts getInternalValue();