fms

Documentation

Overview

Package fms provides CloudFormation resources for AWS FMS.

Index

• type AccountRoleStatus
• type CustomerPolicyScopeIdType
• type CustomerPolicyStatus
• type DependentServiceName
• type DestinationType
• type EntryType
• type EntryViolationReason
• type FailedItemReason
• type FirewallDeploymentModel
• type MarketplaceSubscriptionOnboardingStatus
• type NetworkAclRuleAction
• type NetworkFirewallOverrideAction
• type NotificationChannel
  • func (r NotificationChannel) ResourceType() string
• type OrganizationStatus
• type Policy
  • func (r Policy) ResourceType() string
• type PolicyComplianceStatusType
• type Policy_IEMap
• type Policy_IcmpTypeCode
• type Policy_NetworkAclCommonPolicy
• type Policy_NetworkAclEntry
• type Policy_NetworkAclEntrySet
• type Policy_NetworkFirewallPolicy
• type Policy_PolicyOption
• type Policy_PolicyTag
• type Policy_PortRange
• type Policy_ResourceTag
• type Policy_SecurityServicePolicyData
• type Policy_ThirdPartyFirewallPolicy
• type RemediationActionType
• type ResourceSet
  • func (r ResourceSet) ResourceType() string
• type ResourceSetStatus
• type ResourceTagLogicalOperator
• type RuleOrder
• type SecurityServiceType
• type StreamExceptionPolicy
• type Tag
• type TargetType
• type ThirdPartyFirewall
• type ThirdPartyFirewallAssociationStatus
• type ViolationReason

Types

type AccountRoleStatus

type AccountRoleStatus string

AccountRoleStatus represents valid values for AccountRoleStatus.

const (
	AccountRoleStatusReady           AccountRoleStatus = "READY"
	AccountRoleStatusCreating        AccountRoleStatus = "CREATING"
	AccountRoleStatusPendingDeletion AccountRoleStatus = "PENDING_DELETION"
	AccountRoleStatusDeleting        AccountRoleStatus = "DELETING"
	AccountRoleStatusDeleted         AccountRoleStatus = "DELETED"
)

type CustomerPolicyScopeIdType

type CustomerPolicyScopeIdType string

CustomerPolicyScopeIdType represents valid values for CustomerPolicyScopeIdType.

const (
	CustomerPolicyScopeIdTypeAccount CustomerPolicyScopeIdType = "ACCOUNT"
	CustomerPolicyScopeIdTypeOrgUnit CustomerPolicyScopeIdType = "ORG_UNIT"
)

type CustomerPolicyStatus

type CustomerPolicyStatus string

CustomerPolicyStatus represents valid values for CustomerPolicyStatus.

const (
	CustomerPolicyStatusActive          CustomerPolicyStatus = "ACTIVE"
	CustomerPolicyStatusOutOfAdminScope CustomerPolicyStatus = "OUT_OF_ADMIN_SCOPE"
)

type DependentServiceName

type DependentServiceName string

DependentServiceName represents valid values for DependentServiceName.

const (
	DependentServiceNameAwsconfig         DependentServiceName = "AWSCONFIG"
	DependentServiceNameAwswaf            DependentServiceName = "AWSWAF"
	DependentServiceNameAwsshieldAdvanced DependentServiceName = "AWSSHIELD_ADVANCED"
	DependentServiceNameAwsvpc            DependentServiceName = "AWSVPC"
)

type DestinationType

type DestinationType string

DestinationType represents valid values for DestinationType.

const (
	DestinationTypeIpv4       DestinationType = "IPV4"
	DestinationTypeIpv6       DestinationType = "IPV6"
	DestinationTypePrefixList DestinationType = "PREFIX_LIST"
)

type EntryType

type EntryType string

EntryType represents valid values for EntryType.

const (
	EntryTypeFmsManagedFirstEntry EntryType = "FMS_MANAGED_FIRST_ENTRY"
	EntryTypeFmsManagedLastEntry  EntryType = "FMS_MANAGED_LAST_ENTRY"
	EntryTypeCustomEntry          EntryType = "CUSTOM_ENTRY"
)

