/AWS1/CL_SDYNAMESPACE¶
A complex type that contains information about a specified namespace.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_id
TYPE /AWS1/SDYRESOURCEID
/AWS1/SDYRESOURCEID
¶
The ID of a namespace.
iv_arn
TYPE /AWS1/SDYARN
/AWS1/SDYARN
¶
The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
iv_resourceowner
TYPE /AWS1/SDYAWSACCOUNTID
/AWS1/SDYAWSACCOUNTID
¶
The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
iv_name
TYPE /AWS1/SDYNAMESPACENAME
/AWS1/SDYNAMESPACENAME
¶
The name of the namespace, such as
example.com
.
iv_type
TYPE /AWS1/SDYNAMESPACETYPE
/AWS1/SDYNAMESPACETYPE
¶
The type of the namespace. The methods for discovering instances depends on the value that you specify:
- HTTP
Instances can be discovered only programmatically, using the Cloud Map
DiscoverInstances
API.- DNS_PUBLIC
Instances can be discovered using public DNS queries and using the
DiscoverInstances
API.- DNS_PRIVATE
Instances can be discovered using DNS queries in VPCs and using the
DiscoverInstances
API.
iv_description
TYPE /AWS1/SDYRESOURCEDESCRIPTION
/AWS1/SDYRESOURCEDESCRIPTION
¶
The description that you specify for the namespace when you create it.
iv_servicecount
TYPE /AWS1/SDYRESOURCECOUNT
/AWS1/SDYRESOURCECOUNT
¶
The number of services that are associated with the namespace.
io_properties
TYPE REF TO /AWS1/CL_SDYNAMESPACEPRPS
/AWS1/CL_SDYNAMESPACEPRPS
¶
A complex type that contains information that's specific to the type of the namespace.
iv_createdate
TYPE /AWS1/SDYTIMESTAMP
/AWS1/SDYTIMESTAMP
¶
The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of
CreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
iv_creatorrequestid
TYPE /AWS1/SDYRESOURCEID
/AWS1/SDYRESOURCEID
¶
A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.
Queryable Attributes¶
Id¶
The ID of a namespace.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
Arn¶
The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
ResourceOwner¶
The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_RESOURCEOWNER() |
Getter for RESOURCEOWNER, with configurable default |
ASK_RESOURCEOWNER() |
Getter for RESOURCEOWNER w/ exceptions if field has no value |
HAS_RESOURCEOWNER() |
Determine if RESOURCEOWNER has a value |
Name¶
The name of the namespace, such as
example.com
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Type¶
The type of the namespace. The methods for discovering instances depends on the value that you specify:
- HTTP
Instances can be discovered only programmatically, using the Cloud Map
DiscoverInstances
API.- DNS_PUBLIC
Instances can be discovered using public DNS queries and using the
DiscoverInstances
API.- DNS_PRIVATE
Instances can be discovered using DNS queries in VPCs and using the
DiscoverInstances
API.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
Description¶
The description that you specify for the namespace when you create it.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
ServiceCount¶
The number of services that are associated with the namespace.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SERVICECOUNT() |
Getter for SERVICECOUNT, with configurable default |
ASK_SERVICECOUNT() |
Getter for SERVICECOUNT w/ exceptions if field has no value |
HAS_SERVICECOUNT() |
Determine if SERVICECOUNT has a value |
Properties¶
A complex type that contains information that's specific to the type of the namespace.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PROPERTIES() |
Getter for PROPERTIES |
CreateDate¶
The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of
CreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CREATEDATE() |
Getter for CREATEDATE, with configurable default |
ASK_CREATEDATE() |
Getter for CREATEDATE w/ exceptions if field has no value |
HAS_CREATEDATE() |
Determine if CREATEDATE has a value |
CreatorRequestId¶
A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CREATORREQUESTID() |
Getter for CREATORREQUESTID, with configurable default |
ASK_CREATORREQUESTID() |
Getter for CREATORREQUESTID w/ exceptions if field has no va |
HAS_CREATORREQUESTID() |
Determine if CREATORREQUESTID has a value |