types

package
v1.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 8, 2021 License: Apache-2.0 Imports: 3 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationStrategy 

type AuthenticationStrategy string
const (
	AuthenticationStrategySimple AuthenticationStrategy = "SIMPLE"
	AuthenticationStrategyLdap   AuthenticationStrategy = "LDAP"
)

Enum values for AuthenticationStrategy

func (AuthenticationStrategy) Values added in v0.29.0 

func (AuthenticationStrategy) Values() []AuthenticationStrategy

Values returns all known values for AuthenticationStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AvailabilityZone 

type AvailabilityZone struct {

	// Id for the availability zone.
	Name *string
}

Name of the availability zone.

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorAttribute *string
}

Returns information about an error.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type BrokerEngineType 

type BrokerEngineType struct {

	// The type of broker engine.
	EngineType EngineType

	// The list of engine versions.
	EngineVersions []EngineVersion
}

Types of broker engines.

type BrokerInstance 

type BrokerInstance struct {

	// The URL of the broker's Web Console.
	ConsoleURL *string

	// The broker's wire-level protocol endpoints.
	Endpoints []string

	// The IP address of the Elastic Network Interface (ENI) attached to the broker.
	// Does not apply to RabbitMQ brokers
	IpAddress *string
}

Returns information about all brokers.

type BrokerInstanceOption 

type BrokerInstanceOption struct {

	// The list of available az.
	AvailabilityZones []AvailabilityZone

	// The type of broker engine.
	EngineType EngineType

	// The type of broker instance.
	HostInstanceType *string

	// The broker's storage type.
	StorageType BrokerStorageType

	// The list of supported deployment modes.
	SupportedDeploymentModes []DeploymentMode

	// The list of supported engine versions.
	SupportedEngineVersions []string
}

Option for host instance type.

type BrokerState 

type BrokerState string
const (
	BrokerStateCreationInProgress BrokerState = "CREATION_IN_PROGRESS"
	BrokerStateCreationFailed     BrokerState = "CREATION_FAILED"
	BrokerStateDeletionInProgress BrokerState = "DELETION_IN_PROGRESS"
	BrokerStateRunning            BrokerState = "RUNNING"
	BrokerStateRebootInProgress   BrokerState = "REBOOT_IN_PROGRESS"
)

Enum values for BrokerState

func (BrokerState) Values added in v0.29.0 

func (BrokerState) Values() []BrokerState

Values returns all known values for BrokerState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BrokerStorageType 

type BrokerStorageType string
const (
	BrokerStorageTypeEbs BrokerStorageType = "EBS"
	BrokerStorageTypeEfs BrokerStorageType = "EFS"
)

Enum values for BrokerStorageType

func (BrokerStorageType) Values added in v0.29.0 

func (BrokerStorageType) Values() []BrokerStorageType

Values returns all known values for BrokerStorageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BrokerSummary 

type BrokerSummary struct {

	// The Amazon Resource Name (ARN) of the broker.
	BrokerArn *string

	// The unique ID that Amazon MQ generates for the broker.
	BrokerId *string

	// The name of the broker. This value must be unique in your AWS account, 1-50
	// characters long, must contain only letters, numbers, dashes, and underscores,
	// and must not contain whitespaces, brackets, wildcard characters, or special
	// characters.
	BrokerName *string

	// The status of the broker.
	BrokerState BrokerState

	// The time when the broker was created.
	Created *time.Time

	// Required. The deployment mode of the broker.
	DeploymentMode DeploymentMode

	// Required. The type of broker engine.
	EngineType EngineType

	// The broker's instance type.
	HostInstanceType *string
}

The Amazon Resource Name (ARN) of the broker.

type ChangeType 

type ChangeType string
const (
	ChangeTypeCreate ChangeType = "CREATE"
	ChangeTypeUpdate ChangeType = "UPDATE"
	ChangeTypeDelete ChangeType = "DELETE"
)

Enum values for ChangeType

func (ChangeType) Values added in v0.29.0 

func (ChangeType) Values() []ChangeType

Values returns all known values for ChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Configuration 

type Configuration struct {

	// Required. The ARN of the configuration.
	Arn *string

	// The authentication strategy associated with the configuration.
	AuthenticationStrategy AuthenticationStrategy

	// Required. The date and time of the configuration revision.
	Created *time.Time

	// Required. The description of the configuration.
	Description *string

	// Required. The type of broker engine. Note: Currently, Amazon MQ supports
	// ACTIVEMQ and RABBITMQ.
	EngineType EngineType

	// Required. The version of the broker engine. For a list of supported engine
	// versions, see
	// https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
	EngineVersion *string

	// Required. The unique ID that Amazon MQ generates for the configuration.
	Id *string

	// Required. The latest revision of the configuration.
	LatestRevision *ConfigurationRevision

	// Required. The name of the configuration. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~).
	// This value must be 1-150 characters long.
	Name *string

	// The list of all tags associated with this configuration.
	Tags map[string]string
}

