Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.Types.IpamScope

Description

Synopsis

data IpamScope = IpamScope' {
- description :: Maybe Text
- ipamArn :: Maybe Text
- ipamRegion :: Maybe Text
- ipamScopeArn :: Maybe Text
- ipamScopeId :: Maybe Text
- ipamScopeType :: Maybe IpamScopeType
- isDefault :: Maybe Bool
- ownerId :: Maybe Text
- poolCount :: Maybe Int
- state :: Maybe IpamScopeState
- tags :: Maybe [Tag]
}
newIpamScope :: IpamScope
ipamScope_description :: Lens' IpamScope (Maybe Text)
ipamScope_ipamArn :: Lens' IpamScope (Maybe Text)
ipamScope_ipamRegion :: Lens' IpamScope (Maybe Text)
ipamScope_ipamScopeArn :: Lens' IpamScope (Maybe Text)
ipamScope_ipamScopeId :: Lens' IpamScope (Maybe Text)
ipamScope_ipamScopeType :: Lens' IpamScope (Maybe IpamScopeType)
ipamScope_isDefault :: Lens' IpamScope (Maybe Bool)
ipamScope_ownerId :: Lens' IpamScope (Maybe Text)
ipamScope_poolCount :: Lens' IpamScope (Maybe Int)
ipamScope_state :: Lens' IpamScope (Maybe IpamScopeState)
ipamScope_tags :: Lens' IpamScope (Maybe [Tag])

Documentation

data IpamScope Source #

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

See: newIpamScope smart constructor.

Constructors

IpamScope'

Fields

description :: Maybe Text
The description of the scope.
ipamArn :: Maybe Text
The ARN of the IPAM.
ipamRegion :: Maybe Text
The Amazon Web Services Region of the IPAM scope.
ipamScopeArn :: Maybe Text
The ARN of the scope.
ipamScopeId :: Maybe Text
The ID of the scope.
ipamScopeType :: Maybe IpamScopeType
The type of the scope.
isDefault :: Maybe Bool
Defines if the scope is the default scope or not.
ownerId :: Maybe Text
The Amazon Web Services account ID of the owner of the scope.
poolCount :: Maybe Int
The number of pools in the scope.
state :: Maybe IpamScopeState
The state of the IPAM scope.
tags :: Maybe [Tag]
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Instances

Instances details

FromXML IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Methods parseXML :: [Node] -> Either String IpamScope #
Generic IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Associated Types type Rep IpamScope :: Type -> Type # Methods from :: IpamScope -> Rep IpamScope x # to :: Rep IpamScope x -> IpamScope #
Read IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Methods readsPrec :: Int -> ReadS IpamScope # readList :: ReadS [IpamScope] # readPrec :: ReadPrec IpamScope # readListPrec :: ReadPrec [IpamScope] #
Show IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Methods showsPrec :: Int -> IpamScope -> ShowS # show :: IpamScope -> String # showList :: [IpamScope] -> ShowS #
NFData IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Methods rnf :: IpamScope -> () #
Eq IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Methods (==) :: IpamScope -> IpamScope -> Bool # (/=) :: IpamScope -> IpamScope -> Bool #
Hashable IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope Methods hashWithSalt :: Int -> IpamScope -> Int # hash :: IpamScope -> Int #
type Rep IpamScope Source #
Instance details Defined in Amazonka.EC2.Types.IpamScope type Rep IpamScope = D1 ('MetaData "IpamScope" "Amazonka.EC2.Types.IpamScope" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "IpamScope'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ipamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ipamRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ipamScopeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ipamScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "ipamScopeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamScopeType)) :: (S1 ('MetaSel ('Just "isDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "poolCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamScopeState)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newIpamScope :: IpamScope Source #

Create a value of IpamScope with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:IpamScope', ipamScope_description - The description of the scope.

$sel:ipamArn:IpamScope', ipamScope_ipamArn - The ARN of the IPAM.

$sel:ipamRegion:IpamScope', ipamScope_ipamRegion - The Amazon Web Services Region of the IPAM scope.

$sel:ipamScopeArn:IpamScope', ipamScope_ipamScopeArn - The ARN of the scope.

$sel:ipamScopeId:IpamScope', ipamScope_ipamScopeId - The ID of the scope.

$sel:ipamScopeType:IpamScope', ipamScope_ipamScopeType - The type of the scope.

$sel:isDefault:IpamScope', ipamScope_isDefault - Defines if the scope is the default scope or not.

$sel:ownerId:IpamScope', ipamScope_ownerId - The Amazon Web Services account ID of the owner of the scope.

$sel:poolCount:IpamScope', ipamScope_poolCount - The number of pools in the scope.

$sel:state:IpamScope', ipamScope_state - The state of the IPAM scope.

$sel:tags:IpamScope', ipamScope_tags - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

ipamScope_description :: Lens' IpamScope (Maybe Text) Source #

The description of the scope.

ipamScope_ipamArn :: Lens' IpamScope (Maybe Text) Source #

The ARN of the IPAM.

ipamScope_ipamRegion :: Lens' IpamScope (Maybe Text) Source #

The Amazon Web Services Region of the IPAM scope.

ipamScope_ipamScopeArn :: Lens' IpamScope (Maybe Text) Source #

The ARN of the scope.

ipamScope_ipamScopeId :: Lens' IpamScope (Maybe Text) Source #

The ID of the scope.

ipamScope_ipamScopeType :: Lens' IpamScope (Maybe IpamScopeType) Source #

The type of the scope.

ipamScope_isDefault :: Lens' IpamScope (Maybe Bool) Source #

Defines if the scope is the default scope or not.

ipamScope_ownerId :: Lens' IpamScope (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the scope.

ipamScope_poolCount :: Lens' IpamScope (Maybe Int) Source #

The number of pools in the scope.

ipamScope_state :: Lens' IpamScope (Maybe IpamScopeState) Source #

The state of the IPAM scope.

ipamScope_tags :: Lens' IpamScope (Maybe [Tag]) Source #

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.