types

package
v1.18.0 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2023 License: Apache-2.0 Imports: 4 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action 

type Action struct {

	// The description for the action.
	Description *string

	// The ID of the action.
	Id *string

	// The action parameters, if applicable.
	Parameters map[string]ActionParameter

	// The tags for the action.
	Tags map[string]string

	// The supported targets for the action.
	Targets map[string]ActionTarget
	// contains filtered or unexported fields
}

Describes an action. For more information, see FIS actions (https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html) in the Fault Injection Simulator User Guide.

type ActionParameter 

type ActionParameter struct {

	// The parameter description.
	Description *string

	// Indicates whether the parameter is required.
	Required *bool
	// contains filtered or unexported fields
}

Describes a parameter for an action.

type ActionSummary 

type ActionSummary struct {

	// The description for the action.
	Description *string

	// The ID of the action.
	Id *string

	// The tags for the action.
	Tags map[string]string

	// The targets for the action.
	Targets map[string]ActionTarget
	// contains filtered or unexported fields
}

Provides a summary of an action.

type ActionTarget 

type ActionTarget struct {

	// The resource type of the target.
	ResourceType *string
	// contains filtered or unexported fields
}

Describes a target for an action.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request could not be processed because of a conflict.

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 CreateExperimentTemplateActionInput 

type CreateExperimentTemplateActionInput struct {

	// The ID of the action. The format of the action ID is:
	// aws:service-name:action-type.
	//
	// This member is required.
	ActionId *string

	// A description for the action.
	Description *string

	// The parameters for the action, if applicable.
	Parameters map[string]string

	// The name of the action that must be completed before the current action starts.
	// Omit this parameter to run the action at the start of the experiment.
	StartAfter []string

	// The targets for the action.
	Targets map[string]string
	// contains filtered or unexported fields
}

