DosProtectionRule resource
Create DosProtectionRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DosProtectionRule(name: string, args?: DosProtectionRuleArgs, opts?: CustomResourceOptions);@overload
def DosProtectionRule(resource_name: str,
args: Optional[DosProtectionRuleArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def DosProtectionRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
action: Optional[DosProtectionRuleActionArgs] = None,
description: Optional[str] = None,
destinations: Optional[Sequence[str]] = None,
device: Optional[str] = None,
disabled: Optional[bool] = None,
folder: Optional[str] = None,
froms: Optional[Sequence[str]] = None,
log_setting: Optional[str] = None,
name: Optional[str] = None,
position: Optional[str] = None,
protection: Optional[DosProtectionRuleProtectionArgs] = None,
schedule: Optional[str] = None,
services: Optional[Sequence[str]] = None,
snippet: Optional[str] = None,
source_users: Optional[Sequence[str]] = None,
sources: Optional[Sequence[str]] = None,
tags: Optional[Sequence[str]] = None,
tos: Optional[Sequence[str]] = None)func NewDosProtectionRule(ctx *Context, name string, args *DosProtectionRuleArgs, opts ...ResourceOption) (*DosProtectionRule, error)public DosProtectionRule(string name, DosProtectionRuleArgs? args = null, CustomResourceOptions? opts = null)
public DosProtectionRule(String name, DosProtectionRuleArgs args)
public DosProtectionRule(String name, DosProtectionRuleArgs args, CustomResourceOptions options)
type: scm:DosProtectionRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DosProtectionRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DosProtectionRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DosProtectionRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DosProtectionRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DosProtectionRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dosProtectionRuleResource = new Scm.DosProtectionRule("dosProtectionRuleResource", new()
{
Action = new Scm.Inputs.DosProtectionRuleActionArgs
{
Allow = null,
Deny = null,
Protect = null,
},
Description = "string",
Destinations = new[]
{
"string",
},
Device = "string",
Disabled = false,
Folder = "string",
Froms = new[]
{
"string",
},
LogSetting = "string",
Name = "string",
Position = "string",
Protection = new Scm.Inputs.DosProtectionRuleProtectionArgs
{
Aggregate = new Scm.Inputs.DosProtectionRuleProtectionAggregateArgs
{
Profile = "string",
},
Classified = new Scm.Inputs.DosProtectionRuleProtectionClassifiedArgs
{
Profile = "string",
ClassificationCriteria = new Scm.Inputs.DosProtectionRuleProtectionClassifiedClassificationCriteriaArgs
{
Address = "string",
},
},
},
Schedule = "string",
Services = new[]
{
"string",
},
Snippet = "string",
SourceUsers = new[]
{
"string",
},
Sources = new[]
{
"string",
},
Tags = new[]
{
"string",
},
Tos = new[]
{
"string",
},
});
example, err := scm.NewDosProtectionRule(ctx, "dosProtectionRuleResource", &scm.DosProtectionRuleArgs{
Action: &scm.DosProtectionRuleActionArgs{
Allow: &scm.DosProtectionRuleActionAllowArgs{},
Deny: &scm.DosProtectionRuleActionDenyArgs{},
Protect: &scm.DosProtectionRuleActionProtectArgs{},
},
Description: pulumi.String("string"),
Destinations: pulumi.StringArray{
pulumi.String("string"),
},
Device: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Folder: pulumi.String("string"),
Froms: pulumi.StringArray{
pulumi.String("string"),
},
LogSetting: pulumi.String("string"),
Name: pulumi.String("string"),
Position: pulumi.String("string"),
Protection: &scm.DosProtectionRuleProtectionArgs{
Aggregate: &scm.DosProtectionRuleProtectionAggregateArgs{
Profile: pulumi.String("string"),
},
Classified: &scm.DosProtectionRuleProtectionClassifiedArgs{
Profile: pulumi.String("string"),
ClassificationCriteria: &scm.DosProtectionRuleProtectionClassifiedClassificationCriteriaArgs{
Address: pulumi.String("string"),
},
},
},
Schedule: pulumi.String("string"),
Services: pulumi.StringArray{
pulumi.String("string"),
},
Snippet: pulumi.String("string"),
SourceUsers: pulumi.StringArray{
pulumi.String("string"),
},
Sources: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Tos: pulumi.StringArray{
pulumi.String("string"),
},
})
var dosProtectionRuleResource = new DosProtectionRule("dosProtectionRuleResource", DosProtectionRuleArgs.builder()
.action(DosProtectionRuleActionArgs.builder()
.allow(DosProtectionRuleActionAllowArgs.builder()
.build())
.deny(DosProtectionRuleActionDenyArgs.builder()
.build())
.protect(DosProtectionRuleActionProtectArgs.builder()
.build())
.build())
.description("string")
.destinations("string")
.device("string")
.disabled(false)
.folder("string")
.froms("string")
.logSetting("string")
.name("string")
.position("string")
.protection(DosProtectionRuleProtectionArgs.builder()
.aggregate(DosProtectionRuleProtectionAggregateArgs.builder()
.profile("string")
.build())
.classified(DosProtectionRuleProtectionClassifiedArgs.builder()
.profile("string")
.classificationCriteria(DosProtectionRuleProtectionClassifiedClassificationCriteriaArgs.builder()
.address("string")
.build())
.build())
.build())
.schedule("string")
.services("string")
.snippet("string")
.sourceUsers("string")
.sources("string")
.tags("string")
.tos("string")
.build());
dos_protection_rule_resource = scm.DosProtectionRule("dosProtectionRuleResource",
action={
"allow": {},
"deny": {},
"protect": {},
},
description="string",
destinations=["string"],
device="string",
disabled=False,
folder="string",
froms=["string"],
log_setting="string",
name="string",
position="string",
protection={
"aggregate": {
"profile": "string",
},
"classified": {
"profile": "string",
"classification_criteria": {
"address": "string",
},
},
},
schedule="string",
services=["string"],
snippet="string",
source_users=["string"],
sources=["string"],
tags=["string"],
tos=["string"])
const dosProtectionRuleResource = new scm.DosProtectionRule("dosProtectionRuleResource", {
action: {
allow: {},
deny: {},
protect: {},
},
description: "string",
destinations: ["string"],
device: "string",
disabled: false,
folder: "string",
froms: ["string"],
logSetting: "string",
name: "string",
position: "string",
protection: {
aggregate: {
profile: "string",
},
classified: {
profile: "string",
classificationCriteria: {
address: "string",
},
},
},
schedule: "string",
services: ["string"],
snippet: "string",
sourceUsers: ["string"],
sources: ["string"],
tags: ["string"],
tos: ["string"],
});
type: scm:DosProtectionRule
properties:
action:
allow: {}
deny: {}
protect: {}
description: string
destinations:
- string
device: string
disabled: false
folder: string
froms:
- string
logSetting: string
name: string
position: string
protection:
aggregate:
profile: string
classified:
classificationCriteria:
address: string
profile: string
schedule: string
services:
- string
snippet: string
sourceUsers:
- string
sources:
- string
tags:
- string
tos:
- string
DosProtectionRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DosProtectionRule resource accepts the following input properties:
- Action
Dos
Protection Rule Action - The action to take on rule match
- Description string
- Description
- Destinations List<string>
- List of destination addresses
- Device string
- The device in which the resource is defined
- Disabled bool
- Rule disabled?
- Folder string
- The folder in which the resource is defined
- Froms List<string>
- List of source zones
- Log
Setting string - Log forwarding profile name
- Name string
- Rule name
- Position string
- Position relative to local device rules
- Protection
Dos
Protection Rule Protection - Protection
- Schedule string
- Schedule on which to enforce the rule
- Services List<string>
- List of services
- Snippet string
- The snippet in which the resource is defined
- Source
Users List<string> - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - Sources List<string>
- List of source addresses
- List<string>
- List of tags
- Tos List<string>
- List of destination zones
- Action
Dos
Protection Rule Action Args - The action to take on rule match
- Description string
- Description
- Destinations []string
- List of destination addresses
- Device string
- The device in which the resource is defined
- Disabled bool
- Rule disabled?
- Folder string
- The folder in which the resource is defined
- Froms []string
- List of source zones
- Log
Setting string - Log forwarding profile name
- Name string
- Rule name
- Position string
- Position relative to local device rules
- Protection
Dos
Protection Rule Protection Args - Protection
- Schedule string
- Schedule on which to enforce the rule
- Services []string
- List of services
- Snippet string
- The snippet in which the resource is defined
- Source
Users []string - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - Sources []string
- List of source addresses
- []string
- List of tags
- Tos []string
- List of destination zones
- action
Dos
Protection Rule Action - The action to take on rule match
- description String
- Description
- destinations List<String>
- List of destination addresses
- device String
- The device in which the resource is defined
- disabled Boolean
- Rule disabled?
- folder String
- The folder in which the resource is defined
- froms List<String>
- List of source zones
- log
Setting String - Log forwarding profile name
- name String
- Rule name
- position String
- Position relative to local device rules
- protection
Dos
Protection Rule Protection - Protection
- schedule String
- Schedule on which to enforce the rule
- services List<String>
- List of services
- snippet String
- The snippet in which the resource is defined
- source
Users List<String> - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources List<String>
- List of source addresses
- List<String>
- List of tags
- tos List<String>
- List of destination zones
- action
Dos
Protection Rule Action - The action to take on rule match
- description string
- Description
- destinations string[]
- List of destination addresses
- device string
- The device in which the resource is defined
- disabled boolean
- Rule disabled?
- folder string
- The folder in which the resource is defined
- froms string[]
- List of source zones
- log
Setting string - Log forwarding profile name
- name string
- Rule name
- position string
- Position relative to local device rules
- protection
Dos
Protection Rule Protection - Protection
- schedule string
- Schedule on which to enforce the rule
- services string[]
- List of services
- snippet string
- The snippet in which the resource is defined
- source
Users string[] - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources string[]
- List of source addresses
- string[]
- List of tags
- tos string[]
- List of destination zones
- action
Dos
Protection Rule Action Args - The action to take on rule match
- description str
- Description
- destinations Sequence[str]
- List of destination addresses
- device str
- The device in which the resource is defined
- disabled bool
- Rule disabled?
- folder str
- The folder in which the resource is defined
- froms Sequence[str]
- List of source zones
- log_
setting str - Log forwarding profile name
- name str
- Rule name
- position str
- Position relative to local device rules
- protection
Dos
Protection Rule Protection Args - Protection
- schedule str
- Schedule on which to enforce the rule
- services Sequence[str]
- List of services
- snippet str
- The snippet in which the resource is defined
- source_
users Sequence[str] - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources Sequence[str]
- List of source addresses
- Sequence[str]
- List of tags
- tos Sequence[str]
- List of destination zones
- action Property Map
- The action to take on rule match
- description String
- Description
- destinations List<String>
- List of destination addresses
- device String
- The device in which the resource is defined
- disabled Boolean
- Rule disabled?
- folder String
- The folder in which the resource is defined
- froms List<String>
- List of source zones
- log
Setting String - Log forwarding profile name
- name String
- Rule name
- position String
- Position relative to local device rules
- protection Property Map
- Protection
- schedule String
- Schedule on which to enforce the rule
- services List<String>
- List of services
- snippet String
- The snippet in which the resource is defined
- source
Users List<String> - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources List<String>
- List of source addresses
- List<String>
- List of tags
- tos List<String>
- List of destination zones
Outputs
All input properties are implicitly available as output properties. Additionally, the DosProtectionRule resource produces the following output properties:
Look up Existing DosProtectionRule Resource
Get an existing DosProtectionRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DosProtectionRuleState, opts?: CustomResourceOptions): DosProtectionRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action: Optional[DosProtectionRuleActionArgs] = None,
description: Optional[str] = None,
destinations: Optional[Sequence[str]] = None,
device: Optional[str] = None,
disabled: Optional[bool] = None,
folder: Optional[str] = None,
froms: Optional[Sequence[str]] = None,
log_setting: Optional[str] = None,
name: Optional[str] = None,
position: Optional[str] = None,
protection: Optional[DosProtectionRuleProtectionArgs] = None,
schedule: Optional[str] = None,
services: Optional[Sequence[str]] = None,
snippet: Optional[str] = None,
source_users: Optional[Sequence[str]] = None,
sources: Optional[Sequence[str]] = None,
tags: Optional[Sequence[str]] = None,
tfid: Optional[str] = None,
tos: Optional[Sequence[str]] = None) -> DosProtectionRulefunc GetDosProtectionRule(ctx *Context, name string, id IDInput, state *DosProtectionRuleState, opts ...ResourceOption) (*DosProtectionRule, error)public static DosProtectionRule Get(string name, Input<string> id, DosProtectionRuleState? state, CustomResourceOptions? opts = null)public static DosProtectionRule get(String name, Output<String> id, DosProtectionRuleState state, CustomResourceOptions options)resources: _: type: scm:DosProtectionRule get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Action
Dos
Protection Rule Action - The action to take on rule match
- Description string
- Description
- Destinations List<string>
- List of destination addresses
- Device string
- The device in which the resource is defined
- Disabled bool
- Rule disabled?
- Folder string
- The folder in which the resource is defined
- Froms List<string>
- List of source zones
- Log
Setting string - Log forwarding profile name
- Name string
- Rule name
- Position string
- Position relative to local device rules
- Protection
Dos
Protection Rule Protection - Protection
- Schedule string
- Schedule on which to enforce the rule
- Services List<string>
- List of services
- Snippet string
- The snippet in which the resource is defined
- Source
Users List<string> - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - Sources List<string>
- List of source addresses
- List<string>
- List of tags
- Tfid string
- Tos List<string>
- List of destination zones
- Action
Dos
Protection Rule Action Args - The action to take on rule match
- Description string
- Description
- Destinations []string
- List of destination addresses
- Device string
- The device in which the resource is defined
- Disabled bool
- Rule disabled?
- Folder string
- The folder in which the resource is defined
- Froms []string
- List of source zones
- Log
Setting string - Log forwarding profile name
- Name string
- Rule name
- Position string
- Position relative to local device rules
- Protection
Dos
Protection Rule Protection Args - Protection
- Schedule string
- Schedule on which to enforce the rule
- Services []string
- List of services
- Snippet string
- The snippet in which the resource is defined
- Source
Users []string - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - Sources []string
- List of source addresses
- []string
- List of tags
- Tfid string
- Tos []string
- List of destination zones
- action
Dos
Protection Rule Action - The action to take on rule match
- description String
- Description
- destinations List<String>
- List of destination addresses
- device String
- The device in which the resource is defined
- disabled Boolean
- Rule disabled?
- folder String
- The folder in which the resource is defined
- froms List<String>
- List of source zones
- log
Setting String - Log forwarding profile name
- name String
- Rule name
- position String
- Position relative to local device rules
- protection
Dos
Protection Rule Protection - Protection
- schedule String
- Schedule on which to enforce the rule
- services List<String>
- List of services
- snippet String
- The snippet in which the resource is defined
- source
Users List<String> - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources List<String>
- List of source addresses
- List<String>
- List of tags
- tfid String
- tos List<String>
- List of destination zones
- action
Dos
Protection Rule Action - The action to take on rule match
- description string
- Description
- destinations string[]
- List of destination addresses
- device string
- The device in which the resource is defined
- disabled boolean
- Rule disabled?
- folder string
- The folder in which the resource is defined
- froms string[]
- List of source zones
- log
Setting string - Log forwarding profile name
- name string
- Rule name
- position string
- Position relative to local device rules
- protection
Dos
Protection Rule Protection - Protection
- schedule string
- Schedule on which to enforce the rule
- services string[]
- List of services
- snippet string
- The snippet in which the resource is defined
- source
Users string[] - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources string[]
- List of source addresses
- string[]
- List of tags
- tfid string
- tos string[]
- List of destination zones
- action
Dos
Protection Rule Action Args - The action to take on rule match
- description str
- Description
- destinations Sequence[str]
- List of destination addresses
- device str
- The device in which the resource is defined
- disabled bool
- Rule disabled?
- folder str
- The folder in which the resource is defined
- froms Sequence[str]
- List of source zones
- log_
setting str - Log forwarding profile name
- name str
- Rule name
- position str
- Position relative to local device rules
- protection
Dos
Protection Rule Protection Args - Protection
- schedule str
- Schedule on which to enforce the rule
- services Sequence[str]
- List of services
- snippet str
- The snippet in which the resource is defined
- source_
users Sequence[str] - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources Sequence[str]
- List of source addresses
- Sequence[str]
- List of tags
- tfid str
- tos Sequence[str]
- List of destination zones
- action Property Map
- The action to take on rule match
- description String
- Description
- destinations List<String>
- List of destination addresses
- device String
- The device in which the resource is defined
- disabled Boolean
- Rule disabled?
- folder String
- The folder in which the resource is defined
- froms List<String>
- List of source zones
- log
Setting String - Log forwarding profile name
- name String
- Rule name
- position String
- Position relative to local device rules
- protection Property Map
- Protection
- schedule String
- Schedule on which to enforce the rule
- services List<String>
- List of services
- snippet String
- The snippet in which the resource is defined
- source
Users List<String> - List of source users and/or groups. Reserved words include
any,pre-login,known-user, andunknown. - sources List<String>
- List of source addresses
- List<String>
- List of tags
- tfid String
- tos List<String>
- List of destination zones
Supporting Types
DosProtectionRuleAction, DosProtectionRuleActionArgs
- allow Property Map
- Allow
- deny Property Map
- Deny
- protect Property Map
- Protect
DosProtectionRuleProtection, DosProtectionRuleProtectionArgs
- aggregate Property Map
- Aggregate
- classified Property Map
- Classified
DosProtectionRuleProtectionAggregate, DosProtectionRuleProtectionAggregateArgs
- Profile string
- Aggregate DoS protection profile
- Profile string
- Aggregate DoS protection profile
- profile String
- Aggregate DoS protection profile
- profile string
- Aggregate DoS protection profile
- profile str
- Aggregate DoS protection profile
- profile String
- Aggregate DoS protection profile
DosProtectionRuleProtectionClassified, DosProtectionRuleProtectionClassifiedArgs
- Profile string
- Classified DoS protection profile
- Classification
Criteria DosProtection Rule Protection Classified Classification Criteria - Classification criteria
- Profile string
- Classified DoS protection profile
- Classification
Criteria DosProtection Rule Protection Classified Classification Criteria - Classification criteria
- profile String
- Classified DoS protection profile
- classification
Criteria DosProtection Rule Protection Classified Classification Criteria - Classification criteria
- profile string
- Classified DoS protection profile
- classification
Criteria DosProtection Rule Protection Classified Classification Criteria - Classification criteria
- profile str
- Classified DoS protection profile
- classification_
criteria DosProtection Rule Protection Classified Classification Criteria - Classification criteria
- profile String
- Classified DoS protection profile
- classification
Criteria Property Map - Classification criteria
DosProtectionRuleProtectionClassifiedClassificationCriteria, DosProtectionRuleProtectionClassifiedClassificationCriteriaArgs
- Address string
- Address
- Address string
- Address
- address String
- Address
- address string
- Address
- address str
- Address
- address String
- Address
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
