Documentation
¶
Index ¶
- Variables
- func ListHostedZones(ctx core.ListResourcesContext, resourceType string) ([]core.IntegrationResource, error)
- type ChangeInfo
- type Client
- type CreateRecord
- func (c *CreateRecord) Cancel(ctx core.ExecutionContext) error
- func (c *CreateRecord) Cleanup(ctx core.SetupContext) error
- func (c *CreateRecord) Color() string
- func (c *CreateRecord) Configuration() []configuration.Field
- func (c *CreateRecord) Description() string
- func (c *CreateRecord) Documentation() string
- func (c *CreateRecord) ExampleOutput() map[string]any
- func (c *CreateRecord) Execute(ctx core.ExecutionContext) error
- func (c *CreateRecord) HandleHook(ctx core.ActionHookContext) error
- func (c *CreateRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
- func (c *CreateRecord) Hooks() []core.Hook
- func (c *CreateRecord) Icon() string
- func (c *CreateRecord) Label() string
- func (c *CreateRecord) Name() string
- func (c *CreateRecord) OutputChannels(configuration any) []core.OutputChannel
- func (c *CreateRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
- func (c *CreateRecord) Setup(ctx core.SetupContext) error
- type CreateRecordConfiguration
- type DeleteRecord
- func (c *DeleteRecord) Cancel(ctx core.ExecutionContext) error
- func (c *DeleteRecord) Cleanup(ctx core.SetupContext) error
- func (c *DeleteRecord) Color() string
- func (c *DeleteRecord) Configuration() []configuration.Field
- func (c *DeleteRecord) Description() string
- func (c *DeleteRecord) Documentation() string
- func (c *DeleteRecord) ExampleOutput() map[string]any
- func (c *DeleteRecord) Execute(ctx core.ExecutionContext) error
- func (c *DeleteRecord) HandleHook(ctx core.ActionHookContext) error
- func (c *DeleteRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
- func (c *DeleteRecord) Hooks() []core.Hook
- func (c *DeleteRecord) Icon() string
- func (c *DeleteRecord) Label() string
- func (c *DeleteRecord) Name() string
- func (c *DeleteRecord) OutputChannels(configuration any) []core.OutputChannel
- func (c *DeleteRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
- func (c *DeleteRecord) Setup(ctx core.SetupContext) error
- type DeleteRecordConfiguration
- type HostedZoneSummary
- type RecordChangePollMetadata
- type ResourceRecord
- type ResourceRecordSet
- type UpsertRecord
- func (c *UpsertRecord) Cancel(ctx core.ExecutionContext) error
- func (c *UpsertRecord) Cleanup(ctx core.SetupContext) error
- func (c *UpsertRecord) Color() string
- func (c *UpsertRecord) Configuration() []configuration.Field
- func (c *UpsertRecord) Description() string
- func (c *UpsertRecord) Documentation() string
- func (c *UpsertRecord) ExampleOutput() map[string]any
- func (c *UpsertRecord) Execute(ctx core.ExecutionContext) error
- func (c *UpsertRecord) HandleHook(ctx core.ActionHookContext) error
- func (c *UpsertRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
- func (c *UpsertRecord) Hooks() []core.Hook
- func (c *UpsertRecord) Icon() string
- func (c *UpsertRecord) Label() string
- func (c *UpsertRecord) Name() string
- func (c *UpsertRecord) OutputChannels(configuration any) []core.OutputChannel
- func (c *UpsertRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
- func (c *UpsertRecord) Setup(ctx core.SetupContext) error
- type UpsertRecordConfiguration
Constants ¶
This section is empty.
Variables ¶
var RecordTypeOptions = []configuration.FieldOption{
{Label: "A", Value: "A"},
{Label: "AAAA", Value: "AAAA"},
{Label: "CAA", Value: "CAA"},
{Label: "CNAME", Value: "CNAME"},
{Label: "DS", Value: "DS"},
{Label: "MX", Value: "MX"},
{Label: "NAPTR", Value: "NAPTR"},
{Label: "NS", Value: "NS"},
{Label: "PTR", Value: "PTR"},
{Label: "SOA", Value: "SOA"},
{Label: "SPF", Value: "SPF"},
{Label: "SRV", Value: "SRV"},
{Label: "TXT", Value: "TXT"},
}
* DNS record types supported by AWS Route 53. * See: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html
Functions ¶
func ListHostedZones ¶
func ListHostedZones(ctx core.ListResourcesContext, resourceType string) ([]core.IntegrationResource, error)
Types ¶
type ChangeInfo ¶
type ChangeInfo struct {
ID string `json:"id"`
Status string `json:"status"`
SubmittedAt string `json:"submittedAt"`
}
ChangeInfo contains information about a Route 53 change request.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(httpCtx core.HTTPContext, credentials *aws.Credentials) *Client
func (*Client) ChangeResourceRecordSets ¶
func (c *Client) ChangeResourceRecordSets(hostedZoneID, action string, recordSet ResourceRecordSet) (*ChangeInfo, error)
ChangeResourceRecordSets creates, updates, or deletes DNS records in a hosted zone.
func (*Client) GetChange ¶
func (c *Client) GetChange(changeID string) (*ChangeInfo, error)
GetChange returns the current status of a change request. changeID is the ID returned by ChangeResourceRecordSets (e.g. /change/C0123456789ABCDEF).
func (*Client) ListHostedZones ¶
func (c *Client) ListHostedZones() ([]HostedZoneSummary, error)
ListHostedZones returns all hosted zones in the account.
type CreateRecord ¶
type CreateRecord struct{}
func (*CreateRecord) Cancel ¶
func (c *CreateRecord) Cancel(ctx core.ExecutionContext) error
func (*CreateRecord) Cleanup ¶
func (c *CreateRecord) Cleanup(ctx core.SetupContext) error
func (*CreateRecord) Color ¶
func (c *CreateRecord) Color() string
func (*CreateRecord) Configuration ¶
func (c *CreateRecord) Configuration() []configuration.Field
func (*CreateRecord) Description ¶
func (c *CreateRecord) Description() string
func (*CreateRecord) Documentation ¶
func (c *CreateRecord) Documentation() string
func (*CreateRecord) ExampleOutput ¶
func (c *CreateRecord) ExampleOutput() map[string]any
func (*CreateRecord) Execute ¶
func (c *CreateRecord) Execute(ctx core.ExecutionContext) error
func (*CreateRecord) HandleHook ¶ added in v0.18.0
func (c *CreateRecord) HandleHook(ctx core.ActionHookContext) error
func (*CreateRecord) HandleWebhook ¶
func (c *CreateRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
func (*CreateRecord) Hooks ¶ added in v0.18.0
func (c *CreateRecord) Hooks() []core.Hook
func (*CreateRecord) Icon ¶
func (c *CreateRecord) Icon() string
func (*CreateRecord) Label ¶
func (c *CreateRecord) Label() string
func (*CreateRecord) Name ¶
func (c *CreateRecord) Name() string
func (*CreateRecord) OutputChannels ¶
func (c *CreateRecord) OutputChannels(configuration any) []core.OutputChannel
func (*CreateRecord) ProcessQueueItem ¶
func (c *CreateRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
func (*CreateRecord) Setup ¶
func (c *CreateRecord) Setup(ctx core.SetupContext) error
type CreateRecordConfiguration ¶
type CreateRecordConfiguration struct {
HostedZoneID string `json:"hostedZoneId" mapstructure:"hostedZoneId"`
RecordName string `json:"recordName" mapstructure:"recordName"`
RecordType string `json:"recordType" mapstructure:"recordType"`
TTL int `json:"ttl" mapstructure:"ttl"`
Values []string `json:"values" mapstructure:"values"`
}
type DeleteRecord ¶
type DeleteRecord struct{}
func (*DeleteRecord) Cancel ¶
func (c *DeleteRecord) Cancel(ctx core.ExecutionContext) error
func (*DeleteRecord) Cleanup ¶
func (c *DeleteRecord) Cleanup(ctx core.SetupContext) error
func (*DeleteRecord) Color ¶
func (c *DeleteRecord) Color() string
func (*DeleteRecord) Configuration ¶
func (c *DeleteRecord) Configuration() []configuration.Field
func (*DeleteRecord) Description ¶
func (c *DeleteRecord) Description() string
func (*DeleteRecord) Documentation ¶
func (c *DeleteRecord) Documentation() string
func (*DeleteRecord) ExampleOutput ¶
func (c *DeleteRecord) ExampleOutput() map[string]any
func (*DeleteRecord) Execute ¶
func (c *DeleteRecord) Execute(ctx core.ExecutionContext) error
func (*DeleteRecord) HandleHook ¶ added in v0.18.0
func (c *DeleteRecord) HandleHook(ctx core.ActionHookContext) error
func (*DeleteRecord) HandleWebhook ¶
func (c *DeleteRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
func (*DeleteRecord) Hooks ¶ added in v0.18.0
func (c *DeleteRecord) Hooks() []core.Hook
func (*DeleteRecord) Icon ¶
func (c *DeleteRecord) Icon() string
func (*DeleteRecord) Label ¶
func (c *DeleteRecord) Label() string
func (*DeleteRecord) Name ¶
func (c *DeleteRecord) Name() string
func (*DeleteRecord) OutputChannels ¶
func (c *DeleteRecord) OutputChannels(configuration any) []core.OutputChannel
func (*DeleteRecord) ProcessQueueItem ¶
func (c *DeleteRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
func (*DeleteRecord) Setup ¶
func (c *DeleteRecord) Setup(ctx core.SetupContext) error
type DeleteRecordConfiguration ¶
type DeleteRecordConfiguration struct {
HostedZoneID string `json:"hostedZoneId" mapstructure:"hostedZoneId"`
RecordName string `json:"recordName" mapstructure:"recordName"`
RecordType string `json:"recordType" mapstructure:"recordType"`
TTL int `json:"ttl" mapstructure:"ttl"`
Values []string `json:"values" mapstructure:"values"`
}
type HostedZoneSummary ¶
HostedZoneSummary contains basic information about a hosted zone.
type RecordChangePollMetadata ¶
type RecordChangePollMetadata struct {
ChangeID string `json:"changeId" mapstructure:"changeId"`
RecordName string `json:"recordName" mapstructure:"recordName"`
RecordType string `json:"recordType" mapstructure:"recordType"`
SubmittedAt string `json:"submittedAt" mapstructure:"submittedAt"`
}
RecordChangePollMetadata is stored when a change is PENDING and we schedule a poll.
type ResourceRecord ¶
type ResourceRecord struct {
Value string `xml:"Value"`
}
type ResourceRecordSet ¶
type ResourceRecordSet struct {
Name string `json:"name"`
Type string `json:"type"`
TTL int `json:"ttl"`
Values []string `json:"values"`
}
ResourceRecordSet represents a DNS record set to be created, updated, or deleted.
type UpsertRecord ¶
type UpsertRecord struct{}
func (*UpsertRecord) Cancel ¶
func (c *UpsertRecord) Cancel(ctx core.ExecutionContext) error
func (*UpsertRecord) Cleanup ¶
func (c *UpsertRecord) Cleanup(ctx core.SetupContext) error
func (*UpsertRecord) Color ¶
func (c *UpsertRecord) Color() string
func (*UpsertRecord) Configuration ¶
func (c *UpsertRecord) Configuration() []configuration.Field
func (*UpsertRecord) Description ¶
func (c *UpsertRecord) Description() string
func (*UpsertRecord) Documentation ¶
func (c *UpsertRecord) Documentation() string
func (*UpsertRecord) ExampleOutput ¶
func (c *UpsertRecord) ExampleOutput() map[string]any
func (*UpsertRecord) Execute ¶
func (c *UpsertRecord) Execute(ctx core.ExecutionContext) error
func (*UpsertRecord) HandleHook ¶ added in v0.18.0
func (c *UpsertRecord) HandleHook(ctx core.ActionHookContext) error
func (*UpsertRecord) HandleWebhook ¶
func (c *UpsertRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)
func (*UpsertRecord) Hooks ¶ added in v0.18.0
func (c *UpsertRecord) Hooks() []core.Hook
func (*UpsertRecord) Icon ¶
func (c *UpsertRecord) Icon() string
func (*UpsertRecord) Label ¶
func (c *UpsertRecord) Label() string
func (*UpsertRecord) Name ¶
func (c *UpsertRecord) Name() string
func (*UpsertRecord) OutputChannels ¶
func (c *UpsertRecord) OutputChannels(configuration any) []core.OutputChannel
func (*UpsertRecord) ProcessQueueItem ¶
func (c *UpsertRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)
func (*UpsertRecord) Setup ¶
func (c *UpsertRecord) Setup(ctx core.SetupContext) error
type UpsertRecordConfiguration ¶
type UpsertRecordConfiguration struct {
HostedZoneID string `json:"hostedZoneId" mapstructure:"hostedZoneId"`
RecordName string `json:"recordName" mapstructure:"recordName"`
RecordType string `json:"recordType" mapstructure:"recordType"`
TTL int `json:"ttl" mapstructure:"ttl"`
Values []string `json:"values" mapstructure:"values"`
}