type EntryViolationReason

type EntryViolationReason string

EntryViolationReason represents valid values for EntryViolationReason.

const (
	EntryViolationReasonMissingExpectedEntry EntryViolationReason = "MISSING_EXPECTED_ENTRY"
	EntryViolationReasonIncorrectEntryOrder  EntryViolationReason = "INCORRECT_ENTRY_ORDER"
	EntryViolationReasonEntryConflict        EntryViolationReason = "ENTRY_CONFLICT"
)

type FailedItemReason

type FailedItemReason string

FailedItemReason represents valid values for FailedItemReason.

const (
	FailedItemReasonNotValidArn          FailedItemReason = "NOT_VALID_ARN"
	FailedItemReasonNotValidPartition    FailedItemReason = "NOT_VALID_PARTITION"
	FailedItemReasonNotValidRegion       FailedItemReason = "NOT_VALID_REGION"
	FailedItemReasonNotValidService      FailedItemReason = "NOT_VALID_SERVICE"
	FailedItemReasonNotValidResourceType FailedItemReason = "NOT_VALID_RESOURCE_TYPE"
	FailedItemReasonNotValidAccountId    FailedItemReason = "NOT_VALID_ACCOUNT_ID"
)

type FirewallDeploymentModel

type FirewallDeploymentModel string

FirewallDeploymentModel represents valid values for FirewallDeploymentModel.

const (
	FirewallDeploymentModelCentralized FirewallDeploymentModel = "CENTRALIZED"
	FirewallDeploymentModelDistributed FirewallDeploymentModel = "DISTRIBUTED"
)

type MarketplaceSubscriptionOnboardingStatus

type MarketplaceSubscriptionOnboardingStatus string

MarketplaceSubscriptionOnboardingStatus represents valid values for MarketplaceSubscriptionOnboardingStatus.

const (
	MarketplaceSubscriptionOnboardingStatusNoSubscription MarketplaceSubscriptionOnboardingStatus = "NO_SUBSCRIPTION"
	MarketplaceSubscriptionOnboardingStatusNotComplete    MarketplaceSubscriptionOnboardingStatus = "NOT_COMPLETE"
	MarketplaceSubscriptionOnboardingStatusComplete       MarketplaceSubscriptionOnboardingStatus = "COMPLETE"
)

type NetworkAclRuleAction

type NetworkAclRuleAction string

NetworkAclRuleAction represents valid values for NetworkAclRuleAction.

const (
	NetworkAclRuleActionAllow NetworkAclRuleAction = "allow"
	NetworkAclRuleActionDeny  NetworkAclRuleAction = "deny"
)

type NetworkFirewallOverrideAction

type NetworkFirewallOverrideAction string

NetworkFirewallOverrideAction represents valid values for NetworkFirewallOverrideAction.

const (
	NetworkFirewallOverrideActionDropToAlert NetworkFirewallOverrideAction = "DROP_TO_ALERT"
)

type NotificationChannel

type NotificationChannel struct {

	// Properties
	SnsRoleName any `json:"SnsRoleName,omitempty"`
	SnsTopicArn any `json:"SnsTopicArn,omitempty"`
}

func (NotificationChannel) ResourceType

func (r NotificationChannel) ResourceType() string

ResourceType returns the CloudFormation resource type.

type OrganizationStatus

type OrganizationStatus string

OrganizationStatus represents valid values for OrganizationStatus.

const (
	OrganizationStatusOnboarding          OrganizationStatus = "ONBOARDING"
	OrganizationStatusOnboardingComplete  OrganizationStatus = "ONBOARDING_COMPLETE"
	OrganizationStatusOffboarding         OrganizationStatus = "OFFBOARDING"
	OrganizationStatusOffboardingComplete OrganizationStatus = "OFFBOARDING_COMPLETE"
)

type Policy

