Skip to main content

SecurityGroupSchema

The SecurityGroupSchema class is the schema for the SecurityGroup resource, which represents the AWS VPC Security Group resource. This resource can create a security group in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/SecurityGroup

@overrideProperty

parents - This resource has parents.

@overrideProperty

resourceId - The resource id is of format sec-grp-<region-id>-<security-group-name>

Hierarchy

  • BaseResourceSchema
    • SecurityGroupSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; awsRegionId: string; rules: SecurityGroupRuleSchema[] } = ...

Input properties.

  • properties.awsAccountId - The AWS account id.
  • properties.awsRegionId - The AWS region id.
  • properties.rules - The security group rules. See SecurityGroupRuleSchema for options.

Type declaration

inheritedresourceId

resourceId: string

response

response: { Arn?: string; GroupId?: string; Rules?: { egress: undefined | SecurityGroupRule[]; ingress: undefined | SecurityGroupRule[] } } = ...

Saved response.

  • response.Arn - The security group arn.
  • response.GroupId - The security group id.
  • response.Rules - The security group rules. It has an egress and ingress array, whose values correspond to the output from the AWS SDK V3.

Type declaration

  • optionalArn?: string
  • optionalGroupId?: string
  • optionalRules?: { egress: undefined | SecurityGroupRule[]; ingress: undefined | SecurityGroupRule[] }
    • egress: undefined | SecurityGroupRule[]
    • ingress: undefined | SecurityGroupRule[]

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options