Documentation
¶
Index ¶
- func NewSecurityGroupRuleIcmpParametersOutputReference_Override(s SecurityGroupRuleIcmpParametersOutputReference, ...)
- func NewSecurityGroupRulePortRangeOutputReference_Override(s SecurityGroupRulePortRangeOutputReference, ...)
- func NewSecurityGroupRuleProtocolOutputReference_Override(s SecurityGroupRuleProtocolOutputReference, ...)
- func NewSecurityGroupRule_Override(s SecurityGroupRule, scope constructs.Construct, id *string, ...)
- func SecurityGroupRule_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func SecurityGroupRule_IsConstruct(x interface{}) *bool
- func SecurityGroupRule_IsTerraformElement(x interface{}) *bool
- func SecurityGroupRule_IsTerraformResource(x interface{}) *bool
- func SecurityGroupRule_TfResourceType() *string
- type SecurityGroupRule
- type SecurityGroupRuleConfig
- type SecurityGroupRuleIcmpParameters
- type SecurityGroupRuleIcmpParametersOutputReference
- type SecurityGroupRulePortRange
- type SecurityGroupRulePortRangeOutputReference
- type SecurityGroupRuleProtocol
- type SecurityGroupRuleProtocolOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewSecurityGroupRuleIcmpParametersOutputReference_Override ¶
func NewSecurityGroupRuleIcmpParametersOutputReference_Override(s SecurityGroupRuleIcmpParametersOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewSecurityGroupRulePortRangeOutputReference_Override ¶
func NewSecurityGroupRulePortRangeOutputReference_Override(s SecurityGroupRulePortRangeOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewSecurityGroupRuleProtocolOutputReference_Override ¶
func NewSecurityGroupRuleProtocolOutputReference_Override(s SecurityGroupRuleProtocolOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewSecurityGroupRule_Override ¶
func NewSecurityGroupRule_Override(s SecurityGroupRule, scope constructs.Construct, id *string, config *SecurityGroupRuleConfig)
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule stackit_security_group_rule} Resource.
func SecurityGroupRule_GenerateConfigForImport ¶
func SecurityGroupRule_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a SecurityGroupRule resource upon running "cdktf plan <stack-name>".
func SecurityGroupRule_IsConstruct ¶
func SecurityGroupRule_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func SecurityGroupRule_IsTerraformElement ¶
func SecurityGroupRule_IsTerraformElement(x interface{}) *bool
Experimental.
func SecurityGroupRule_IsTerraformResource ¶
func SecurityGroupRule_IsTerraformResource(x interface{}) *bool
Experimental.
func SecurityGroupRule_TfResourceType ¶
func SecurityGroupRule_TfResourceType() *string
Types ¶
type SecurityGroupRule ¶
type SecurityGroupRule interface {
cdktf.TerraformResource
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
Description() *string
SetDescription(val *string)
DescriptionInput() *string
Direction() *string
SetDirection(val *string)
DirectionInput() *string
EtherType() *string
SetEtherType(val *string)
EtherTypeInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
IcmpParameters() SecurityGroupRuleIcmpParametersOutputReference
IcmpParametersInput() interface{}
Id() *string
IpRange() *string
SetIpRange(val *string)
IpRangeInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
// The tree node.
Node() constructs.Node
PortRange() SecurityGroupRulePortRangeOutputReference
PortRangeInput() interface{}
ProjectId() *string
SetProjectId(val *string)
ProjectIdInput() *string
Protocol() SecurityGroupRuleProtocolOutputReference
ProtocolInput() interface{}
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
RemoteSecurityGroupId() *string
SetRemoteSecurityGroupId(val *string)
RemoteSecurityGroupIdInput() *string
SecurityGroupId() *string
SetSecurityGroupId(val *string)
SecurityGroupIdInput() *string
SecurityGroupRuleId() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// 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.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
PutIcmpParameters(value *SecurityGroupRuleIcmpParameters)
PutPortRange(value *SecurityGroupRulePortRange)
PutProtocol(value *SecurityGroupRuleProtocol)
ResetDescription()
ResetEtherType()
ResetIcmpParameters()
ResetIpRange()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetPortRange()
ResetProtocol()
ResetRemoteSecurityGroupId()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule stackit_security_group_rule}.
func NewSecurityGroupRule ¶
func NewSecurityGroupRule(scope constructs.Construct, id *string, config *SecurityGroupRuleConfig) SecurityGroupRule
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule stackit_security_group_rule} Resource.
type SecurityGroupRuleConfig ¶
type SecurityGroupRuleConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// The direction of the traffic which the rule should match.
//
// Some of the possible values are: Supported values are: `ingress`, `egress`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#direction SecurityGroupRule#direction}
Direction *string `field:"required" json:"direction" yaml:"direction"`
// STACKIT project ID to which the security group rule is associated.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#project_id SecurityGroupRule#project_id}
ProjectId *string `field:"required" json:"projectId" yaml:"projectId"`
// The security group ID.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#security_group_id SecurityGroupRule#security_group_id}
SecurityGroupId *string `field:"required" json:"securityGroupId" yaml:"securityGroupId"`
// The rule description.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#description SecurityGroupRule#description}
Description *string `field:"optional" json:"description" yaml:"description"`
// The ethertype which the rule should match.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#ether_type SecurityGroupRule#ether_type}
EtherType *string `field:"optional" json:"etherType" yaml:"etherType"`
// ICMP Parameters. These parameters should only be provided if the protocol is ICMP.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#icmp_parameters SecurityGroupRule#icmp_parameters}
IcmpParameters *SecurityGroupRuleIcmpParameters `field:"optional" json:"icmpParameters" yaml:"icmpParameters"`
// The remote IP range which the rule should match.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#ip_range SecurityGroupRule#ip_range}
IpRange *string `field:"optional" json:"ipRange" yaml:"ipRange"`
// The range of ports. This should only be provided if the protocol is not ICMP.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#port_range SecurityGroupRule#port_range}
PortRange *SecurityGroupRulePortRange `field:"optional" json:"portRange" yaml:"portRange"`
// The internet protocol which the rule should match.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#protocol SecurityGroupRule#protocol}
Protocol *SecurityGroupRuleProtocol `field:"optional" json:"protocol" yaml:"protocol"`
// The remote security group which the rule should match.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#remote_security_group_id SecurityGroupRule#remote_security_group_id}
RemoteSecurityGroupId *string `field:"optional" json:"remoteSecurityGroupId" yaml:"remoteSecurityGroupId"`
}
type SecurityGroupRuleIcmpParameters ¶
type SecurityGroupRuleIcmpParameters struct {
// ICMP code. Can be set if the protocol is ICMP.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#code SecurityGroupRule#code}
Code *float64 `field:"required" json:"code" yaml:"code"`
// ICMP type. Can be set if the protocol is ICMP.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#type SecurityGroupRule#type}
Type *float64 `field:"required" json:"type" yaml:"type"`
}
type SecurityGroupRuleIcmpParametersOutputReference ¶
type SecurityGroupRuleIcmpParametersOutputReference interface {
cdktf.ComplexObject
Code() *float64
SetCode(val *float64)
CodeInput() *float64
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Type() *float64
SetType(val *float64)
TypeInput() *float64
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewSecurityGroupRuleIcmpParametersOutputReference ¶
func NewSecurityGroupRuleIcmpParametersOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) SecurityGroupRuleIcmpParametersOutputReference
type SecurityGroupRulePortRange ¶
type SecurityGroupRulePortRange struct {
// The maximum port number. Should be greater or equal to the minimum.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#max SecurityGroupRule#max}
Max *float64 `field:"required" json:"max" yaml:"max"`
// The minimum port number. Should be less or equal to the maximum.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#min SecurityGroupRule#min}
Min *float64 `field:"required" json:"min" yaml:"min"`
}
type SecurityGroupRulePortRangeOutputReference ¶
type SecurityGroupRulePortRangeOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
Max() *float64
SetMax(val *float64)
MaxInput() *float64
Min() *float64
SetMin(val *float64)
MinInput() *float64
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewSecurityGroupRulePortRangeOutputReference ¶
func NewSecurityGroupRulePortRangeOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) SecurityGroupRulePortRangeOutputReference
type SecurityGroupRuleProtocol ¶
type SecurityGroupRuleProtocol struct {
// The protocol name which the rule should match.
//
// Either `name` or `number` must be provided. Possible values are: `ah`, `dccp`, `egp`, `esp`, `gre`, `icmp`, `igmp`, `ipip`, `ipv6-encap`, `ipv6-frag`, `ipv6-icmp`, `ipv6-nonxt`, `ipv6-opts`, `ipv6-route`, `ospf`, `pgm`, `rsvp`, `sctp`, `tcp`, `udp`, `udplite`, `vrrp`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#name SecurityGroupRule#name}
Name *string `field:"optional" json:"name" yaml:"name"`
// The protocol number which the rule should match. Either `name` or `number` must be provided.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.61.0/docs/resources/security_group_rule#number SecurityGroupRule#number}
Number *float64 `field:"optional" json:"number" yaml:"number"`
}
type SecurityGroupRuleProtocolOutputReference ¶
type SecurityGroupRuleProtocolOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// 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.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
Name() *string
SetName(val *string)
NameInput() *string
Number() *float64
SetNumber(val *float64)
NumberInput() *float64
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
ResetName()
ResetNumber()
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewSecurityGroupRuleProtocolOutputReference ¶
func NewSecurityGroupRuleProtocolOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) SecurityGroupRuleProtocolOutputReference
Source Files
¶
- SecurityGroupRule.go
- SecurityGroupRuleConfig.go
- SecurityGroupRuleIcmpParameters.go
- SecurityGroupRuleIcmpParametersOutputReference.go
- SecurityGroupRuleIcmpParametersOutputReference__checks.go
- SecurityGroupRulePortRange.go
- SecurityGroupRulePortRangeOutputReference.go
- SecurityGroupRulePortRangeOutputReference__checks.go
- SecurityGroupRuleProtocol.go
- SecurityGroupRuleProtocolOutputReference.go
- SecurityGroupRuleProtocolOutputReference__checks.go
- SecurityGroupRule__checks.go
- main.go