type Policy struct {
	// Attributes for Fn::GetAtt
	Arn wetwire.AttrRef `json:"-"`
	Id  wetwire.AttrRef `json:"-"`

	// Properties
	DeleteAllPolicyResources   any                              `json:"DeleteAllPolicyResources,omitempty"`
	ExcludeMap                 any                              `json:"ExcludeMap,omitempty"`
	ExcludeResourceTags        any                              `json:"ExcludeResourceTags,omitempty"`
	IncludeMap                 any                              `json:"IncludeMap,omitempty"`
	PolicyDescription          any                              `json:"PolicyDescription,omitempty"`
	PolicyName                 any                              `json:"PolicyName,omitempty"`
	RemediationEnabled         any                              `json:"RemediationEnabled,omitempty"`
	ResourceSetIds             []any                            `json:"ResourceSetIds,omitempty"`
	ResourceTagLogicalOperator any                              `json:"ResourceTagLogicalOperator,omitempty"`
	ResourceTags               []any                            `json:"ResourceTags,omitempty"`
	ResourceTypeProp           any                              `json:"ResourceType,omitempty"`
	ResourceTypeList           []any                            `json:"ResourceTypeList,omitempty"`
	ResourcesCleanUp           any                              `json:"ResourcesCleanUp,omitempty"`
	SecurityServicePolicyData  Policy_SecurityServicePolicyData `json:"SecurityServicePolicyData,omitempty"`
	Tags                       []any                            `json:"Tags,omitempty"`
}

func (Policy) ResourceType

func (r Policy) ResourceType() string

ResourceType returns the CloudFormation resource type.

type PolicyComplianceStatusType

type PolicyComplianceStatusType string

PolicyComplianceStatusType represents valid values for PolicyComplianceStatusType.

const (
	PolicyComplianceStatusTypeCompliant    PolicyComplianceStatusType = "COMPLIANT"
	PolicyComplianceStatusTypeNonCompliant PolicyComplianceStatusType = "NON_COMPLIANT"
)

type Policy_IEMap

type Policy_IEMap struct {
	ACCOUNT []any `json:"ACCOUNT,omitempty"`
	ORGUNIT []any `json:"ORGUNIT,omitempty"`
}

Policy_IEMap represents AWS::FMS::Policy.IEMap.

type Policy_IcmpTypeCode

type Policy_IcmpTypeCode struct {
	Code  any `json:"Code,omitempty"`
	Type_ any `json:"Type,omitempty"`
}

Policy_IcmpTypeCode represents AWS::FMS::Policy.IcmpTypeCode.

type Policy_NetworkAclCommonPolicy

type Policy_NetworkAclCommonPolicy struct {
	NetworkAclEntrySet Policy_NetworkAclEntrySet `json:"NetworkAclEntrySet,omitempty"`
}

Policy_NetworkAclCommonPolicy represents AWS::FMS::Policy.NetworkAclCommonPolicy.

type Policy_NetworkAclEntry

type Policy_NetworkAclEntry struct {
	CidrBlock     any `json:"CidrBlock,omitempty"`
	Egress        any `json:"Egress,omitempty"`
	IcmpTypeCode  any `json:"IcmpTypeCode,omitempty"`
	Ipv6CidrBlock any `json:"Ipv6CidrBlock,omitempty"`
	PortRange     any `json:"PortRange,omitempty"`
	Protocol      any `json:"Protocol,omitempty"`
	RuleAction    any `json:"RuleAction,omitempty"`
}

Policy_NetworkAclEntry represents AWS::FMS::Policy.NetworkAclEntry.

type Policy_NetworkAclEntrySet

type Policy_NetworkAclEntrySet struct {
	FirstEntries                  []any `json:"FirstEntries,omitempty"`
	ForceRemediateForFirstEntries any   `json:"ForceRemediateForFirstEntries,omitempty"`
	ForceRemediateForLastEntries  any   `json:"ForceRemediateForLastEntries,omitempty"`
	LastEntries                   []any `json:"LastEntries,omitempty"`
}

Policy_NetworkAclEntrySet represents AWS::FMS::Policy.NetworkAclEntrySet.

type Policy_NetworkFirewallPolicy

type Policy_NetworkFirewallPolicy struct {
	FirewallDeploymentModel any `json:"FirewallDeploymentModel,omitempty"`
}

Policy_NetworkFirewallPolicy represents AWS::FMS::Policy.NetworkFirewallPolicy.