Specifies an action for an experiment template. For more information, see Actions (https://docs.aws.amazon.com/fis/latest/userguide/actions.html) in the Fault Injection Simulator User Guide.

type CreateExperimentTemplateLogConfigurationInput added in v1.12.0 

type CreateExperimentTemplateLogConfigurationInput struct {

	// The schema version.
	//
	// This member is required.
	LogSchemaVersion *int32

	// The configuration for experiment logging to Amazon CloudWatch Logs.
	CloudWatchLogsConfiguration *ExperimentTemplateCloudWatchLogsLogConfigurationInput

	// The configuration for experiment logging to Amazon S3.
	S3Configuration *ExperimentTemplateS3LogConfigurationInput
	// contains filtered or unexported fields
}

Specifies the configuration for experiment logging.

type CreateExperimentTemplateStopConditionInput 

type CreateExperimentTemplateStopConditionInput struct {

	// The source for the stop condition. Specify aws:cloudwatch:alarm if the stop
	// condition is defined by a CloudWatch alarm. Specify none if there is no stop
	// condition.
	//
	// This member is required.
	Source *string

	// The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the
	// source is a CloudWatch alarm.
	Value *string
	// contains filtered or unexported fields
}

Specifies a stop condition for an experiment template.

type CreateExperimentTemplateTargetInput 

type CreateExperimentTemplateTargetInput struct {

	// The resource type. The resource type must be supported for the specified action.
	//
	// This member is required.
	ResourceType *string

	// Scopes the identified resources to a specific count of the resources at random,
	// or a percentage of the resources. All identified resources are included in the
	// target.
	//   - ALL - Run the action on all identified targets. This is the default.
	//   - COUNT(n) - Run the action on the specified number of targets, chosen from
	//   the identified targets at random. For example, COUNT(1) selects one of the
	//   targets.
	//   - PERCENT(n) - Run the action on the specified percentage of targets, chosen
	//   from the identified targets at random. For example, PERCENT(25) selects 25% of
	//   the targets.
	//
	// This member is required.
	SelectionMode *string

	// The filters to apply to identify target resources using specific attributes.
	Filters []ExperimentTemplateTargetInputFilter

	// The resource type parameters.
	Parameters map[string]string

	// The Amazon Resource Names (ARNs) of the resources.
	ResourceArns []string

	// The tags for the target resources.
	ResourceTags map[string]string
	// contains filtered or unexported fields
}

Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags. For more information, see Targets (https://docs.aws.amazon.com/fis/latest/userguide/targets.html) in the Fault Injection Simulator User Guide.

type Experiment 

type Experiment struct {

	// The actions for the experiment.
	Actions map[string]ExperimentAction

	// The time that the experiment was created.
	CreationTime *time.Time

	// The time that the experiment ended.
	EndTime *time.Time

	// The ID of the experiment template.
	ExperimentTemplateId *string

	// The ID of the experiment.
	Id *string

	// The configuration for experiment logging.
	LogConfiguration *ExperimentLogConfiguration

	// The Amazon Resource Name (ARN) of an IAM role that grants the FIS service
	// permission to perform service actions on your behalf.
	RoleArn *string

	// The time that the experiment started.
	StartTime *time.Time

	// The state of the experiment.
	State *ExperimentState

	// The stop conditions for the experiment.
	StopConditions []ExperimentStopCondition

	// The tags for the experiment.
	Tags map[string]string

	// The targets for the experiment.
	Targets map[string]ExperimentTarget
	// contains filtered or unexported fields
}

Describes an experiment.

type ExperimentAction 

type ExperimentAction struct {

	// The ID of the action.
	ActionId *string

	// The description for the action.
	Description *string

	// The time that the action ended.
	EndTime *time.Time

	// The parameters for the action.
	Parameters map[string]string

	// The name of the action that must be completed before this action starts.
	StartAfter []string

	// The time that the action started.
	StartTime *time.Time

	// The state of the action.
	State *ExperimentActionState

	// The targets for the action.
	Targets map[string]string
	// contains filtered or unexported fields
}

Describes the action for an experiment.

type ExperimentActionState 

type ExperimentActionState struct {

	// The reason for the state.
	Reason *string

	// The state of the action.
	Status ExperimentActionStatus
	// contains filtered or unexported fields
}

Describes the state of an action.

type ExperimentActionStatus 

type ExperimentActionStatus string
const (
	ExperimentActionStatusPending    ExperimentActionStatus = "pending"
	ExperimentActionStatusInitiating ExperimentActionStatus = "initiating"
	ExperimentActionStatusRunning    ExperimentActionStatus = "running"
	ExperimentActionStatusCompleted  ExperimentActionStatus = "completed"
	ExperimentActionStatusCancelled  ExperimentActionStatus = "cancelled"
	ExperimentActionStatusStopping   ExperimentActionStatus = "stopping"
	ExperimentActionStatusStopped    ExperimentActionStatus = "stopped"
	ExperimentActionStatusFailed     ExperimentActionStatus = "failed"
)

Enum values for ExperimentActionStatus

func (ExperimentActionStatus) Values 

func (ExperimentActionStatus) Values() []ExperimentActionStatus

Values returns all known values for ExperimentActionStatus. 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 ExperimentCloudWatchLogsLogConfiguration added in v1.12.0 

type ExperimentCloudWatchLogsLogConfiguration struct {

	// The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log
	// group.
	LogGroupArn *string
	// contains filtered or unexported fields
}

Describes the configuration for experiment logging to Amazon CloudWatch Logs.

type ExperimentLogConfiguration added in v1.12.0 

type ExperimentLogConfiguration struct {

	// The configuration for experiment logging to Amazon CloudWatch Logs.
	CloudWatchLogsConfiguration *ExperimentCloudWatchLogsLogConfiguration

	// The schema version.
	LogSchemaVersion *int32

	// The configuration for experiment logging to Amazon S3.
	S3Configuration *ExperimentS3LogConfiguration
	// contains filtered or unexported fields
}

Describes the configuration for experiment logging.

type ExperimentS3LogConfiguration added in v1.12.0 

type ExperimentS3LogConfiguration struct {

	// The name of the destination bucket.
	BucketName *string

	// The bucket prefix.
	Prefix *string
	// contains filtered or unexported fields
}

Describes the configuration for experiment logging to Amazon S3.

type ExperimentState 

type ExperimentState struct {

	// The reason for the state.
	Reason *string

	// The state of the experiment.
	Status ExperimentStatus
	// contains filtered or unexported fields
}

Describes the state of an experiment.

type ExperimentStatus 

type ExperimentStatus string
const (
	ExperimentStatusPending    ExperimentStatus = "pending"
	ExperimentStatusInitiating ExperimentStatus = "initiating"
	ExperimentStatusRunning    ExperimentStatus = "running"
	ExperimentStatusCompleted  ExperimentStatus = "completed"
	ExperimentStatusStopping   ExperimentStatus = "stopping"
	ExperimentStatusStopped    ExperimentStatus = "stopped"
	ExperimentStatusFailed     ExperimentStatus = "failed"
)

Enum values for ExperimentStatus

func (ExperimentStatus) Values 

func (ExperimentStatus) Values() []ExperimentStatus

Values returns all known values for ExperimentStatus. 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 ExperimentStopCondition 

type ExperimentStopCondition struct {

	// The source for the stop condition.
	Source *string

	// The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
	Value *string
	// contains filtered or unexported fields
}

Describes the stop condition for an experiment.

type ExperimentSummary 

type ExperimentSummary struct {

	// The time that the experiment was created.
	CreationTime *time.Time

	// The ID of the experiment template.
	ExperimentTemplateId *string

	// The ID of the experiment.
	Id *string

	// The state of the experiment.
	State *ExperimentState

	// The tags for the experiment.
	Tags map[string]string
	// contains filtered or unexported fields
}

Provides a summary of an experiment.

type ExperimentTarget 

type ExperimentTarget struct {

	// The filters to apply to identify target resources using specific attributes.
	Filters []ExperimentTargetFilter

	// The resource type parameters.
	Parameters map[string]string

	// The Amazon Resource Names (ARNs) of the resources.
	ResourceArns []string

	// The tags for the target resources.
	ResourceTags map[string]string

	// The resource type.
	ResourceType *string

	// Scopes the identified resources to a specific count or percentage.
	SelectionMode *string
	// contains filtered or unexported fields
}

Describes a target for an experiment.

type ExperimentTargetFilter 

type ExperimentTargetFilter struct {

	// The attribute path for the filter.
	Path *string

	// The attribute values for the filter.
	Values []string
	// contains filtered or unexported fields
}

Describes a filter used for the target resources in an experiment.

type ExperimentTemplate 

type ExperimentTemplate struct {

	// The actions for the experiment.
	Actions map[string]ExperimentTemplateAction

	// The time the experiment template was created.
	CreationTime *time.Time

	// The description for the experiment template.
	Description *string

	// The ID of the experiment template.
	Id *string

	// The time the experiment template was last updated.
	LastUpdateTime *time.Time

	// The configuration for experiment logging.
	LogConfiguration *ExperimentTemplateLogConfiguration

	// The Amazon Resource Name (ARN) of an IAM role.
	RoleArn *string

	// The stop conditions for the experiment.
	StopConditions []ExperimentTemplateStopCondition

	// The tags for the experiment template.
	Tags map[string]string

	// The targets for the experiment.
	Targets map[string]ExperimentTemplateTarget
	// contains filtered or unexported fields
}

Describes an experiment template.

type ExperimentTemplateAction 

type ExperimentTemplateAction struct {

	// The ID of the action.
	ActionId *string

	// A description for the action.
	Description *string

	// The parameters for the action.
	Parameters map[string]string

	// The name of the action that must be completed before the current action starts.
	StartAfter []string

	// The targets for the action.
	Targets map[string]string
	// contains filtered or unexported fields
}

Describes an action for an experiment template.

type ExperimentTemplateCloudWatchLogsLogConfiguration added in v1.12.0 

type ExperimentTemplateCloudWatchLogsLogConfiguration struct {

	// The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log
	// group.
	LogGroupArn *string
	// contains filtered or unexported fields
}

Describes the configuration for experiment logging to Amazon CloudWatch Logs.

type ExperimentTemplateCloudWatchLogsLogConfigurationInput added in v1.12.0 

type ExperimentTemplateCloudWatchLogsLogConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log
	// group.
	//
	// This member is required.
	LogGroupArn *string
	// contains filtered or unexported fields
}

Specifies the configuration for experiment logging to Amazon CloudWatch Logs.

type ExperimentTemplateLogConfiguration added in v1.12.0 

type ExperimentTemplateLogConfiguration struct {

	// The configuration for experiment logging to Amazon CloudWatch Logs.
	CloudWatchLogsConfiguration *ExperimentTemplateCloudWatchLogsLogConfiguration

	// The schema version.
	LogSchemaVersion *int32

	// The configuration for experiment logging to Amazon S3.
	S3Configuration *ExperimentTemplateS3LogConfiguration
	// contains filtered or unexported fields
}

Describes the configuration for experiment logging.

type ExperimentTemplateS3LogConfiguration added in v1.12.0 

type ExperimentTemplateS3LogConfiguration struct {

	// The name of the destination bucket.
	BucketName *string

	// The bucket prefix.
	Prefix *string
	// contains filtered or unexported fields
}

Describes the configuration for experiment logging to Amazon S3.

type ExperimentTemplateS3LogConfigurationInput added in v1.12.0 

type ExperimentTemplateS3LogConfigurationInput struct {

	// The name of the destination bucket.
	//
	// This member is required.
	BucketName *string

	// The bucket prefix.
	Prefix *string
	// contains filtered or unexported fields
}

Specifies the configuration for experiment logging to Amazon S3.

type ExperimentTemplateStopCondition 

type ExperimentTemplateStopCondition struct {

	// The source for the stop condition.
	Source *string

	// The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
	Value *string
	// contains filtered or unexported fields
}

Describes a stop condition for an experiment template.

type ExperimentTemplateSummary 

type ExperimentTemplateSummary struct {

	// The time that the experiment template was created.
	CreationTime *time.Time

	// The description of the experiment template.
	Description *string

	// The ID of the experiment template.
	Id *string

	// The time that the experiment template was last updated.
	LastUpdateTime *time.Time

	// The tags for the experiment template.
	Tags map[string]string
	// contains filtered or unexported fields
}

Provides a summary of an experiment template.

type ExperimentTemplateTarget 

type ExperimentTemplateTarget struct {

	// The filters to apply to identify target resources using specific attributes.
	Filters []ExperimentTemplateTargetFilter

	// The resource type parameters.
	Parameters map[string]string

	// The Amazon Resource Names (ARNs) of the targets.
	ResourceArns []string

	// The tags for the target resources.
	ResourceTags map[string]string

	// The resource type.
	ResourceType *string

	// Scopes the identified resources to a specific count or percentage.
	SelectionMode *string
	// contains filtered or unexported fields
}

Describes a target for an experiment template.

type ExperimentTemplateTargetFilter 

type ExperimentTemplateTargetFilter struct {

	// The attribute path for the filter.
	Path *string

	// The attribute values for the filter.
	Values []string
	// contains filtered or unexported fields
}

Describes a filter used for the target resources in an experiment template.

type ExperimentTemplateTargetInputFilter 

type ExperimentTemplateTargetInputFilter struct {

	// The attribute path for the filter.
	//
	// This member is required.
	Path *string

	// The attribute values for the filter.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Specifies a filter used for the target resource input in an experiment template. For more information, see Resource filters (https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters) in the Fault Injection Simulator User Guide.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource cannot be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

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

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have exceeded your service quota.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type TargetResourceType added in v1.11.0 

type TargetResourceType struct {

	// A description of the resource type.
	Description *string

	// The parameters for the resource type.
	Parameters map[string]TargetResourceTypeParameter

	// The resource type.
	ResourceType *string
	// contains filtered or unexported fields
}

Describes a resource type.

type TargetResourceTypeParameter added in v1.11.0 

type TargetResourceTypeParameter struct {

	// A description of the parameter.
	Description *string

	// Indicates whether the parameter is required.
	Required *bool
	// contains filtered or unexported fields
}

Describes the parameters for a resource type. Use parameters to determine which tasks are identified during target resolution.

type TargetResourceTypeSummary added in v1.11.0 

type TargetResourceTypeSummary struct {

	// A description of the resource type.
	Description *string

	// The resource type.
	ResourceType *string
	// contains filtered or unexported fields
}

Describes a resource type.

type UpdateExperimentTemplateActionInputItem 

type UpdateExperimentTemplateActionInputItem struct {

	// The ID of the action.
	ActionId *string

	// A description for the action.
	Description *string

	// The parameters for the action, if applicable.
	Parameters map[string]string

	// The name of the action that must be completed before the current action starts.
	// Omit this parameter to run the action at the start of the experiment.
	StartAfter []string

	// The targets for the action.
	Targets map[string]string
	// contains filtered or unexported fields
}

Specifies an action for an experiment template.

type UpdateExperimentTemplateLogConfigurationInput added in v1.12.0 

type UpdateExperimentTemplateLogConfigurationInput struct {

	// The configuration for experiment logging to Amazon CloudWatch Logs.
	CloudWatchLogsConfiguration *ExperimentTemplateCloudWatchLogsLogConfigurationInput

	// The schema version.
	LogSchemaVersion *int32

	// The configuration for experiment logging to Amazon S3.
	S3Configuration *ExperimentTemplateS3LogConfigurationInput
	// contains filtered or unexported fields
}

Specifies the configuration for experiment logging.

type UpdateExperimentTemplateStopConditionInput 

type UpdateExperimentTemplateStopConditionInput struct {

	// The source for the stop condition. Specify aws:cloudwatch:alarm if the stop
	// condition is defined by a CloudWatch alarm. Specify none if there is no stop
	// condition.
	//
	// This member is required.
	Source *string

	// The Amazon Resource Name (ARN) of the CloudWatch alarm.
	Value *string
	// contains filtered or unexported fields
}

Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.

type UpdateExperimentTemplateTargetInput 

type UpdateExperimentTemplateTargetInput struct {

	// The resource type. The resource type must be supported for the specified action.
	//
	// This member is required.
	ResourceType *string

	// Scopes the identified resources to a specific count or percentage.
	//
	// This member is required.
	SelectionMode *string

	// The filters to apply to identify target resources using specific attributes.
	Filters []ExperimentTemplateTargetInputFilter

	// The resource type parameters.
	Parameters map[string]string

	// The Amazon Resource Names (ARNs) of the targets.
	ResourceArns []string

	// The tags for the target resources.
	ResourceTags map[string]string
	// contains filtered or unexported fields
}

Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified input is not valid, or fails to satisfy the constraints for the request.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

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.