Documentation

AwsRoute53
in package
implements Client uses HasMethodBlacklistTrait

Table of Contents

Interfaces

Client

Properties

$defaultZoneId  : string
$methodBlacklist  : array<string|int, string>
$sdk  : Route53Client

Methods

__construct()  : mixed
Create a Horde\Dns\Client wrapper for Route53 SDK
createRecord()  : mixed
Create a single DNS record in an existing zone
createRecords()  : mixed
Delete multiple DNS records in an existing zone
deleteRecord()  : mixed
Delete a single DNS record in an existing zone
deleteRecords()  : mixed
Delete multiple DNS records in an existing zone
getDefaultZoneId()  : string
Return the default Zone ID
getSingleRecord()  : Record|null
Get a single record if it exists
getZone()  : Zone
Get a Zone by Id
getZoneRecords()  : array<string|int, Record>
Get a Zone's records by Zone Id
setDefaultZoneId()  : mixed
Set the default Zone ID
updateRecord()  : mixed
Update or create if missing a single DNS record
updateRecords()  : mixed
Update multiple DNS records in an existing zone
convertRecordSetsToRecords()  : array<string|int, Record>
Converts ResourceRecordSets to an array of Records
doActionForRecords()  : array<string|int, Result>
getChangeRequestQuery()  : array<string|int, mixed>
Gets the query for the changeResourceRecordSets api call in the correct format
getResourceRecordSetsIterator()  : iterable<string|int, mixed>
ResourceRecordSets Iterator that queries listResourceRecordSets until all results or maxResults are retrieved
methodIsBlacklisted()  : bool
setMethodBlacklist()  : mixed

Properties

Methods

__construct()

Create a Horde\Dns\Client wrapper for Route53 SDK