type Policy_PolicyOption

type Policy_PolicyOption struct {
	NetworkAclCommonPolicy   any `json:"NetworkAclCommonPolicy,omitempty"`
	NetworkFirewallPolicy    any `json:"NetworkFirewallPolicy,omitempty"`
	ThirdPartyFirewallPolicy any `json:"ThirdPartyFirewallPolicy,omitempty"`
}

Policy_PolicyOption represents AWS::FMS::Policy.PolicyOption.

type Policy_PolicyTag

type Policy_PolicyTag struct {
	Key   any `json:"Key,omitempty"`
	Value any `json:"Value,omitempty"`
}

Policy_PolicyTag represents AWS::FMS::Policy.PolicyTag.

type Policy_PortRange

type Policy_PortRange struct {
	From any `json:"From,omitempty"`
	To   any `json:"To,omitempty"`
}

Policy_PortRange represents AWS::FMS::Policy.PortRange.

type Policy_ResourceTag

type Policy_ResourceTag struct {
	Key   any `json:"Key,omitempty"`
	Value any `json:"Value,omitempty"`
}

Policy_ResourceTag represents AWS::FMS::Policy.ResourceTag.

type Policy_SecurityServicePolicyData

type Policy_SecurityServicePolicyData struct {
	ManagedServiceData any `json:"ManagedServiceData,omitempty"`
	PolicyOption       any `json:"PolicyOption,omitempty"`
	Type_              any `json:"Type,omitempty"`
}

Policy_SecurityServicePolicyData represents AWS::FMS::Policy.SecurityServicePolicyData.

type Policy_ThirdPartyFirewallPolicy

type Policy_ThirdPartyFirewallPolicy struct {
	FirewallDeploymentModel any `json:"FirewallDeploymentModel,omitempty"`
}

Policy_ThirdPartyFirewallPolicy represents AWS::FMS::Policy.ThirdPartyFirewallPolicy.

type RemediationActionType

type RemediationActionType string

RemediationActionType represents valid values for RemediationActionType.

const (
	RemediationActionTypeRemove RemediationActionType = "REMOVE"
	RemediationActionTypeModify RemediationActionType = "MODIFY"
)

type ResourceSet

type ResourceSet struct {
	// Attributes for Fn::GetAtt
	Id wetwire.AttrRef `json:"-"`

	// Properties
	Description      any   `json:"Description,omitempty"`
	Name             any   `json:"Name,omitempty"`
	ResourceTypeList []any `json:"ResourceTypeList,omitempty"`
	Resources        []any `json:"Resources,omitempty"`
	Tags             []any `json:"Tags,omitempty"`
}

func (ResourceSet) ResourceType

func (r ResourceSet) ResourceType() string

ResourceType returns the CloudFormation resource type.

type ResourceSetStatus

type ResourceSetStatus string

ResourceSetStatus represents valid values for ResourceSetStatus.

const (
	ResourceSetStatusActive          ResourceSetStatus = "ACTIVE"
	ResourceSetStatusOutOfAdminScope ResourceSetStatus = "OUT_OF_ADMIN_SCOPE"
)

type ResourceTagLogicalOperator

type ResourceTagLogicalOperator string

ResourceTagLogicalOperator represents valid values for ResourceTagLogicalOperator.

const (
	ResourceTagLogicalOperatorAnd ResourceTagLogicalOperator = "AND"
	ResourceTagLogicalOperatorOr  ResourceTagLogicalOperator = "OR"
)

type RuleOrder

type RuleOrder string

RuleOrder represents valid values for RuleOrder.

const (
	RuleOrderStrictOrder        RuleOrder = "STRICT_ORDER"
	RuleOrderDefaultActionOrder RuleOrder = "DEFAULT_ACTION_ORDER"
)

type SecurityServiceType

type SecurityServiceType string

SecurityServiceType represents valid values for SecurityServiceType.

