aws

Documentation

Overview

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Index

• func NewAws() aws.Config
• type AWSARecord
• type AWSConfiguration
  • func (conf *AWSConfiguration) GetHostedZoneID(domain string) (string, error)
  • func (conf *AWSConfiguration) Route53AlterResourceRecord(r *AWSRoute53AlterResourceRecord) (*route53.ChangeResourceRecordSetsOutput, error)
  • func (conf *AWSConfiguration) Route53ListARecords(hostedZoneId string) ([]AWSARecord, error)
  • func (conf *AWSConfiguration) Route53ListTXTRecords(hostedZoneId string) ([]AWSTXTRecord, error)
  • func (conf *AWSConfiguration) TestHostedZoneLiveness(hostedZoneName string) (bool, error)
• type AWSRoute53AlterResourceRecord
• type AWSTXTRecord

Functions

func NewAws

func NewAws() aws.Config

NewAws instantiates a new AWS configuration

Types

type AWSARecord

type AWSARecord struct {
	Name        string
	RecordType  string
	TTL         *int64
	AliasTarget *route53Types.AliasTarget
}

AWSARecord stores Route53 A record data

type AWSConfiguration

type AWSConfiguration struct {
	Config aws.Config
}

AWSConfiguration stores session data to organize all AWS functions into a single struct

var Conf AWSConfiguration = AWSConfiguration{
	Config: NewAws(),
}

Create a single configuration instance to act as an interface to the AWS client

func (*AWSConfiguration) GetHostedZoneID

func (conf *AWSConfiguration) GetHostedZoneID(domain string) (string, error)

GetHostedZoneID returns the id of a hosted zone based on its domain (name)

func (*AWSConfiguration) Route53AlterResourceRecord

func (conf *AWSConfiguration) Route53AlterResourceRecord(r *AWSRoute53AlterResourceRecord) (*route53.ChangeResourceRecordSetsOutput, error)

Route53AlterResourceRecord simplifies manipulation of Route53 records

func (*AWSConfiguration) Route53ListARecords

func (conf *AWSConfiguration) Route53ListARecords(hostedZoneId string) ([]AWSARecord, error)

Route53ListARecords retrieves all DNS A records for a hosted zone

func (*AWSConfiguration) Route53ListTXTRecords

func (conf *AWSConfiguration) Route53ListTXTRecords(hostedZoneId string) ([]AWSTXTRecord, error)

Route53ListTXTRecords retrieves all DNS TXT record type for a hosted zone

func (*AWSConfiguration) TestHostedZoneLiveness

func (conf *AWSConfiguration) TestHostedZoneLiveness(hostedZoneName string) (bool, error)

TestHostedZoneLiveness determines whether or not a target hosted zone is initialized and ready to accept records

type AWSRoute53AlterResourceRecord

type AWSRoute53AlterResourceRecord struct {
	// contains filtered or unexported fields
}

type AWSTXTRecord

type AWSTXTRecord struct {
	Name          string
	Value         string
	SetIdentifier *string
	Weight        *int64
	TTL           int64
}

AWSTXTRecord stores Route53 TXT record data