Returns information about all configurations.

type ConfigurationId 

type ConfigurationId struct {

	// Required. The unique ID that Amazon MQ generates for the configuration.
	Id *string

	// The revision number of the configuration.
	Revision int32
}

A list of information about the configuration. Does not apply to RabbitMQ brokers.

type ConfigurationRevision 

type ConfigurationRevision struct {

	// Required. The date and time of the configuration revision.
	Created *time.Time

	// The description of the configuration revision.
	Description *string

	// Required. The revision number of the configuration.
	Revision int32
}

Returns information about the specified configuration revision.

type Configurations 

type Configurations struct {

	// The current configuration of the broker.
	Current *ConfigurationId

	// The history of configurations applied to the broker.
	History []ConfigurationId

	// The pending configuration of the broker.
	Pending *ConfigurationId
}

Broker configuration information

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorAttribute *string
}

Returns information about an error.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DayOfWeek 

type DayOfWeek string
const (
	DayOfWeekMonday    DayOfWeek = "MONDAY"
	DayOfWeekTuesday   DayOfWeek = "TUESDAY"
	DayOfWeekWednesday DayOfWeek = "WEDNESDAY"
	DayOfWeekThursday  DayOfWeek = "THURSDAY"
	DayOfWeekFriday    DayOfWeek = "FRIDAY"
	DayOfWeekSaturday  DayOfWeek = "SATURDAY"
	DayOfWeekSunday    DayOfWeek = "SUNDAY"
)

Enum values for DayOfWeek

func (DayOfWeek) Values added in v0.29.0 

func (DayOfWeek) Values() []DayOfWeek

Values returns all known values for DayOfWeek. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentMode 

type DeploymentMode string
const (
	DeploymentModeSingleInstance       DeploymentMode = "SINGLE_INSTANCE"
	DeploymentModeActiveStandbyMultiAz DeploymentMode = "ACTIVE_STANDBY_MULTI_AZ"
	DeploymentModeClusterMultiAz       DeploymentMode = "CLUSTER_MULTI_AZ"
)

Enum values for DeploymentMode

func (DeploymentMode) Values added in v0.29.0 

func (DeploymentMode) Values() []DeploymentMode

Values returns all known values for DeploymentMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionOptions 

type EncryptionOptions struct {

	// Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
	//
	// This member is required.
	UseAwsOwnedKey bool

	// The symmetric customer master key (CMK) to use for the AWS Key Management
	// Service (KMS). This key is used to encrypt your data at rest. If not provided,
	// Amazon MQ will use a default CMK to encrypt your data.
	KmsKeyId *string
}

Encryption options for the broker.

type EngineType 

type EngineType string
const (
	EngineTypeActivemq EngineType = "ACTIVEMQ"
	EngineTypeRabbitmq EngineType = "RABBITMQ"
)

Enum values for EngineType

func (EngineType) Values added in v0.29.0 

func (EngineType) Values() []EngineType

Values returns all known values for EngineType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EngineVersion 

type EngineVersion struct {

	// Id for the version.
	Name *string
}

Id of the engine version.

type ForbiddenException 

type ForbiddenException struct {
	Message *string

	ErrorAttribute *string
}

Returns information about an error.

func (*ForbiddenException) Error 

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode 

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault 

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage 

func (e *ForbiddenException) ErrorMessage() string

type InternalServerErrorException 

type InternalServerErrorException struct {
	Message *string

	ErrorAttribute *string
}

Returns information about an error.

func (*InternalServerErrorException) Error 

func (e *InternalServerErrorException) Error() string

func (*InternalServerErrorException) ErrorCode 

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault 

func (e *InternalServerErrorException) ErrorFault() smithy.ErrorFault

func (*InternalServerErrorException) ErrorMessage 

func (e *InternalServerErrorException) ErrorMessage() string

type LdapServerMetadataInput 

type LdapServerMetadataInput struct {

	// Fully qualified domain name of the LDAP server. Optional failover server.
	Hosts []string

	// Fully qualified name of the directory to search for a user’s groups.
	RoleBase *string

	// Specifies the LDAP attribute that identifies the group name attribute in the
	// object returned from the group membership query.
	RoleName *string

	// The search criteria for groups.
	RoleSearchMatching *string

	// The directory search scope for the role. If set to true, scope is to search the
	// entire sub-tree.
	RoleSearchSubtree bool

	// Service account password.
	ServiceAccountPassword *string

	// Service account username.
	ServiceAccountUsername *string

	// Fully qualified name of the directory where you want to search for users.
	UserBase *string

	// Specifies the name of the LDAP attribute for the user group membership.
	UserRoleName *string

	// The search criteria for users.
	UserSearchMatching *string

	// The directory search scope for the user. If set to true, scope is to search the
	// entire sub-tree.
	UserSearchSubtree bool
}

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