const (
	SecurityServiceTypeWaf                        SecurityServiceType = "WAF"
	SecurityServiceTypeWafv2                      SecurityServiceType = "WAFV2"
	SecurityServiceTypeShieldAdvanced             SecurityServiceType = "SHIELD_ADVANCED"
	SecurityServiceTypeSecurityGroupsCommon       SecurityServiceType = "SECURITY_GROUPS_COMMON"
	SecurityServiceTypeSecurityGroupsContentAudit SecurityServiceType = "SECURITY_GROUPS_CONTENT_AUDIT"
	SecurityServiceTypeSecurityGroupsUsageAudit   SecurityServiceType = "SECURITY_GROUPS_USAGE_AUDIT"
	SecurityServiceTypeNetworkFirewall            SecurityServiceType = "NETWORK_FIREWALL"
	SecurityServiceTypeDnsFirewall                SecurityServiceType = "DNS_FIREWALL"
	SecurityServiceTypeThirdPartyFirewall         SecurityServiceType = "THIRD_PARTY_FIREWALL"
	SecurityServiceTypeImportNetworkFirewall      SecurityServiceType = "IMPORT_NETWORK_FIREWALL"
	SecurityServiceTypeNetworkAclCommon           SecurityServiceType = "NETWORK_ACL_COMMON"
)

type StreamExceptionPolicy

type StreamExceptionPolicy string

StreamExceptionPolicy represents valid values for StreamExceptionPolicy.

const (
	StreamExceptionPolicyDrop      StreamExceptionPolicy = "DROP"
	StreamExceptionPolicyContinue  StreamExceptionPolicy = "CONTINUE"
	StreamExceptionPolicyReject    StreamExceptionPolicy = "REJECT"
	StreamExceptionPolicyFmsIgnore StreamExceptionPolicy = "FMS_IGNORE"
)

type Tag

type Tag struct {
	Key   string `json:"Key"`
	Value any    `json:"Value"`
}

Tag represents a CloudFormation tag. This is a shared type used across all services.

type TargetType

type TargetType string

TargetType represents valid values for TargetType.

const (
	TargetTypeGateway                   TargetType = "GATEWAY"
	TargetTypeCarrierGateway            TargetType = "CARRIER_GATEWAY"
	TargetTypeInstance                  TargetType = "INSTANCE"
	TargetTypeLocalGateway              TargetType = "LOCAL_GATEWAY"
	TargetTypeNatGateway                TargetType = "NAT_GATEWAY"
	TargetTypeNetworkInterface          TargetType = "NETWORK_INTERFACE"
	TargetTypeVpcEndpoint               TargetType = "VPC_ENDPOINT"
	TargetTypeVpcPeeringConnection      TargetType = "VPC_PEERING_CONNECTION"
	TargetTypeEgressOnlyInternetGateway TargetType = "EGRESS_ONLY_INTERNET_GATEWAY"
	TargetTypeTransitGateway            TargetType = "TRANSIT_GATEWAY"
)

type ThirdPartyFirewall

type ThirdPartyFirewall string

ThirdPartyFirewall represents valid values for ThirdPartyFirewall.

const (
	ThirdPartyFirewallPaloAltoNetworksCloudNgfw    ThirdPartyFirewall = "PALO_ALTO_NETWORKS_CLOUD_NGFW"
	ThirdPartyFirewallFortigateCloudNativeFirewall ThirdPartyFirewall = "FORTIGATE_CLOUD_NATIVE_FIREWALL"
)

type ThirdPartyFirewallAssociationStatus

type ThirdPartyFirewallAssociationStatus string

ThirdPartyFirewallAssociationStatus represents valid values for ThirdPartyFirewallAssociationStatus.

const (
	ThirdPartyFirewallAssociationStatusOnboarding       ThirdPartyFirewallAssociationStatus = "ONBOARDING"
	ThirdPartyFirewallAssociationStatusOnboardComplete  ThirdPartyFirewallAssociationStatus = "ONBOARD_COMPLETE"
	ThirdPartyFirewallAssociationStatusOffboarding      ThirdPartyFirewallAssociationStatus = "OFFBOARDING"
	ThirdPartyFirewallAssociationStatusOffboardComplete ThirdPartyFirewallAssociationStatus = "OFFBOARD_COMPLETE"
	ThirdPartyFirewallAssociationStatusNotExist         ThirdPartyFirewallAssociationStatus = "NOT_EXIST"
)