public __construct(Route53Client $sdk[, array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
$sdk : Route53Client
$parameters : array<string|int, mixed> = []

Parameters format: 'blacklist' => string[] A list of methods this driver will silently skip 'defaultZoneId' => The zone some commands operate on if no zone is given

createRecord()

Create a single DNS record in an existing zone

public createRecord(string $zoneId, string $name, string $type, string|array<string|int, string> $value[, int $ttl = 600 ][, string $comment = '' ]) : mixed
Parameters
$zoneId : string

The Zone Id

$name : string

The DNS name of the record. No end dot.

$type : string

The DNS record type

$value : string|array<string|int, string>

The Value(s) of the DNS record

$ttl : int = 600

The TTL of the record, defaults to 600

$comment : string = ''

Set a comment for the operation

Tags
PHP8:

Refactor for named arguments and more optionals This will error on existing record. Use update for "create or update"

throws
TBD

createRecords()

Delete multiple DNS records in an existing zone

public createRecords(string $zoneId, array<string|int, Record> $records[, string $comment = '' ]) : mixed
Parameters
$zoneId : string
$records : array<string|int, Record>

an array of records to delete

$comment : string = ''

deleteRecord()

Delete a single DNS record in an existing zone

public deleteRecord(string $zoneId, string $name, string $type[, string $comment = '' ]) : mixed
Parameters
$zoneId : string

The Zone Id

$name : string

The DNS name of the record. No end dot.

$type : string

The DNS record type

$comment : string = ''

Set a comment for the operation

Tags
PHP8:

Refactor for named arguments and more optionals This will check on existing record and not fail on missing.

deleteRecords()

Delete multiple DNS records in an existing zone

public deleteRecords(string $zoneId, array<string|int, Record> $records[, string $comment = '' ]) : mixed
Parameters
$zoneId : string
$records : array<string|int, Record>

an array of records to delete

$comment : string = ''

getDefaultZoneId()

Return the default Zone ID

public getDefaultZoneId() : string

This is used in some methods when no zone ID argument was present

Tags
PHP8:

Refactor more methods to use this

Return values
string —

The ID

getSingleRecord()

Get a single record if it exists

public getSingleRecord(string $name[, string $zoneId = '' ][, array<string|int, mixed> $filters = null ]) : Record|null

Note: The returned comment will always be empty

Parameters
$name : string

The DNS name of the record to retrieve. No end dot.

$zoneId : string = ''

The Zone Id (optional, falls back to default zone)

$filters : array<string|int, mixed> = null

A hash of additional filters to apply TBD, not implemented yet

Tags
PHP8:

Refactor more methods to use this

Return values
Record|null —

A record representation or null if not found

getZone()

Get a Zone by Id

public getZone([string $zoneId = '' ]) : Zone

This is used in some methods when no zone ID argument was present

Parameters
$zoneId : string = ''

The ID

Tags
PHP8:

Refactor more methods to use this

Return values
Zone —

A zone representation

getZoneRecords()

Get a Zone's records by Zone Id

public getZoneRecords([string $zoneId = '' ][, array<string|int, mixed> $filters = null ][, int $maxResults = 0 ]) : array<string|int, Record>
Parameters
$zoneId : string = ''

The ID (optional, falls back to default zone)

$filters : array<string|int, mixed> = null

A hash of additional filters to apply TBD, not implemented yet

$maxResults : int = 0

Maximum amount of records to get. values <= 0 mean no limit

Tags
PHP8:

Refactor more methods to use this

Return values
array<string|int, Record> —

A list of record representations

setDefaultZoneId()

Set the default Zone ID

public setDefaultZoneId(string $zoneId) : mixed

This is used in some methods when no zone ID argument was present

Parameters
$zoneId : string

The ID

Tags
PHP8:

Refactor more methods to use this

updateRecord()

Update or create if missing a single DNS record

public updateRecord(string $zoneId, string $name, string $type, string|array<string|int, string> $value[, int $ttl = 600 ][, string $comment = '' ]) : mixed
Parameters
$zoneId : string

The Zone Id

$name : string

The DNS name of the record. No end dot.

$type : string

The DNS record type

$value : string|array<string|int, string>

The Value(s) of the DNS record

$ttl : int = 600

The TTL of the record, defaults to 600

$comment : string = ''

Set a comment for the operation

Tags
PHP8:

Refactor for named arguments and more optionals

If you do not want to overwrite existing records, use "create" instead

throws
TBD

updateRecords()

Update multiple DNS records in an existing zone

public updateRecords(string $zoneId, array<string|int, Record> $records[, string $comment = '' ]) : mixed
Parameters
$zoneId : string
$records : array<string|int, Record>

an array of records to delete

$comment : string = ''

convertRecordSetsToRecords()

Converts ResourceRecordSets to an array of Records

private convertRecordSetsToRecords(array<string|int, mixed> $recordSets) : array<string|int, Record>
Parameters
$recordSets : array<string|int, mixed>

The ResourceRecordSets as returned by Sdk

Return values
array<string|int, Record> —

A list of record representations

doActionForRecords()

private doActionForRecords(string $zoneId, string $action, array<string|int, Record> $records[, string $comment = '' ]) : array<string|int, Result>
Parameters
$zoneId : string

The zone id

$action : string

one of 'DELETE', 'CREATE' or 'UPSERT'

$records : array<string|int, Record>
$comment : string = ''

optional comment of the these change batches

Return values
array<string|int, Result>

getChangeRequestQuery()

Gets the query for the changeResourceRecordSets api call in the correct format

private getChangeRequestQuery(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

A hash that hold all the necessary values for the query

Return values
array<string|int, mixed> —

The query to use for api call

getResourceRecordSetsIterator()

ResourceRecordSets Iterator that queries listResourceRecordSets until all results or maxResults are retrieved

private getResourceRecordSetsIterator([array<string|int, mixed> $baseQuery = [] ][, int $maxResults = 0 ]) : iterable<string|int, mixed>
Parameters
$baseQuery : array<string|int, mixed> = []

The query to use in the listResourceRecordSets calls

$maxResults : int = 0

Maximum amount of records to get. values <= 0 mean no limit

Return values
iterable<string|int, mixed> —

A list of record representations

methodIsBlacklisted()

private methodIsBlacklisted(string $methodName) : bool
Parameters
$methodName : string
Return values
bool

setMethodBlacklist()

private setMethodBlacklist(array<string|int, mixed>|null $methods) : mixed
Parameters
$methods : array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results