type LdapServerMetadataOutput 

type LdapServerMetadataOutput struct {

	// Fully qualified domain name of the LDAP server. Optional failover server.
	Hosts []string

	// Fully qualified name of the directory to search for a user’s groups.
	RoleBase *string

	// Specifies the LDAP attribute that identifies the group name attribute in the
	// object returned from the group membership query.
	RoleName *string

	// The search criteria for groups.
	RoleSearchMatching *string

	// The directory search scope for the role. If set to true, scope is to search the
	// entire sub-tree.
	RoleSearchSubtree bool

	// Service account username.
	ServiceAccountUsername *string

	// Fully qualified name of the directory where you want to search for users.
	UserBase *string

	// Specifies the name of the LDAP attribute for the user group membership.
	UserRoleName *string

	// The search criteria for users.
	UserSearchMatching *string

	// The directory search scope for the user. If set to true, scope is to search the
	// entire sub-tree.
	UserSearchSubtree bool
}

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

type Logs 

type Logs struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
	Audit bool

	// Enables general logging.
	General bool
}

The list of information about logs to be enabled for the specified broker.

type LogsSummary 

type LogsSummary struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged.
	Audit bool

	// The location of the CloudWatch Logs log group where audit logs are sent.
	AuditLogGroup *string

	// Enables general logging.
	General bool

	// The location of the CloudWatch Logs log group where general logs are sent.
	GeneralLogGroup *string

	// The list of information about logs pending to be deployed for the specified
	// broker.
	Pending *PendingLogs
}

The list of information about logs currently enabled and pending to be deployed for the specified broker.

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorAttribute *string
}

Returns information about an error.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type PendingLogs 

type PendingLogs struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged.
	Audit bool

	// Enables general logging.
	General bool
}

The list of information about logs to be enabled for the specified broker.

type SanitizationWarning 

type SanitizationWarning struct {

	// The name of the XML attribute that has been sanitized.
	AttributeName *string

	// The name of the XML element that has been sanitized.
	ElementName *string

	// Required. The reason for which the XML elements or attributes were sanitized.
	Reason SanitizationWarningReason
}

Returns information about the XML element or attribute that was sanitized in the configuration.

type SanitizationWarningReason 

type SanitizationWarningReason string
const (
	SanitizationWarningReasonDisallowedElementRemoved     SanitizationWarningReason = "DISALLOWED_ELEMENT_REMOVED"
	SanitizationWarningReasonDisallowedAttributeRemoved   SanitizationWarningReason = "DISALLOWED_ATTRIBUTE_REMOVED"
	SanitizationWarningReasonInvalidAttributeValueRemoved SanitizationWarningReason = "INVALID_ATTRIBUTE_VALUE_REMOVED"
)

Enum values for SanitizationWarningReason

func (SanitizationWarningReason) Values added in v0.29.0 

func (SanitizationWarningReason) Values() []SanitizationWarningReason

Values returns all known values for SanitizationWarningReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorAttribute *string
}

Returns information about an error.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type User 

type User struct {

	// Enables access to the ActiveMQ Web Console for the ActiveMQ user (Does not apply
	// to RabbitMQ brokers).
	ConsoleAccess bool

	// The list of groups (20 maximum) to which the ActiveMQ user belongs. This value
	// can contain only alphanumeric characters, dashes, periods, underscores, and
	// tildes (- . _ ~). This value must be 2-100 characters long.
	Groups []string

	// Required. The password of the broker user. This value must be at least 12
	// characters long, must contain at least 4 unique characters, and must not contain
	// commas.
	Password *string

	// Required. The username of the broker user. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~).
	// This value must be 2-100 characters long.
	Username *string
}

A user associated with the broker.

type UserPendingChanges 

type UserPendingChanges struct {

	// Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
	ConsoleAccess bool

	// The list of groups (20 maximum) to which the ActiveMQ user belongs. This value
	// can contain only alphanumeric characters, dashes, periods, underscores, and
	// tildes (- . _ ~). This value must be 2-100 characters long.
	Groups []string

	// Required. The type of change pending for the ActiveMQ user.
	PendingChange ChangeType
}

Returns information about the status of the changes pending for the ActiveMQ user.

type UserSummary 

type UserSummary struct {

	// The type of change pending for the broker user.
	PendingChange ChangeType

	// Required. The username of the broker user. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~).
	// This value must be 2-100 characters long.
	Username *string
}

Returns a list of all broker users.

type WeeklyStartTime 

type WeeklyStartTime struct {

	// Required. The day of the week.
	DayOfWeek DayOfWeek

	// Required. The time, in 24-hour format.
	TimeOfDay *string

	// The time zone, UTC by default, in either the Country/City format, or the UTC
	// offset format.
	TimeZone *string
}

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.