type ViolationReason

type ViolationReason string

ViolationReason represents valid values for ViolationReason.

const (
	ViolationReasonWebAclMissingRuleGroup                  ViolationReason = "WEB_ACL_MISSING_RULE_GROUP"
	ViolationReasonResourceMissingWebAcl                   ViolationReason = "RESOURCE_MISSING_WEB_ACL"
	ViolationReasonResourceIncorrectWebAcl                 ViolationReason = "RESOURCE_INCORRECT_WEB_ACL"
	ViolationReasonResourceMissingShieldProtection         ViolationReason = "RESOURCE_MISSING_SHIELD_PROTECTION"
	ViolationReasonResourceMissingWebAclOrShieldProtection ViolationReason = "RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION"
	ViolationReasonResourceMissingSecurityGroup            ViolationReason = "RESOURCE_MISSING_SECURITY_GROUP"
	ViolationReasonResourceViolatesAuditSecurityGroup      ViolationReason = "RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP"
	ViolationReasonSecurityGroupUnused                     ViolationReason = "SECURITY_GROUP_UNUSED"
	ViolationReasonSecurityGroupRedundant                  ViolationReason = "SECURITY_GROUP_REDUNDANT"
	ViolationReasonFmsCreatedSecurityGroupEdited           ViolationReason = "FMS_CREATED_SECURITY_GROUP_EDITED"
	ViolationReasonMissingFirewall                         ViolationReason = "MISSING_FIREWALL"
	ViolationReasonMissingFirewallSubnetInAz               ViolationReason = "MISSING_FIREWALL_SUBNET_IN_AZ"
	ViolationReasonMissingExpectedRouteTable               ViolationReason = "MISSING_EXPECTED_ROUTE_TABLE"
	ViolationReasonNetworkFirewallPolicyModified           ViolationReason = "NETWORK_FIREWALL_POLICY_MODIFIED"
	ViolationReasonFirewallSubnetIsOutOfScope              ViolationReason = "FIREWALL_SUBNET_IS_OUT_OF_SCOPE"
	ViolationReasonInternetGatewayMissingExpectedRoute     ViolationReason = "INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE"
	ViolationReasonFirewallSubnetMissingExpectedRoute      ViolationReason = "FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE"
	ViolationReasonUnexpectedFirewallRoutes                ViolationReason = "UNEXPECTED_FIREWALL_ROUTES"
	ViolationReasonUnexpectedTargetGatewayRoutes           ViolationReason = "UNEXPECTED_TARGET_GATEWAY_ROUTES"
	ViolationReasonTrafficInspectionCrossesAzBoundary      ViolationReason = "TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY"
	ViolationReasonInvalidRouteConfiguration               ViolationReason = "INVALID_ROUTE_CONFIGURATION"
	ViolationReasonMissingTargetGateway                    ViolationReason = "MISSING_TARGET_GATEWAY"
	ViolationReasonInternetTrafficNotInspected             ViolationReason = "INTERNET_TRAFFIC_NOT_INSPECTED"
	ViolationReasonBlackHoleRouteDetected                  ViolationReason = "BLACK_HOLE_ROUTE_DETECTED"
	ViolationReasonBlackHoleRouteDetectedInFirewallSubnet  ViolationReason = "BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET"
	ViolationReasonResourceMissingDnsFirewall              ViolationReason = "RESOURCE_MISSING_DNS_FIREWALL"
	ViolationReasonRouteHasOutOfScopeEndpoint              ViolationReason = "ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT"
	ViolationReasonFirewallSubnetMissingVpceEndpoint       ViolationReason = "FIREWALL_SUBNET_MISSING_VPCE_ENDPOINT"
	ViolationReasonInvalidNetworkAclEntry                  ViolationReason = "INVALID_NETWORK_ACL_ENTRY"
	ViolationReasonWebAclConfigurationOrScopeOfUse         ViolationReason = "WEB_ACL_CONFIGURATION_OR_SCOPE_OF_USE"
)