Amazonka.EC2.Types.Ipam

Documentation

data Ipam

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

See: newIpam smart constructor.

Constructors

Ipam'

Fields

• description :: Maybe Text

  The description for the IPAM.

• ipamArn :: Maybe Text

  The ARN of the IPAM.

• ipamId :: Maybe Text

  The ID of the IPAM.

• ipamRegion :: Maybe Text

  The Amazon Web Services Region of the IPAM.

• operatingRegions :: Maybe [IpamOperatingRegion]

  The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

  For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

• ownerId :: Maybe Text

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

• privateDefaultScopeId :: Maybe Text

  The ID of the IPAM's default private scope.

• publicDefaultScopeId :: Maybe Text

  The ID of the IPAM's default public scope.

• scopeCount :: Maybe Int

  The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

• state :: Maybe IpamState

  The state of the IPAM.

• 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

FromXML Ipam

Defined in Amazonka.EC2.Types.Ipam

Methods

parseXML :: [Node] -> Either String Ipam

Generic Ipam

Defined in Amazonka.EC2.Types.Ipam

Associated Types

type Rep Ipam :: Type -> Type

Methods

from :: Ipam -> Rep Ipam x

to :: Rep Ipam x -> Ipam

Read Ipam

Defined in Amazonka.EC2.Types.Ipam

Methods

readsPrec :: Int -> ReadS Ipam

readList :: ReadS [Ipam]

readPrec :: ReadPrec Ipam

readListPrec :: ReadPrec [Ipam]

Show Ipam

Defined in Amazonka.EC2.Types.Ipam

Methods

showsPrec :: Int -> Ipam -> ShowS

show :: Ipam -> String

showList :: [Ipam] -> ShowS

NFData Ipam

Defined in Amazonka.EC2.Types.Ipam

Methods

rnf :: Ipam -> ()

Eq Ipam

Defined in Amazonka.EC2.Types.Ipam

Methods

(==) :: Ipam -> Ipam -> Bool

(/=) :: Ipam -> Ipam -> Bool

Hashable Ipam

Defined in Amazonka.EC2.Types.Ipam

Methods

hashWithSalt :: Int -> Ipam -> Int

hash :: Ipam -> Int

type Rep Ipam

Defined in Amazonka.EC2.Types.Ipam

type Rep Ipam = D1 ('MetaData "Ipam" "Amazonka.EC2.Types.Ipam" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "Ipam'" '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 "ipamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ipamRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "operatingRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IpamOperatingRegion]))))) :*: ((S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "privateDefaultScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicDefaultScopeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "scopeCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpamState)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newIpam :: Ipam

Create a value of Ipam 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:Ipam', ipam_description - The description for the IPAM.

$sel:ipamArn:Ipam', ipam_ipamArn - The ARN of the IPAM.

$sel:ipamId:Ipam', ipam_ipamId - The ID of the IPAM.

$sel:ipamRegion:Ipam', ipam_ipamRegion - The Amazon Web Services Region of the IPAM.

$sel:operatingRegions:Ipam', ipam_operatingRegions - The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

$sel:ownerId:Ipam', ipam_ownerId - The Amazon Web Services account ID of the owner of the IPAM.

$sel:privateDefaultScopeId:Ipam', ipam_privateDefaultScopeId - The ID of the IPAM's default private scope.

$sel:publicDefaultScopeId:Ipam', ipam_publicDefaultScopeId - The ID of the IPAM's default public scope.

$sel:scopeCount:Ipam', ipam_scopeCount - The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

$sel:state:Ipam', ipam_state - The state of the IPAM.

$sel:tags:Ipam', ipam_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.

ipam_description :: Lens' Ipam (Maybe Text)

The description for the IPAM.

ipam_ipamArn :: Lens' Ipam (Maybe Text)

The ARN of the IPAM.

ipam_ipamId :: Lens' Ipam (Maybe Text)

The ID of the IPAM.

ipam_ipamRegion :: Lens' Ipam (Maybe Text)

The Amazon Web Services Region of the IPAM.

ipam_operatingRegions :: Lens' Ipam (Maybe [IpamOperatingRegion])

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

ipam_ownerId :: Lens' Ipam (Maybe Text)

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

ipam_privateDefaultScopeId :: Lens' Ipam (Maybe Text)

The ID of the IPAM's default private scope.

ipam_publicDefaultScopeId :: Lens' Ipam (Maybe Text)

The ID of the IPAM's default public scope.

ipam_scopeCount :: Lens' Ipam (Maybe Int)

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

ipam_state :: Lens' Ipam (Maybe IpamState)

The state of the IPAM.

ipam_tags :: Lens' Ipam (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.