Documentation ¶
Overview ¶
Package resiliencehub provides the API client, operations, and parameter types for AWS Resilience Hub.
Resilience Hub helps you proactively prepare and protect your Amazon Web Services applications from disruptions. It offers continual resiliency assessment and validation that integrates into your software development lifecycle. This enables you to uncover resiliency weaknesses, ensure recovery time objective (RTO) and recovery point objective (RPO) targets for your applications are met, and resolve issues before they are released into production.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AddDraftAppVersionResourceMappingsInput
- type AddDraftAppVersionResourceMappingsOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type BatchUpdateRecommendationStatusInput
- type BatchUpdateRecommendationStatusOutput
- type Client
- func (c *Client) AddDraftAppVersionResourceMappings(ctx context.Context, params *AddDraftAppVersionResourceMappingsInput, ...) (*AddDraftAppVersionResourceMappingsOutput, error)
- func (c *Client) BatchUpdateRecommendationStatus(ctx context.Context, params *BatchUpdateRecommendationStatusInput, ...) (*BatchUpdateRecommendationStatusOutput, error)
- func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error)
- func (c *Client) CreateAppVersionAppComponent(ctx context.Context, params *CreateAppVersionAppComponentInput, ...) (*CreateAppVersionAppComponentOutput, error)
- func (c *Client) CreateAppVersionResource(ctx context.Context, params *CreateAppVersionResourceInput, ...) (*CreateAppVersionResourceOutput, error)
- func (c *Client) CreateRecommendationTemplate(ctx context.Context, params *CreateRecommendationTemplateInput, ...) (*CreateRecommendationTemplateOutput, error)
- func (c *Client) CreateResiliencyPolicy(ctx context.Context, params *CreateResiliencyPolicyInput, ...) (*CreateResiliencyPolicyOutput, error)
- func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)
- func (c *Client) DeleteAppAssessment(ctx context.Context, params *DeleteAppAssessmentInput, ...) (*DeleteAppAssessmentOutput, error)
- func (c *Client) DeleteAppInputSource(ctx context.Context, params *DeleteAppInputSourceInput, ...) (*DeleteAppInputSourceOutput, error)
- func (c *Client) DeleteAppVersionAppComponent(ctx context.Context, params *DeleteAppVersionAppComponentInput, ...) (*DeleteAppVersionAppComponentOutput, error)
- func (c *Client) DeleteAppVersionResource(ctx context.Context, params *DeleteAppVersionResourceInput, ...) (*DeleteAppVersionResourceOutput, error)
- func (c *Client) DeleteRecommendationTemplate(ctx context.Context, params *DeleteRecommendationTemplateInput, ...) (*DeleteRecommendationTemplateOutput, error)
- func (c *Client) DeleteResiliencyPolicy(ctx context.Context, params *DeleteResiliencyPolicyInput, ...) (*DeleteResiliencyPolicyOutput, error)
- func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optFns ...func(*Options)) (*DescribeAppOutput, error)
- func (c *Client) DescribeAppAssessment(ctx context.Context, params *DescribeAppAssessmentInput, ...) (*DescribeAppAssessmentOutput, error)
- func (c *Client) DescribeAppVersion(ctx context.Context, params *DescribeAppVersionInput, optFns ...func(*Options)) (*DescribeAppVersionOutput, error)
- func (c *Client) DescribeAppVersionAppComponent(ctx context.Context, params *DescribeAppVersionAppComponentInput, ...) (*DescribeAppVersionAppComponentOutput, error)
- func (c *Client) DescribeAppVersionResource(ctx context.Context, params *DescribeAppVersionResourceInput, ...) (*DescribeAppVersionResourceOutput, error)
- func (c *Client) DescribeAppVersionResourcesResolutionStatus(ctx context.Context, params *DescribeAppVersionResourcesResolutionStatusInput, ...) (*DescribeAppVersionResourcesResolutionStatusOutput, error)
- func (c *Client) DescribeAppVersionTemplate(ctx context.Context, params *DescribeAppVersionTemplateInput, ...) (*DescribeAppVersionTemplateOutput, error)
- func (c *Client) DescribeDraftAppVersionResourcesImportStatus(ctx context.Context, params *DescribeDraftAppVersionResourcesImportStatusInput, ...) (*DescribeDraftAppVersionResourcesImportStatusOutput, error)
- func (c *Client) DescribeResiliencyPolicy(ctx context.Context, params *DescribeResiliencyPolicyInput, ...) (*DescribeResiliencyPolicyOutput, error)
- func (c *Client) ImportResourcesToDraftAppVersion(ctx context.Context, params *ImportResourcesToDraftAppVersionInput, ...) (*ImportResourcesToDraftAppVersionOutput, error)
- func (c *Client) ListAlarmRecommendations(ctx context.Context, params *ListAlarmRecommendationsInput, ...) (*ListAlarmRecommendationsOutput, error)
- func (c *Client) ListAppAssessmentComplianceDrifts(ctx context.Context, params *ListAppAssessmentComplianceDriftsInput, ...) (*ListAppAssessmentComplianceDriftsOutput, error)
- func (c *Client) ListAppAssessmentResourceDrifts(ctx context.Context, params *ListAppAssessmentResourceDriftsInput, ...) (*ListAppAssessmentResourceDriftsOutput, error)
- func (c *Client) ListAppAssessments(ctx context.Context, params *ListAppAssessmentsInput, optFns ...func(*Options)) (*ListAppAssessmentsOutput, error)
- func (c *Client) ListAppComponentCompliances(ctx context.Context, params *ListAppComponentCompliancesInput, ...) (*ListAppComponentCompliancesOutput, error)
- func (c *Client) ListAppComponentRecommendations(ctx context.Context, params *ListAppComponentRecommendationsInput, ...) (*ListAppComponentRecommendationsOutput, error)
- func (c *Client) ListAppInputSources(ctx context.Context, params *ListAppInputSourcesInput, ...) (*ListAppInputSourcesOutput, error)
- func (c *Client) ListAppVersionAppComponents(ctx context.Context, params *ListAppVersionAppComponentsInput, ...) (*ListAppVersionAppComponentsOutput, error)
- func (c *Client) ListAppVersionResourceMappings(ctx context.Context, params *ListAppVersionResourceMappingsInput, ...) (*ListAppVersionResourceMappingsOutput, error)
- func (c *Client) ListAppVersionResources(ctx context.Context, params *ListAppVersionResourcesInput, ...) (*ListAppVersionResourcesOutput, error)
- func (c *Client) ListAppVersions(ctx context.Context, params *ListAppVersionsInput, optFns ...func(*Options)) (*ListAppVersionsOutput, error)
- func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)
- func (c *Client) ListRecommendationTemplates(ctx context.Context, params *ListRecommendationTemplatesInput, ...) (*ListRecommendationTemplatesOutput, error)
- func (c *Client) ListResiliencyPolicies(ctx context.Context, params *ListResiliencyPoliciesInput, ...) (*ListResiliencyPoliciesOutput, error)
- func (c *Client) ListSopRecommendations(ctx context.Context, params *ListSopRecommendationsInput, ...) (*ListSopRecommendationsOutput, error)
- func (c *Client) ListSuggestedResiliencyPolicies(ctx context.Context, params *ListSuggestedResiliencyPoliciesInput, ...) (*ListSuggestedResiliencyPoliciesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTestRecommendations(ctx context.Context, params *ListTestRecommendationsInput, ...) (*ListTestRecommendationsOutput, error)
- func (c *Client) ListUnsupportedAppVersionResources(ctx context.Context, params *ListUnsupportedAppVersionResourcesInput, ...) (*ListUnsupportedAppVersionResourcesOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PublishAppVersion(ctx context.Context, params *PublishAppVersionInput, optFns ...func(*Options)) (*PublishAppVersionOutput, error)
- func (c *Client) PutDraftAppVersionTemplate(ctx context.Context, params *PutDraftAppVersionTemplateInput, ...) (*PutDraftAppVersionTemplateOutput, error)
- func (c *Client) RemoveDraftAppVersionResourceMappings(ctx context.Context, params *RemoveDraftAppVersionResourceMappingsInput, ...) (*RemoveDraftAppVersionResourceMappingsOutput, error)
- func (c *Client) ResolveAppVersionResources(ctx context.Context, params *ResolveAppVersionResourcesInput, ...) (*ResolveAppVersionResourcesOutput, error)
- func (c *Client) StartAppAssessment(ctx context.Context, params *StartAppAssessmentInput, optFns ...func(*Options)) (*StartAppAssessmentOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns ...func(*Options)) (*UpdateAppOutput, error)
- func (c *Client) UpdateAppVersion(ctx context.Context, params *UpdateAppVersionInput, optFns ...func(*Options)) (*UpdateAppVersionOutput, error)
- func (c *Client) UpdateAppVersionAppComponent(ctx context.Context, params *UpdateAppVersionAppComponentInput, ...) (*UpdateAppVersionAppComponentOutput, error)
- func (c *Client) UpdateAppVersionResource(ctx context.Context, params *UpdateAppVersionResourceInput, ...) (*UpdateAppVersionResourceOutput, error)
- func (c *Client) UpdateResiliencyPolicy(ctx context.Context, params *UpdateResiliencyPolicyInput, ...) (*UpdateResiliencyPolicyOutput, error)
- type CreateAppInput
- type CreateAppOutput
- type CreateAppVersionAppComponentInput
- type CreateAppVersionAppComponentOutput
- type CreateAppVersionResourceInput
- type CreateAppVersionResourceOutput
- type CreateRecommendationTemplateInput
- type CreateRecommendationTemplateOutput
- type CreateResiliencyPolicyInput
- type CreateResiliencyPolicyOutput
- type DeleteAppAssessmentInput
- type DeleteAppAssessmentOutput
- type DeleteAppInput
- type DeleteAppInputSourceInput
- type DeleteAppInputSourceOutput
- type DeleteAppOutput
- type DeleteAppVersionAppComponentInput
- type DeleteAppVersionAppComponentOutput
- type DeleteAppVersionResourceInput
- type DeleteAppVersionResourceOutput
- type DeleteRecommendationTemplateInput
- type DeleteRecommendationTemplateOutput
- type DeleteResiliencyPolicyInput
- type DeleteResiliencyPolicyOutput
- type DescribeAppAssessmentInput
- type DescribeAppAssessmentOutput
- type DescribeAppInput
- type DescribeAppOutput
- type DescribeAppVersionAppComponentInput
- type DescribeAppVersionAppComponentOutput
- type DescribeAppVersionInput
- type DescribeAppVersionOutput
- type DescribeAppVersionResourceInput
- type DescribeAppVersionResourceOutput
- type DescribeAppVersionResourcesResolutionStatusInput
- type DescribeAppVersionResourcesResolutionStatusOutput
- type DescribeAppVersionTemplateInput
- type DescribeAppVersionTemplateOutput
- type DescribeDraftAppVersionResourcesImportStatusInput
- type DescribeDraftAppVersionResourcesImportStatusOutput
- type DescribeResiliencyPolicyInput
- type DescribeResiliencyPolicyOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ImportResourcesToDraftAppVersionInput
- type ImportResourcesToDraftAppVersionOutput
- type ListAlarmRecommendationsAPIClient
- type ListAlarmRecommendationsInput
- type ListAlarmRecommendationsOutput
- type ListAlarmRecommendationsPaginator
- type ListAlarmRecommendationsPaginatorOptions
- type ListAppAssessmentComplianceDriftsAPIClient
- type ListAppAssessmentComplianceDriftsInput
- type ListAppAssessmentComplianceDriftsOutput
- type ListAppAssessmentComplianceDriftsPaginator
- type ListAppAssessmentComplianceDriftsPaginatorOptions
- type ListAppAssessmentResourceDriftsAPIClient
- type ListAppAssessmentResourceDriftsInput
- type ListAppAssessmentResourceDriftsOutput
- type ListAppAssessmentResourceDriftsPaginator
- type ListAppAssessmentResourceDriftsPaginatorOptions
- type ListAppAssessmentsAPIClient
- type ListAppAssessmentsInput
- type ListAppAssessmentsOutput
- type ListAppAssessmentsPaginator
- type ListAppAssessmentsPaginatorOptions
- type ListAppComponentCompliancesAPIClient
- type ListAppComponentCompliancesInput
- type ListAppComponentCompliancesOutput
- type ListAppComponentCompliancesPaginator
- type ListAppComponentCompliancesPaginatorOptions
- type ListAppComponentRecommendationsAPIClient
- type ListAppComponentRecommendationsInput
- type ListAppComponentRecommendationsOutput
- type ListAppComponentRecommendationsPaginator
- type ListAppComponentRecommendationsPaginatorOptions
- type ListAppInputSourcesAPIClient
- type ListAppInputSourcesInput
- type ListAppInputSourcesOutput
- type ListAppInputSourcesPaginator
- type ListAppInputSourcesPaginatorOptions
- type ListAppVersionAppComponentsAPIClient
- type ListAppVersionAppComponentsInput
- type ListAppVersionAppComponentsOutput
- type ListAppVersionAppComponentsPaginator
- type ListAppVersionAppComponentsPaginatorOptions
- type ListAppVersionResourceMappingsAPIClient
- type ListAppVersionResourceMappingsInput
- type ListAppVersionResourceMappingsOutput
- type ListAppVersionResourceMappingsPaginator
- type ListAppVersionResourceMappingsPaginatorOptions
- type ListAppVersionResourcesAPIClient
- type ListAppVersionResourcesInput
- type ListAppVersionResourcesOutput
- type ListAppVersionResourcesPaginator
- type ListAppVersionResourcesPaginatorOptions
- type ListAppVersionsAPIClient
- type ListAppVersionsInput
- type ListAppVersionsOutput
- type ListAppVersionsPaginator
- type ListAppVersionsPaginatorOptions
- type ListAppsAPIClient
- type ListAppsInput
- type ListAppsOutput
- type ListAppsPaginator
- type ListAppsPaginatorOptions
- type ListRecommendationTemplatesAPIClient
- type ListRecommendationTemplatesInput
- type ListRecommendationTemplatesOutput
- type ListRecommendationTemplatesPaginator
- type ListRecommendationTemplatesPaginatorOptions
- type ListResiliencyPoliciesAPIClient
- type ListResiliencyPoliciesInput
- type ListResiliencyPoliciesOutput
- type ListResiliencyPoliciesPaginator
- type ListResiliencyPoliciesPaginatorOptions
- type ListSopRecommendationsAPIClient
- type ListSopRecommendationsInput
- type ListSopRecommendationsOutput
- type ListSopRecommendationsPaginator
- type ListSopRecommendationsPaginatorOptions
- type ListSuggestedResiliencyPoliciesAPIClient
- type ListSuggestedResiliencyPoliciesInput
- type ListSuggestedResiliencyPoliciesOutput
- type ListSuggestedResiliencyPoliciesPaginator
- type ListSuggestedResiliencyPoliciesPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTestRecommendationsAPIClient
- type ListTestRecommendationsInput
- type ListTestRecommendationsOutput
- type ListTestRecommendationsPaginator
- type ListTestRecommendationsPaginatorOptions
- type ListUnsupportedAppVersionResourcesAPIClient
- type ListUnsupportedAppVersionResourcesInput
- type ListUnsupportedAppVersionResourcesOutput
- type ListUnsupportedAppVersionResourcesPaginator
- type ListUnsupportedAppVersionResourcesPaginatorOptions
- type Options
- type PublishAppVersionInput
- type PublishAppVersionOutput
- type PutDraftAppVersionTemplateInput
- type PutDraftAppVersionTemplateOutput
- type RemoveDraftAppVersionResourceMappingsInput
- type RemoveDraftAppVersionResourceMappingsOutput
- type ResolveAppVersionResourcesInput
- type ResolveAppVersionResourcesOutput
- type ResolveEndpoint
- type StartAppAssessmentInput
- type StartAppAssessmentOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAppInput
- type UpdateAppOutput
- type UpdateAppVersionAppComponentInput
- type UpdateAppVersionAppComponentOutput
- type UpdateAppVersionInput
- type UpdateAppVersionOutput
- type UpdateAppVersionResourceInput
- type UpdateAppVersionResourceOutput
- type UpdateResiliencyPolicyInput
- type UpdateResiliencyPolicyOutput
Constants ¶
const ServiceAPIVersion = "2020-04-30"
const ServiceID = "resiliencehub"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AddDraftAppVersionResourceMappingsInput ¶
type AddDraftAppVersionResourceMappingsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Mappings used to map logical resources from the template to physical resources. // You can use the mapping type CFN_STACK if the application template uses a // logical stack name. Or you can map individual resources by using the mapping // type RESOURCE . We recommend using the mapping type CFN_STACK if the // application is backed by a CloudFormation stack. // // This member is required. ResourceMappings []types.ResourceMapping // contains filtered or unexported fields }
type AddDraftAppVersionResourceMappingsOutput ¶
type AddDraftAppVersionResourceMappingsOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // List of sources that are used to map a logical resource from the template to a // physical resource. You can use sources such as CloudFormation, Terraform state // files, AppRegistry applications, or Amazon EKS. // // This member is required. ResourceMappings []types.ResourceMapping // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type BatchUpdateRecommendationStatusInput ¶
type BatchUpdateRecommendationStatusInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Defines the list of operational recommendations that need to be included or // excluded. // // This member is required. RequestEntries []types.UpdateRecommendationStatusRequestEntry // contains filtered or unexported fields }
type BatchUpdateRecommendationStatusOutput ¶
type BatchUpdateRecommendationStatusOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // A list of items with error details about each item, which could not be included // or excluded. // // This member is required. FailedEntries []types.BatchUpdateRecommendationStatusFailedEntry // A list of items that were included or excluded. // // This member is required. SuccessfulEntries []types.BatchUpdateRecommendationStatusSuccessfulEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Resilience Hub.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AddDraftAppVersionResourceMappings ¶
func (c *Client) AddDraftAppVersionResourceMappings(ctx context.Context, params *AddDraftAppVersionResourceMappingsInput, optFns ...func(*Options)) (*AddDraftAppVersionResourceMappingsOutput, error)
Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources suported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed?in the Resilience Hub User Guide.
func (*Client) BatchUpdateRecommendationStatus ¶
func (c *Client) BatchUpdateRecommendationStatus(ctx context.Context, params *BatchUpdateRecommendationStatusInput, optFns ...func(*Options)) (*BatchUpdateRecommendationStatusOutput, error)
Enables you to include or exclude one or more operational recommendations.
func (*Client) CreateApp ¶
func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error)
Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.
After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).
func (*Client) CreateAppVersionAppComponent ¶
func (c *Client) CreateAppVersionAppComponent(ctx context.Context, params *CreateAppVersionAppComponentInput, optFns ...func(*Options)) (*CreateAppVersionAppComponentOutput, error)
Creates a new Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
func (*Client) CreateAppVersionResource ¶
func (c *Client) CreateAppVersionResource(ctx context.Context, params *CreateAppVersionResourceInput, optFns ...func(*Options)) (*CreateAppVersionResourceOutput, error)
Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID , you must call ResolveAppVersionResources API.
func (*Client) CreateRecommendationTemplate ¶
func (c *Client) CreateRecommendationTemplate(ctx context.Context, params *CreateRecommendationTemplateInput, optFns ...func(*Options)) (*CreateRecommendationTemplateOutput, error)
Creates a new recommendation template for the Resilience Hub application.
func (*Client) CreateResiliencyPolicy ¶
func (c *Client) CreateResiliencyPolicy(ctx context.Context, params *CreateResiliencyPolicyInput, optFns ...func(*Options)) (*CreateResiliencyPolicyOutput, error)
Creates a resiliency policy for an application.
Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.
func (*Client) DeleteApp ¶
func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)
Deletes an Resilience Hub application. This is a destructive action that can't be undone.
func (*Client) DeleteAppAssessment ¶
func (c *Client) DeleteAppAssessment(ctx context.Context, params *DeleteAppAssessmentInput, optFns ...func(*Options)) (*DeleteAppAssessmentOutput, error)
Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.
func (*Client) DeleteAppInputSource ¶
func (c *Client) DeleteAppInputSource(ctx context.Context, params *DeleteAppInputSourceInput, optFns ...func(*Options)) (*DeleteAppInputSourceOutput, error)
Deletes the input source and all of its imported resources from the Resilience Hub application.
func (*Client) DeleteAppVersionAppComponent ¶
func (c *Client) DeleteAppVersionAppComponent(ctx context.Context, params *DeleteAppVersionAppComponentInput, optFns ...func(*Options)) (*DeleteAppVersionAppComponentOutput, error)
Deletes an Application Component from the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
You will not be able to delete an Application Component if it has resources associated with it.
func (*Client) DeleteAppVersionResource ¶
func (c *Client) DeleteAppVersionResource(ctx context.Context, params *DeleteAppVersionResourceInput, optFns ...func(*Options)) (*DeleteAppVersionResourceOutput, error)
Deletes a resource from the Resilience Hub application.
You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
func (*Client) DeleteRecommendationTemplate ¶
func (c *Client) DeleteRecommendationTemplate(ctx context.Context, params *DeleteRecommendationTemplateInput, optFns ...func(*Options)) (*DeleteRecommendationTemplateOutput, error)
Deletes a recommendation template. This is a destructive action that can't be undone.
func (*Client) DeleteResiliencyPolicy ¶
func (c *Client) DeleteResiliencyPolicy(ctx context.Context, params *DeleteResiliencyPolicyInput, optFns ...func(*Options)) (*DeleteResiliencyPolicyOutput, error)
Deletes a resiliency policy. This is a destructive action that can't be undone.
func (*Client) DescribeApp ¶
func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optFns ...func(*Options)) (*DescribeAppOutput, error)
Describes an Resilience Hub application.
func (*Client) DescribeAppAssessment ¶
func (c *Client) DescribeAppAssessment(ctx context.Context, params *DescribeAppAssessmentInput, optFns ...func(*Options)) (*DescribeAppAssessmentOutput, error)
Describes an assessment for an Resilience Hub application.
func (*Client) DescribeAppVersion ¶
func (c *Client) DescribeAppVersion(ctx context.Context, params *DescribeAppVersionInput, optFns ...func(*Options)) (*DescribeAppVersionOutput, error)
Describes the Resilience Hub application version.
func (*Client) DescribeAppVersionAppComponent ¶
func (c *Client) DescribeAppVersionAppComponent(ctx context.Context, params *DescribeAppVersionAppComponentInput, optFns ...func(*Options)) (*DescribeAppVersionAppComponentOutput, error)
Describes an Application Component in the Resilience Hub application.
func (*Client) DescribeAppVersionResource ¶
func (c *Client) DescribeAppVersionResource(ctx context.Context, params *DescribeAppVersionResourceInput, optFns ...func(*Options)) (*DescribeAppVersionResourceOutput, error)
Describes a resource of the Resilience Hub application.
This API accepts only one of the following parameters to descibe the resource:
resourceName
logicalResourceId
physicalResourceId (Along with physicalResourceId , you can also provide awsAccountId , and awsRegion )
func (*Client) DescribeAppVersionResourcesResolutionStatus ¶
func (c *Client) DescribeAppVersionResourcesResolutionStatus(ctx context.Context, params *DescribeAppVersionResourcesResolutionStatusInput, optFns ...func(*Options)) (*DescribeAppVersionResourcesResolutionStatusOutput, error)
Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.
func (*Client) DescribeAppVersionTemplate ¶
func (c *Client) DescribeAppVersionTemplate(ctx context.Context, params *DescribeAppVersionTemplateInput, optFns ...func(*Options)) (*DescribeAppVersionTemplateOutput, error)
Describes details about an Resilience Hub application.
func (*Client) DescribeDraftAppVersionResourcesImportStatus ¶
func (c *Client) DescribeDraftAppVersionResourcesImportStatus(ctx context.Context, params *DescribeDraftAppVersionResourcesImportStatusInput, optFns ...func(*Options)) (*DescribeDraftAppVersionResourcesImportStatusOutput, error)
Describes the status of importing resources to an application version.
If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException , you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.
func (*Client) DescribeResiliencyPolicy ¶
func (c *Client) DescribeResiliencyPolicy(ctx context.Context, params *DescribeResiliencyPolicyInput, optFns ...func(*Options)) (*DescribeResiliencyPolicyOutput, error)
Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.
func (*Client) ImportResourcesToDraftAppVersion ¶
func (c *Client) ImportResourcesToDraftAppVersion(ctx context.Context, params *ImportResourcesToDraftAppVersionInput, optFns ...func(*Options)) (*ImportResourcesToDraftAppVersionOutput, error)
Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
func (*Client) ListAlarmRecommendations ¶
func (c *Client) ListAlarmRecommendations(ctx context.Context, params *ListAlarmRecommendationsInput, optFns ...func(*Options)) (*ListAlarmRecommendationsOutput, error)
Lists the alarm recommendations for an Resilience Hub application.
func (*Client) ListAppAssessmentComplianceDrifts ¶
func (c *Client) ListAppAssessmentComplianceDrifts(ctx context.Context, params *ListAppAssessmentComplianceDriftsInput, optFns ...func(*Options)) (*ListAppAssessmentComplianceDriftsOutput, error)
List of compliance drifts that were detected while running an assessment.
func (*Client) ListAppAssessmentResourceDrifts ¶
func (c *Client) ListAppAssessmentResourceDrifts(ctx context.Context, params *ListAppAssessmentResourceDriftsInput, optFns ...func(*Options)) (*ListAppAssessmentResourceDriftsOutput, error)
Indicates the list of resource drifts that were detected while running an assessment.
func (*Client) ListAppAssessments ¶
func (c *Client) ListAppAssessments(ctx context.Context, params *ListAppAssessmentsInput, optFns ...func(*Options)) (*ListAppAssessmentsOutput, error)
Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
func (*Client) ListAppComponentCompliances ¶
func (c *Client) ListAppComponentCompliances(ctx context.Context, params *ListAppComponentCompliancesInput, optFns ...func(*Options)) (*ListAppComponentCompliancesOutput, error)
Lists the compliances for an Resilience Hub Application Component.
func (*Client) ListAppComponentRecommendations ¶
func (c *Client) ListAppComponentRecommendations(ctx context.Context, params *ListAppComponentRecommendationsInput, optFns ...func(*Options)) (*ListAppComponentRecommendationsOutput, error)
Lists the recommendations for an Resilience Hub Application Component.
func (*Client) ListAppInputSources ¶
func (c *Client) ListAppInputSources(ctx context.Context, params *ListAppInputSourcesInput, optFns ...func(*Options)) (*ListAppInputSourcesOutput, error)
Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.
func (*Client) ListAppVersionAppComponents ¶
func (c *Client) ListAppVersionAppComponents(ctx context.Context, params *ListAppVersionAppComponentsInput, optFns ...func(*Options)) (*ListAppVersionAppComponentsOutput, error)
Lists all the Application Components in the Resilience Hub application.
func (*Client) ListAppVersionResourceMappings ¶
func (c *Client) ListAppVersionResourceMappings(ctx context.Context, params *ListAppVersionResourceMappingsInput, optFns ...func(*Options)) (*ListAppVersionResourceMappingsOutput, error)
Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.
func (*Client) ListAppVersionResources ¶
func (c *Client) ListAppVersionResources(ctx context.Context, params *ListAppVersionResourcesInput, optFns ...func(*Options)) (*ListAppVersionResourcesOutput, error)
Lists all the resources in an Resilience Hub application.
func (*Client) ListAppVersions ¶
func (c *Client) ListAppVersions(ctx context.Context, params *ListAppVersionsInput, optFns ...func(*Options)) (*ListAppVersionsOutput, error)
Lists the different versions for the Resilience Hub applications.
func (*Client) ListApps ¶
func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)
Lists your Resilience Hub applications.
You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error:
An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation.
func (*Client) ListRecommendationTemplates ¶
func (c *Client) ListRecommendationTemplates(ctx context.Context, params *ListRecommendationTemplatesInput, optFns ...func(*Options)) (*ListRecommendationTemplatesOutput, error)
Lists the recommendation templates for the Resilience Hub applications.
func (*Client) ListResiliencyPolicies ¶
func (c *Client) ListResiliencyPolicies(ctx context.Context, params *ListResiliencyPoliciesInput, optFns ...func(*Options)) (*ListResiliencyPoliciesOutput, error)
Lists the resiliency policies for the Resilience Hub applications.
func (*Client) ListSopRecommendations ¶
func (c *Client) ListSopRecommendations(ctx context.Context, params *ListSopRecommendationsInput, optFns ...func(*Options)) (*ListSopRecommendationsOutput, error)
Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
func (*Client) ListSuggestedResiliencyPolicies ¶
func (c *Client) ListSuggestedResiliencyPolicies(ctx context.Context, params *ListSuggestedResiliencyPoliciesInput, optFns ...func(*Options)) (*ListSuggestedResiliencyPoliciesOutput, error)
Lists the suggested resiliency policies for the Resilience Hub applications.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for your resources in your Resilience Hub applications.
func (*Client) ListTestRecommendations ¶
func (c *Client) ListTestRecommendations(ctx context.Context, params *ListTestRecommendationsInput, optFns ...func(*Options)) (*ListTestRecommendationsOutput, error)
Lists the test recommendations for the Resilience Hub application.
func (*Client) ListUnsupportedAppVersionResources ¶
func (c *Client) ListUnsupportedAppVersionResources(ctx context.Context, params *ListUnsupportedAppVersionResourcesInput, optFns ...func(*Options)) (*ListUnsupportedAppVersionResourcesOutput, error)
Lists the resources that are not currently supported in Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PublishAppVersion ¶
func (c *Client) PublishAppVersion(ctx context.Context, params *PublishAppVersionInput, optFns ...func(*Options)) (*PublishAppVersionOutput, error)
Publishes a new version of a specific Resilience Hub application.
func (*Client) PutDraftAppVersionTemplate ¶
func (c *Client) PutDraftAppVersionTemplate(ctx context.Context, params *PutDraftAppVersionTemplateInput, optFns ...func(*Options)) (*PutDraftAppVersionTemplateOutput, error)
Adds or updates the app template for an Resilience Hub application draft version.
func (*Client) RemoveDraftAppVersionResourceMappings ¶
func (c *Client) RemoveDraftAppVersionResourceMappings(ctx context.Context, params *RemoveDraftAppVersionResourceMappingsInput, optFns ...func(*Options)) (*RemoveDraftAppVersionResourceMappingsOutput, error)
Removes resource mappings from a draft application version.
func (*Client) ResolveAppVersionResources ¶
func (c *Client) ResolveAppVersionResources(ctx context.Context, params *ResolveAppVersionResourcesInput, optFns ...func(*Options)) (*ResolveAppVersionResourcesOutput, error)
Resolves the resources for an application version.
func (*Client) StartAppAssessment ¶
func (c *Client) StartAppAssessment(ctx context.Context, params *StartAppAssessmentInput, optFns ...func(*Options)) (*StartAppAssessmentOutput, error)
Creates a new application assessment for an application.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Applies one or more tags to a resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from a resource.
func (*Client) UpdateApp ¶
func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns ...func(*Options)) (*UpdateAppOutput, error)
Updates an application.
func (*Client) UpdateAppVersion ¶
func (c *Client) UpdateAppVersion(ctx context.Context, params *UpdateAppVersionInput, optFns ...func(*Options)) (*UpdateAppVersionOutput, error)
Updates the Resilience Hub application version.
This API updates the Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
func (*Client) UpdateAppVersionAppComponent ¶
func (c *Client) UpdateAppVersionAppComponent(ctx context.Context, params *UpdateAppVersionAppComponentInput, optFns ...func(*Options)) (*UpdateAppVersionAppComponentOutput, error)
Updates an existing Application Component in the Resilience Hub application.
This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
func (*Client) UpdateAppVersionResource ¶
func (c *Client) UpdateAppVersionResource(ctx context.Context, params *UpdateAppVersionResourceInput, optFns ...func(*Options)) (*UpdateAppVersionResourceOutput, error)
Updates the resource details in the Resilience Hub application.
This action has no effect outside Resilience Hub.
This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.
To update application version with new physicalResourceID , you must call ResolveAppVersionResources API.
func (*Client) UpdateResiliencyPolicy ¶
func (c *Client) UpdateResiliencyPolicy(ctx context.Context, params *UpdateResiliencyPolicyInput, optFns ...func(*Options)) (*UpdateResiliencyPolicyOutput, error)
Updates a resiliency policy.
Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.
type CreateAppInput ¶
type CreateAppInput struct { // Name of the application. // // This member is required. Name *string // Assessment execution schedule with 'Daily' or 'Disabled' values. AssessmentSchedule types.AppAssessmentScheduleType // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // The optional description for an app. Description *string // The list of events you would like to subscribe and get notification for. // Currently, Resilience Hub supports only Drift detected and Scheduled assessment // failure events notification. EventSubscriptions []types.EventSubscription // Defines the roles and credentials that Resilience Hub would use while creating // the application, importing its resources, and running an assessment. PermissionModel *types.PermissionModel // Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN // is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General // Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string // Tags assigned to the resource. A tag is a label that you assign to an Amazon // Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // contains filtered or unexported fields }
type CreateAppOutput ¶
type CreateAppOutput struct { // The created application returned as an object with details including compliance // status, creation time, description, resiliency score, and more. // // This member is required. App *types.App // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateAppVersionAppComponentInput ¶
type CreateAppVersionAppComponentInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Name of the Application Component. // // This member is required. Name *string // Type of Application Component. For more information about the types of // Application Component, see [Grouping resources in an AppComponent]. // // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html // // This member is required. Type *string // Currently, there is no supported additional information for Application // Components. AdditionalInfo map[string][]string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // Identifier of the Application Component. Id *string // contains filtered or unexported fields }
type CreateAppVersionAppComponentOutput ¶
type CreateAppVersionAppComponentOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // List of Application Components that belong to this resource. AppComponent *types.AppComponent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateAppVersionResourceInput ¶
type CreateAppVersionResourceInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // List of Application Components that this resource belongs to. If an Application // Component is not part of the Resilience Hub application, it will be added. // // This member is required. AppComponents []string // Logical identifier of the resource. // // This member is required. LogicalResourceId *types.LogicalResourceId // Physical identifier of the resource. // // This member is required. PhysicalResourceId *string // Type of resource. // // This member is required. ResourceType *string // Currently, there is no supported additional information for resources. AdditionalInfo map[string][]string // Amazon Web Services account that owns the physical resource. AwsAccountId *string // Amazon Web Services region that owns the physical resource. AwsRegion *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // Name of the resource. ResourceName *string // contains filtered or unexported fields }
type CreateAppVersionResourceOutput ¶
type CreateAppVersionResourceOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Defines a physical resource. A physical resource is a resource that exists in // your account. It can be identified using an Amazon Resource Name (ARN) or a // Resilience Hub-native identifier. PhysicalResource *types.PhysicalResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateRecommendationTemplateInput ¶
type CreateRecommendationTemplateInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // The name for the recommendation template. // // This member is required. Name *string // The name of the Amazon S3 bucket that will contain the recommendation template. BucketName *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // The format for the recommendation template. // // CfnJson The template is CloudFormation JSON. // // CfnYaml The template is CloudFormation YAML. Format types.TemplateFormat // Identifiers for the recommendations used to create a recommendation template. RecommendationIds []string // An array of strings that specify the recommendation template type or types. // // Alarm The template is an AlarmRecommendation template. // // Sop The template is a SopRecommendation template. // // Test The template is a TestRecommendation template. RecommendationTypes []types.RenderRecommendationType // Tags assigned to the resource. A tag is a label that you assign to an Amazon // Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // contains filtered or unexported fields }
type CreateRecommendationTemplateOutput ¶
type CreateRecommendationTemplateOutput struct { // The newly created recommendation template, returned as an object. This object // includes the template's name, format, status, tags, Amazon S3 bucket location, // and more. RecommendationTemplate *types.RecommendationTemplate // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateResiliencyPolicyInput ¶
type CreateResiliencyPolicyInput struct { // The type of resiliency policy to be created, including the recovery time // objective (RTO) and recovery point objective (RPO) in seconds. // // This member is required. Policy map[string]types.FailurePolicy // The name of the policy // // This member is required. PolicyName *string // The tier for this resiliency policy, ranging from the highest severity ( // MissionCritical ) to lowest ( NonCritical ). // // This member is required. Tier types.ResiliencyPolicyTier // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // Specifies a high-level geographical location constraint for where your // resilience policy data can be stored. DataLocationConstraint types.DataLocationConstraint // The description for the policy. PolicyDescription *string // Tags assigned to the resource. A tag is a label that you assign to an Amazon // Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // contains filtered or unexported fields }
type CreateResiliencyPolicyOutput ¶
type CreateResiliencyPolicyOutput struct { // The type of resiliency policy that was created, including the recovery time // objective (RTO) and recovery point objective (RPO) in seconds. // // This member is required. Policy *types.ResiliencyPolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAppAssessmentInput ¶
type DeleteAppAssessmentInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // contains filtered or unexported fields }
type DeleteAppAssessmentOutput ¶
type DeleteAppAssessmentOutput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // The current status of the assessment for the resiliency policy. // // This member is required. AssessmentStatus types.AssessmentStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAppInput ¶
type DeleteAppInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // A boolean option to force the deletion of an Resilience Hub application. ForceDelete *bool // contains filtered or unexported fields }
type DeleteAppInputSourceInput ¶
type DeleteAppInputSourceInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // The namespace on your Amazon Elastic Kubernetes Service cluster that you want // to delete from the Resilience Hub application. EksSourceClusterNamespace *types.EksSourceClusterNamespace // The Amazon Resource Name (ARN) of the imported resource you want to remove from // the Resilience Hub application. For more information about ARNs, see [Amazon Resource Names (ARNs)]in the // Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html SourceArn *string // The imported Terraform s3 state file you want to remove from the Resilience Hub // application. TerraformSource *types.TerraformSource // contains filtered or unexported fields }
type DeleteAppInputSourceOutput ¶
type DeleteAppInputSourceOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Name of the input source from where the application resource is imported from. AppInputSource *types.AppInputSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAppOutput ¶
type DeleteAppOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAppVersionAppComponentInput ¶
type DeleteAppVersionAppComponentInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Identifier of the Application Component. // // This member is required. Id *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // contains filtered or unexported fields }
type DeleteAppVersionAppComponentOutput ¶
type DeleteAppVersionAppComponentOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // List of Application Components that belong to this resource. AppComponent *types.AppComponent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAppVersionResourceInput ¶
type DeleteAppVersionResourceInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Amazon Web Services account that owns the physical resource. AwsAccountId *string // Amazon Web Services region that owns the physical resource. AwsRegion *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // Logical identifier of the resource. LogicalResourceId *types.LogicalResourceId // Physical identifier of the resource. PhysicalResourceId *string // Name of the resource. ResourceName *string // contains filtered or unexported fields }
type DeleteAppVersionResourceOutput ¶
type DeleteAppVersionResourceOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Defines a physical resource. A physical resource is a resource that exists in // your account. It can be identified using an Amazon Resource Name (ARN) or a // Resilience Hub-native identifier. PhysicalResource *types.PhysicalResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRecommendationTemplateInput ¶
type DeleteRecommendationTemplateInput struct { // The Amazon Resource Name (ARN) for a recommendation template. // // This member is required. RecommendationTemplateArn *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // contains filtered or unexported fields }
type DeleteRecommendationTemplateOutput ¶
type DeleteRecommendationTemplateOutput struct { // The Amazon Resource Name (ARN) for a recommendation template. // // This member is required. RecommendationTemplateArn *string // Status of the action. // // This member is required. Status types.RecommendationTemplateStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteResiliencyPolicyInput ¶
type DeleteResiliencyPolicyInput struct { // Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN // is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General // Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // contains filtered or unexported fields }
type DeleteResiliencyPolicyOutput ¶
type DeleteResiliencyPolicyOutput struct { // Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN // is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General // Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppAssessmentInput ¶
type DescribeAppAssessmentInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // contains filtered or unexported fields }
type DescribeAppAssessmentOutput ¶
type DescribeAppAssessmentOutput struct { // The assessment for an Resilience Hub application, returned as an object. This // object includes Amazon Resource Names (ARNs), compliance information, compliance // status, cost, messages, resiliency scores, and more. // // This member is required. Assessment *types.AppAssessment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppInput ¶
type DescribeAppInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // contains filtered or unexported fields }
type DescribeAppOutput ¶
type DescribeAppOutput struct { // The specified application, returned as an object with details including // compliance status, creation time, description, resiliency score, and more. // // This member is required. App *types.App // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppVersionAppComponentInput ¶
type DescribeAppVersionAppComponentInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Identifier of the Application Component. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeAppVersionAppComponentOutput ¶
type DescribeAppVersionAppComponentOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // List of Application Components that belong to this resource. AppComponent *types.AppComponent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppVersionInput ¶
type DescribeAppVersionInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // contains filtered or unexported fields }
type DescribeAppVersionOutput ¶
type DescribeAppVersionOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than // using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter supports only failover region and account. // // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html AdditionalInfo map[string][]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppVersionResourceInput ¶
type DescribeAppVersionResourceInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Amazon Web Services account that owns the physical resource. AwsAccountId *string // Amazon Web Services region that owns the physical resource. AwsRegion *string // Logical identifier of the resource. LogicalResourceId *types.LogicalResourceId // Physical identifier of the resource. PhysicalResourceId *string // Name of the resource. ResourceName *string // contains filtered or unexported fields }
type DescribeAppVersionResourceOutput ¶
type DescribeAppVersionResourceOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Defines a physical resource. A physical resource is a resource that exists in // your account. It can be identified using an Amazon Resource Name (ARN) or a // Resilience Hub-native identifier. PhysicalResource *types.PhysicalResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppVersionResourcesResolutionStatusInput ¶
type DescribeAppVersionResourcesResolutionStatusInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // The identifier for a specific resolution. ResolutionId *string // contains filtered or unexported fields }
type DescribeAppVersionResourcesResolutionStatusOutput ¶
type DescribeAppVersionResourcesResolutionStatusOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // The identifier for a specific resolution. // // This member is required. ResolutionId *string // Status of the action. // // This member is required. Status types.ResourceResolutionStatusType // The returned error message for the request. ErrorMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAppVersionTemplateInput ¶
type DescribeAppVersionTemplateInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // contains filtered or unexported fields }
type DescribeAppVersionTemplateOutput ¶
type DescribeAppVersionTemplateOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // A JSON string that provides information about your application structure. To // learn more about the appTemplateBody template, see the sample template provided // in the Examples section. // // The appTemplateBody JSON string has the following structure: // // - resources // // The list of logical resources that must be included in the Resilience Hub // application. // // Type: Array // // Don't add the resources that you want to exclude. // // Each resources array item includes the following fields: // // - logicalResourceId // // Logical identifier of the resource. // // Type: Object // // Each logicalResourceId object includes the following fields: // // - identifier // // Identifier of the resource. // // Type: String // // - logicalStackName // // The name of the CloudFormation stack this resource belongs to. // // Type: String // // - resourceGroupName // // The name of the resource group this resource belongs to. // // Type: String // // - terraformSourceName // // The name of the Terraform S3 state file this resource belongs to. // // Type: String // // - eksSourceName // // Name of the Amazon Elastic Kubernetes Service cluster and namespace this // resource belongs to. // // This parameter accepts values in "eks-cluster/namespace" format. // // Type: String // // - type // // The type of resource. // // Type: string // // - name // // The name of the resource. // // Type: String // // - additionalInfo // // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather // than using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // - appComponents // // List of Application Components that this resource belongs to. If an Application // Component is not part of the Resilience Hub application, it will be added. // // Type: Array // // Each appComponents array item includes the following fields: // // - name // // Name of the Application Component. // // Type: String // // - type // // Type of Application Component. For more information about the types of // Application Component, see [Grouping resources in an AppComponent]. // // Type: String // // - resourceNames // // The list of included resources that are assigned to the Application Component. // // Type: Array of strings // // - additionalInfo // // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather // than using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // - excludedResources // // The list of logical resource identifiers to be excluded from the application. // // Type: Array // // Don't add the resources that you want to include. // // Each excludedResources array item includes the following fields: // // - logicalResourceIds // // Logical identifier of the resource. // // Type: Object // // You can configure only one of the following fields: // // - logicalStackName // // - resourceGroupName // // - terraformSourceName // // - eksSourceName // // Each logicalResourceIds object includes the following fields: // // - identifier // // Identifier of the resource. // // Type: String // // - logicalStackName // // The name of the CloudFormation stack this resource belongs to. // // Type: String // // - resourceGroupName // // The name of the resource group this resource belongs to. // // Type: String // // - terraformSourceName // // The name of the Terraform S3 state file this resource belongs to. // // Type: String // // - eksSourceName // // Name of the Amazon Elastic Kubernetes Service cluster and namespace this // resource belongs to. // // This parameter accepts values in "eks-cluster/namespace" format. // // Type: String // // - version // // Resilience Hub application version. // // - additionalInfo // // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather // than using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html // // This member is required. AppTemplateBody *string // The version of the application. // // This member is required. AppVersion *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeDraftAppVersionResourcesImportStatusInput ¶
type DescribeDraftAppVersionResourcesImportStatusInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // contains filtered or unexported fields }
type DescribeDraftAppVersionResourcesImportStatusOutput ¶
type DescribeDraftAppVersionResourcesImportStatusOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // Status of the action. // // This member is required. Status types.ResourceImportStatusType // The time when the status last changed. // // This member is required. StatusChangeTime *time.Time // The returned error message for the request. ErrorMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeResiliencyPolicyInput ¶
type DescribeResiliencyPolicyInput struct { // Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN // is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General // Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // contains filtered or unexported fields }
type DescribeResiliencyPolicyOutput ¶
type DescribeResiliencyPolicyOutput struct { // Information about the specific resiliency policy, returned as an object. This // object includes creation time, data location constraints, its name, description, // tags, the recovery time objective (RTO) and recovery point objective (RPO) in // seconds, and more. // // This member is required. Policy *types.ResiliencyPolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ImportResourcesToDraftAppVersionInput ¶
type ImportResourcesToDraftAppVersionInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The input sources of the Amazon Elastic Kubernetes Service resources you need // to import. EksSources []types.EksSource // The import strategy you would like to set to import resources into Resilience // Hub application. ImportStrategy types.ResourceImportStrategyType // The Amazon Resource Names (ARNs) for the resources. SourceArns []string // A list of terraform file s3 URLs you need to import. TerraformSources []types.TerraformSource // contains filtered or unexported fields }
type ImportResourcesToDraftAppVersionOutput ¶
type ImportResourcesToDraftAppVersionOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // Status of the action. // // This member is required. Status types.ResourceImportStatusType // The input sources of the Amazon Elastic Kubernetes Service resources you have // imported. EksSources []types.EksSource // The Amazon Resource Names (ARNs) for the resources you have imported. SourceArns []string // A list of terraform file s3 URLs you have imported. TerraformSources []types.TerraformSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAlarmRecommendationsAPIClient ¶
type ListAlarmRecommendationsAPIClient interface {
ListAlarmRecommendations(context.Context, *ListAlarmRecommendationsInput, ...func(*Options)) (*ListAlarmRecommendationsOutput, error)
}
ListAlarmRecommendationsAPIClient is a client that implements the ListAlarmRecommendations operation.
type ListAlarmRecommendationsInput ¶
type ListAlarmRecommendationsInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAlarmRecommendationsOutput ¶
type ListAlarmRecommendationsOutput struct { // The alarm recommendations for an Resilience Hub application, returned as an // object. This object includes Application Component names, descriptions, // information about whether a recommendation has already been implemented or not, // prerequisites, and more. // // This member is required. AlarmRecommendations []types.AlarmRecommendation // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAlarmRecommendationsPaginator ¶
type ListAlarmRecommendationsPaginator struct {
// contains filtered or unexported fields
}
ListAlarmRecommendationsPaginator is a paginator for ListAlarmRecommendations
func NewListAlarmRecommendationsPaginator ¶
func NewListAlarmRecommendationsPaginator(client ListAlarmRecommendationsAPIClient, params *ListAlarmRecommendationsInput, optFns ...func(*ListAlarmRecommendationsPaginatorOptions)) *ListAlarmRecommendationsPaginator
NewListAlarmRecommendationsPaginator returns a new ListAlarmRecommendationsPaginator
func (*ListAlarmRecommendationsPaginator) HasMorePages ¶
func (p *ListAlarmRecommendationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAlarmRecommendationsPaginator) NextPage ¶
func (p *ListAlarmRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAlarmRecommendationsOutput, error)
NextPage retrieves the next ListAlarmRecommendations page.
type ListAlarmRecommendationsPaginatorOptions ¶
type ListAlarmRecommendationsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAlarmRecommendationsPaginatorOptions is the paginator options for ListAlarmRecommendations
type ListAppAssessmentComplianceDriftsAPIClient ¶
type ListAppAssessmentComplianceDriftsAPIClient interface {
ListAppAssessmentComplianceDrifts(context.Context, *ListAppAssessmentComplianceDriftsInput, ...func(*Options)) (*ListAppAssessmentComplianceDriftsOutput, error)
}
ListAppAssessmentComplianceDriftsAPIClient is a client that implements the ListAppAssessmentComplianceDrifts operation.
type ListAppAssessmentComplianceDriftsInput ¶
type ListAppAssessmentComplianceDriftsInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Indicates the maximum number of applications requested. MaxResults *int32 // Indicates the unique token number of the next application to be checked for // compliance and regulatory requirements from the list of applications. NextToken *string // contains filtered or unexported fields }
type ListAppAssessmentComplianceDriftsOutput ¶
type ListAppAssessmentComplianceDriftsOutput struct { // Indicates compliance drifts (recovery time objective (RTO) and recovery point // objective (RPO)) detected for an assessed entity. // // This member is required. ComplianceDrifts []types.ComplianceDrift // Token number of the next application to be checked for compliance and // regulatory requirements from the list of applications. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppAssessmentComplianceDriftsPaginator ¶
type ListAppAssessmentComplianceDriftsPaginator struct {
// contains filtered or unexported fields
}
ListAppAssessmentComplianceDriftsPaginator is a paginator for ListAppAssessmentComplianceDrifts
func NewListAppAssessmentComplianceDriftsPaginator ¶
func NewListAppAssessmentComplianceDriftsPaginator(client ListAppAssessmentComplianceDriftsAPIClient, params *ListAppAssessmentComplianceDriftsInput, optFns ...func(*ListAppAssessmentComplianceDriftsPaginatorOptions)) *ListAppAssessmentComplianceDriftsPaginator
NewListAppAssessmentComplianceDriftsPaginator returns a new ListAppAssessmentComplianceDriftsPaginator
func (*ListAppAssessmentComplianceDriftsPaginator) HasMorePages ¶
func (p *ListAppAssessmentComplianceDriftsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppAssessmentComplianceDriftsPaginator) NextPage ¶
func (p *ListAppAssessmentComplianceDriftsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppAssessmentComplianceDriftsOutput, error)
NextPage retrieves the next ListAppAssessmentComplianceDrifts page.
type ListAppAssessmentComplianceDriftsPaginatorOptions ¶
type ListAppAssessmentComplianceDriftsPaginatorOptions struct { // Indicates the maximum number of applications requested. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppAssessmentComplianceDriftsPaginatorOptions is the paginator options for ListAppAssessmentComplianceDrifts
type ListAppAssessmentResourceDriftsAPIClient ¶
type ListAppAssessmentResourceDriftsAPIClient interface {
ListAppAssessmentResourceDrifts(context.Context, *ListAppAssessmentResourceDriftsInput, ...func(*Options)) (*ListAppAssessmentResourceDriftsOutput, error)
}
ListAppAssessmentResourceDriftsAPIClient is a client that implements the ListAppAssessmentResourceDrifts operation.
type ListAppAssessmentResourceDriftsInput ¶
type ListAppAssessmentResourceDriftsInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Indicates the maximum number of drift results to include in the response. If // more results exist than the specified MaxResults value, a token is included in // the response so that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAppAssessmentResourceDriftsOutput ¶
type ListAppAssessmentResourceDriftsOutput struct { // Indicates all the resource drifts detected for an assessed entity. // // This member is required. ResourceDrifts []types.ResourceDrift // Null, or the token from a previous call to get the next set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppAssessmentResourceDriftsPaginator ¶
type ListAppAssessmentResourceDriftsPaginator struct {
// contains filtered or unexported fields
}
ListAppAssessmentResourceDriftsPaginator is a paginator for ListAppAssessmentResourceDrifts
func NewListAppAssessmentResourceDriftsPaginator ¶
func NewListAppAssessmentResourceDriftsPaginator(client ListAppAssessmentResourceDriftsAPIClient, params *ListAppAssessmentResourceDriftsInput, optFns ...func(*ListAppAssessmentResourceDriftsPaginatorOptions)) *ListAppAssessmentResourceDriftsPaginator
NewListAppAssessmentResourceDriftsPaginator returns a new ListAppAssessmentResourceDriftsPaginator
func (*ListAppAssessmentResourceDriftsPaginator) HasMorePages ¶
func (p *ListAppAssessmentResourceDriftsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppAssessmentResourceDriftsPaginator) NextPage ¶
func (p *ListAppAssessmentResourceDriftsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppAssessmentResourceDriftsOutput, error)
NextPage retrieves the next ListAppAssessmentResourceDrifts page.
type ListAppAssessmentResourceDriftsPaginatorOptions ¶
type ListAppAssessmentResourceDriftsPaginatorOptions struct { // Indicates the maximum number of drift results to include in the response. If // more results exist than the specified MaxResults value, a token is included in // the response so that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppAssessmentResourceDriftsPaginatorOptions is the paginator options for ListAppAssessmentResourceDrifts
type ListAppAssessmentsAPIClient ¶
type ListAppAssessmentsAPIClient interface {
ListAppAssessments(context.Context, *ListAppAssessmentsInput, ...func(*Options)) (*ListAppAssessmentsOutput, error)
}
ListAppAssessmentsAPIClient is a client that implements the ListAppAssessments operation.
type ListAppAssessmentsInput ¶
type ListAppAssessmentsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The name for the assessment. AssessmentName *string // The current status of the assessment for the resiliency policy. AssessmentStatus []types.AssessmentStatus // The current status of compliance for the resiliency policy. ComplianceStatus types.ComplianceStatus // Specifies the entity that invoked a specific assessment, either a User or the // System . Invoker types.AssessmentInvoker // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // The default is to sort by ascending startTime. To sort by descending startTime, // set reverseOrder to true . ReverseOrder *bool // contains filtered or unexported fields }
type ListAppAssessmentsOutput ¶
type ListAppAssessmentsOutput struct { // The summaries for the specified assessments, returned as an object. This object // includes application versions, associated Amazon Resource Numbers (ARNs), cost, // messages, resiliency scores, and more. // // This member is required. AssessmentSummaries []types.AppAssessmentSummary // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppAssessmentsPaginator ¶
type ListAppAssessmentsPaginator struct {
// contains filtered or unexported fields
}
ListAppAssessmentsPaginator is a paginator for ListAppAssessments
func NewListAppAssessmentsPaginator ¶
func NewListAppAssessmentsPaginator(client ListAppAssessmentsAPIClient, params *ListAppAssessmentsInput, optFns ...func(*ListAppAssessmentsPaginatorOptions)) *ListAppAssessmentsPaginator
NewListAppAssessmentsPaginator returns a new ListAppAssessmentsPaginator
func (*ListAppAssessmentsPaginator) HasMorePages ¶
func (p *ListAppAssessmentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppAssessmentsPaginator) NextPage ¶
func (p *ListAppAssessmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppAssessmentsOutput, error)
NextPage retrieves the next ListAppAssessments page.
type ListAppAssessmentsPaginatorOptions ¶
type ListAppAssessmentsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppAssessmentsPaginatorOptions is the paginator options for ListAppAssessments
type ListAppComponentCompliancesAPIClient ¶
type ListAppComponentCompliancesAPIClient interface {
ListAppComponentCompliances(context.Context, *ListAppComponentCompliancesInput, ...func(*Options)) (*ListAppComponentCompliancesOutput, error)
}
ListAppComponentCompliancesAPIClient is a client that implements the ListAppComponentCompliances operation.
type ListAppComponentCompliancesInput ¶
type ListAppComponentCompliancesInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAppComponentCompliancesOutput ¶
type ListAppComponentCompliancesOutput struct { // The compliances for an Resilience Hub Application Component, returned as an // object. This object contains the names of the Application Components, // compliances, costs, resiliency scores, outage scores, and more. // // This member is required. ComponentCompliances []types.AppComponentCompliance // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppComponentCompliancesPaginator ¶
type ListAppComponentCompliancesPaginator struct {
// contains filtered or unexported fields
}
ListAppComponentCompliancesPaginator is a paginator for ListAppComponentCompliances
func NewListAppComponentCompliancesPaginator ¶
func NewListAppComponentCompliancesPaginator(client ListAppComponentCompliancesAPIClient, params *ListAppComponentCompliancesInput, optFns ...func(*ListAppComponentCompliancesPaginatorOptions)) *ListAppComponentCompliancesPaginator
NewListAppComponentCompliancesPaginator returns a new ListAppComponentCompliancesPaginator
func (*ListAppComponentCompliancesPaginator) HasMorePages ¶
func (p *ListAppComponentCompliancesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppComponentCompliancesPaginator) NextPage ¶
func (p *ListAppComponentCompliancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppComponentCompliancesOutput, error)
NextPage retrieves the next ListAppComponentCompliances page.
type ListAppComponentCompliancesPaginatorOptions ¶
type ListAppComponentCompliancesPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppComponentCompliancesPaginatorOptions is the paginator options for ListAppComponentCompliances
type ListAppComponentRecommendationsAPIClient ¶
type ListAppComponentRecommendationsAPIClient interface {
ListAppComponentRecommendations(context.Context, *ListAppComponentRecommendationsInput, ...func(*Options)) (*ListAppComponentRecommendationsOutput, error)
}
ListAppComponentRecommendationsAPIClient is a client that implements the ListAppComponentRecommendations operation.
type ListAppComponentRecommendationsInput ¶
type ListAppComponentRecommendationsInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAppComponentRecommendationsOutput ¶
type ListAppComponentRecommendationsOutput struct { // The recommendations for an Resilience Hub Application Component, returned as an // object. This object contains the names of the Application Components, // configuration recommendations, and recommendation statuses. // // This member is required. ComponentRecommendations []types.ComponentRecommendation // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppComponentRecommendationsPaginator ¶
type ListAppComponentRecommendationsPaginator struct {
// contains filtered or unexported fields
}
ListAppComponentRecommendationsPaginator is a paginator for ListAppComponentRecommendations
func NewListAppComponentRecommendationsPaginator ¶
func NewListAppComponentRecommendationsPaginator(client ListAppComponentRecommendationsAPIClient, params *ListAppComponentRecommendationsInput, optFns ...func(*ListAppComponentRecommendationsPaginatorOptions)) *ListAppComponentRecommendationsPaginator
NewListAppComponentRecommendationsPaginator returns a new ListAppComponentRecommendationsPaginator
func (*ListAppComponentRecommendationsPaginator) HasMorePages ¶
func (p *ListAppComponentRecommendationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppComponentRecommendationsPaginator) NextPage ¶
func (p *ListAppComponentRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppComponentRecommendationsOutput, error)
NextPage retrieves the next ListAppComponentRecommendations page.
type ListAppComponentRecommendationsPaginatorOptions ¶
type ListAppComponentRecommendationsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppComponentRecommendationsPaginatorOptions is the paginator options for ListAppComponentRecommendations
type ListAppInputSourcesAPIClient ¶
type ListAppInputSourcesAPIClient interface {
ListAppInputSources(context.Context, *ListAppInputSourcesInput, ...func(*Options)) (*ListAppInputSourcesOutput, error)
}
ListAppInputSourcesAPIClient is a client that implements the ListAppInputSources operation.
type ListAppInputSourcesInput ¶
type ListAppInputSourcesInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Maximum number of input sources to be displayed per Resilience Hub application. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAppInputSourcesOutput ¶
type ListAppInputSourcesOutput struct { // The list of Resilience Hub application input sources. // // This member is required. AppInputSources []types.AppInputSource // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppInputSourcesPaginator ¶
type ListAppInputSourcesPaginator struct {
// contains filtered or unexported fields
}
ListAppInputSourcesPaginator is a paginator for ListAppInputSources
func NewListAppInputSourcesPaginator ¶
func NewListAppInputSourcesPaginator(client ListAppInputSourcesAPIClient, params *ListAppInputSourcesInput, optFns ...func(*ListAppInputSourcesPaginatorOptions)) *ListAppInputSourcesPaginator
NewListAppInputSourcesPaginator returns a new ListAppInputSourcesPaginator
func (*ListAppInputSourcesPaginator) HasMorePages ¶
func (p *ListAppInputSourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppInputSourcesPaginator) NextPage ¶
func (p *ListAppInputSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppInputSourcesOutput, error)
NextPage retrieves the next ListAppInputSources page.
type ListAppInputSourcesPaginatorOptions ¶
type ListAppInputSourcesPaginatorOptions struct { // Maximum number of input sources to be displayed per Resilience Hub application. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppInputSourcesPaginatorOptions is the paginator options for ListAppInputSources
type ListAppVersionAppComponentsAPIClient ¶
type ListAppVersionAppComponentsAPIClient interface {
ListAppVersionAppComponents(context.Context, *ListAppVersionAppComponentsInput, ...func(*Options)) (*ListAppVersionAppComponentsOutput, error)
}
ListAppVersionAppComponentsAPIClient is a client that implements the ListAppVersionAppComponents operation.
type ListAppVersionAppComponentsInput ¶
type ListAppVersionAppComponentsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Version of the Application Component. // // This member is required. AppVersion *string // Maximum number of Application Components to be displayed per Resilience Hub // application version. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAppVersionAppComponentsOutput ¶
type ListAppVersionAppComponentsOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Defines an Application Component. AppComponents []types.AppComponent // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppVersionAppComponentsPaginator ¶
type ListAppVersionAppComponentsPaginator struct {
// contains filtered or unexported fields
}
ListAppVersionAppComponentsPaginator is a paginator for ListAppVersionAppComponents
func NewListAppVersionAppComponentsPaginator ¶
func NewListAppVersionAppComponentsPaginator(client ListAppVersionAppComponentsAPIClient, params *ListAppVersionAppComponentsInput, optFns ...func(*ListAppVersionAppComponentsPaginatorOptions)) *ListAppVersionAppComponentsPaginator
NewListAppVersionAppComponentsPaginator returns a new ListAppVersionAppComponentsPaginator
func (*ListAppVersionAppComponentsPaginator) HasMorePages ¶
func (p *ListAppVersionAppComponentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppVersionAppComponentsPaginator) NextPage ¶
func (p *ListAppVersionAppComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppVersionAppComponentsOutput, error)
NextPage retrieves the next ListAppVersionAppComponents page.
type ListAppVersionAppComponentsPaginatorOptions ¶
type ListAppVersionAppComponentsPaginatorOptions struct { // Maximum number of Application Components to be displayed per Resilience Hub // application version. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppVersionAppComponentsPaginatorOptions is the paginator options for ListAppVersionAppComponents
type ListAppVersionResourceMappingsAPIClient ¶
type ListAppVersionResourceMappingsAPIClient interface {
ListAppVersionResourceMappings(context.Context, *ListAppVersionResourceMappingsInput, ...func(*Options)) (*ListAppVersionResourceMappingsOutput, error)
}
ListAppVersionResourceMappingsAPIClient is a client that implements the ListAppVersionResourceMappings operation.
type ListAppVersionResourceMappingsInput ¶
type ListAppVersionResourceMappingsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListAppVersionResourceMappingsOutput ¶
type ListAppVersionResourceMappingsOutput struct { // Mappings used to map logical resources from the template to physical resources. // You can use the mapping type CFN_STACK if the application template uses a // logical stack name. Or you can map individual resources by using the mapping // type RESOURCE . We recommend using the mapping type CFN_STACK if the // application is backed by a CloudFormation stack. // // This member is required. ResourceMappings []types.ResourceMapping // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppVersionResourceMappingsPaginator ¶
type ListAppVersionResourceMappingsPaginator struct {
// contains filtered or unexported fields
}
ListAppVersionResourceMappingsPaginator is a paginator for ListAppVersionResourceMappings
func NewListAppVersionResourceMappingsPaginator ¶
func NewListAppVersionResourceMappingsPaginator(client ListAppVersionResourceMappingsAPIClient, params *ListAppVersionResourceMappingsInput, optFns ...func(*ListAppVersionResourceMappingsPaginatorOptions)) *ListAppVersionResourceMappingsPaginator
NewListAppVersionResourceMappingsPaginator returns a new ListAppVersionResourceMappingsPaginator
func (*ListAppVersionResourceMappingsPaginator) HasMorePages ¶
func (p *ListAppVersionResourceMappingsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppVersionResourceMappingsPaginator) NextPage ¶
func (p *ListAppVersionResourceMappingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppVersionResourceMappingsOutput, error)
NextPage retrieves the next ListAppVersionResourceMappings page.
type ListAppVersionResourceMappingsPaginatorOptions ¶
type ListAppVersionResourceMappingsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppVersionResourceMappingsPaginatorOptions is the paginator options for ListAppVersionResourceMappings
type ListAppVersionResourcesAPIClient ¶
type ListAppVersionResourcesAPIClient interface {
ListAppVersionResources(context.Context, *ListAppVersionResourcesInput, ...func(*Options)) (*ListAppVersionResourcesOutput, error)
}
ListAppVersionResourcesAPIClient is a client that implements the ListAppVersionResources operation.
type ListAppVersionResourcesInput ¶
type ListAppVersionResourcesInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // The identifier for a specific resolution. ResolutionId *string // contains filtered or unexported fields }
type ListAppVersionResourcesOutput ¶
type ListAppVersionResourcesOutput struct { // The physical resources in the application version. // // This member is required. PhysicalResources []types.PhysicalResource // The ID for a specific resolution. // // This member is required. ResolutionId *string // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppVersionResourcesPaginator ¶
type ListAppVersionResourcesPaginator struct {
// contains filtered or unexported fields
}
ListAppVersionResourcesPaginator is a paginator for ListAppVersionResources
func NewListAppVersionResourcesPaginator ¶
func NewListAppVersionResourcesPaginator(client ListAppVersionResourcesAPIClient, params *ListAppVersionResourcesInput, optFns ...func(*ListAppVersionResourcesPaginatorOptions)) *ListAppVersionResourcesPaginator
NewListAppVersionResourcesPaginator returns a new ListAppVersionResourcesPaginator
func (*ListAppVersionResourcesPaginator) HasMorePages ¶
func (p *ListAppVersionResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppVersionResourcesPaginator) NextPage ¶
func (p *ListAppVersionResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppVersionResourcesOutput, error)
NextPage retrieves the next ListAppVersionResources page.
type ListAppVersionResourcesPaginatorOptions ¶
type ListAppVersionResourcesPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppVersionResourcesPaginatorOptions is the paginator options for ListAppVersionResources
type ListAppVersionsAPIClient ¶
type ListAppVersionsAPIClient interface {
ListAppVersions(context.Context, *ListAppVersionsInput, ...func(*Options)) (*ListAppVersionsOutput, error)
}
ListAppVersionsAPIClient is a client that implements the ListAppVersions operation.
type ListAppVersionsInput ¶
type ListAppVersionsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Upper limit of the time range to filter the application versions. EndTime *time.Time // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // Lower limit of the time range to filter the application versions. StartTime *time.Time // contains filtered or unexported fields }
type ListAppVersionsOutput ¶
type ListAppVersionsOutput struct { // The version of the application. // // This member is required. AppVersions []types.AppVersionSummary // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppVersionsPaginator ¶
type ListAppVersionsPaginator struct {
// contains filtered or unexported fields
}
ListAppVersionsPaginator is a paginator for ListAppVersions
func NewListAppVersionsPaginator ¶
func NewListAppVersionsPaginator(client ListAppVersionsAPIClient, params *ListAppVersionsInput, optFns ...func(*ListAppVersionsPaginatorOptions)) *ListAppVersionsPaginator
NewListAppVersionsPaginator returns a new ListAppVersionsPaginator
func (*ListAppVersionsPaginator) HasMorePages ¶
func (p *ListAppVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppVersionsPaginator) NextPage ¶
func (p *ListAppVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppVersionsOutput, error)
NextPage retrieves the next ListAppVersions page.
type ListAppVersionsPaginatorOptions ¶
type ListAppVersionsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppVersionsPaginatorOptions is the paginator options for ListAppVersions
type ListAppsAPIClient ¶
type ListAppsAPIClient interface {
ListApps(context.Context, *ListAppsInput, ...func(*Options)) (*ListAppsOutput, error)
}
ListAppsAPIClient is a client that implements the ListApps operation.
type ListAppsInput ¶
type ListAppsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Indicates the lower limit of the range that is used to filter applications // based on their last assessment times. FromLastAssessmentTime *time.Time // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // The name for the one of the listed applications. Name *string // Null, or the token from a previous call to get the next set of results. NextToken *string // The application list is sorted based on the values of // lastAppComplianceEvaluationTime field. By default, application list is sorted in // ascending order. To sort the appliation list in descending order, set this field // to True . ReverseOrder *bool // Indicates the upper limit of the range that is used to filter the applications // based on their last assessment times. ToLastAssessmentTime *time.Time // contains filtered or unexported fields }
type ListAppsOutput ¶
type ListAppsOutput struct { // Summaries for the Resilience Hub application. // // This member is required. AppSummaries []types.AppSummary // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAppsPaginator ¶
type ListAppsPaginator struct {
// contains filtered or unexported fields
}
ListAppsPaginator is a paginator for ListApps
func NewListAppsPaginator ¶
func NewListAppsPaginator(client ListAppsAPIClient, params *ListAppsInput, optFns ...func(*ListAppsPaginatorOptions)) *ListAppsPaginator
NewListAppsPaginator returns a new ListAppsPaginator
func (*ListAppsPaginator) HasMorePages ¶
func (p *ListAppsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppsPaginator) NextPage ¶
func (p *ListAppsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppsOutput, error)
NextPage retrieves the next ListApps page.
type ListAppsPaginatorOptions ¶
type ListAppsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAppsPaginatorOptions is the paginator options for ListApps
type ListRecommendationTemplatesAPIClient ¶
type ListRecommendationTemplatesAPIClient interface {
ListRecommendationTemplates(context.Context, *ListRecommendationTemplatesInput, ...func(*Options)) (*ListRecommendationTemplatesOutput, error)
}
ListRecommendationTemplatesAPIClient is a client that implements the ListRecommendationTemplates operation.
type ListRecommendationTemplatesInput ¶
type ListRecommendationTemplatesInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AssessmentArn *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // The name for one of the listed recommendation templates. Name *string // Null, or the token from a previous call to get the next set of results. NextToken *string // The Amazon Resource Name (ARN) for a recommendation template. RecommendationTemplateArn *string // The default is to sort by ascending startTime. To sort by descending startTime, // set reverseOrder to true . ReverseOrder *bool // Status of the action. Status []types.RecommendationTemplateStatus // contains filtered or unexported fields }
type ListRecommendationTemplatesOutput ¶
type ListRecommendationTemplatesOutput struct { // Token for the next set of results, or null if there are no more results. NextToken *string // The recommendation templates for the Resilience Hub applications. RecommendationTemplates []types.RecommendationTemplate // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRecommendationTemplatesPaginator ¶
type ListRecommendationTemplatesPaginator struct {
// contains filtered or unexported fields
}
ListRecommendationTemplatesPaginator is a paginator for ListRecommendationTemplates
func NewListRecommendationTemplatesPaginator ¶
func NewListRecommendationTemplatesPaginator(client ListRecommendationTemplatesAPIClient, params *ListRecommendationTemplatesInput, optFns ...func(*ListRecommendationTemplatesPaginatorOptions)) *ListRecommendationTemplatesPaginator
NewListRecommendationTemplatesPaginator returns a new ListRecommendationTemplatesPaginator
func (*ListRecommendationTemplatesPaginator) HasMorePages ¶
func (p *ListRecommendationTemplatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRecommendationTemplatesPaginator) NextPage ¶
func (p *ListRecommendationTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationTemplatesOutput, error)
NextPage retrieves the next ListRecommendationTemplates page.
type ListRecommendationTemplatesPaginatorOptions ¶
type ListRecommendationTemplatesPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRecommendationTemplatesPaginatorOptions is the paginator options for ListRecommendationTemplates
type ListResiliencyPoliciesAPIClient ¶
type ListResiliencyPoliciesAPIClient interface {
ListResiliencyPolicies(context.Context, *ListResiliencyPoliciesInput, ...func(*Options)) (*ListResiliencyPoliciesOutput, error)
}
ListResiliencyPoliciesAPIClient is a client that implements the ListResiliencyPolicies operation.
type ListResiliencyPoliciesInput ¶
type ListResiliencyPoliciesInput struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // The name of the policy PolicyName *string // contains filtered or unexported fields }
type ListResiliencyPoliciesOutput ¶
type ListResiliencyPoliciesOutput struct { // The resiliency policies for the Resilience Hub applications. // // This member is required. ResiliencyPolicies []types.ResiliencyPolicy // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResiliencyPoliciesPaginator ¶
type ListResiliencyPoliciesPaginator struct {
// contains filtered or unexported fields
}
ListResiliencyPoliciesPaginator is a paginator for ListResiliencyPolicies
func NewListResiliencyPoliciesPaginator ¶
func NewListResiliencyPoliciesPaginator(client ListResiliencyPoliciesAPIClient, params *ListResiliencyPoliciesInput, optFns ...func(*ListResiliencyPoliciesPaginatorOptions)) *ListResiliencyPoliciesPaginator
NewListResiliencyPoliciesPaginator returns a new ListResiliencyPoliciesPaginator
func (*ListResiliencyPoliciesPaginator) HasMorePages ¶
func (p *ListResiliencyPoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResiliencyPoliciesPaginator) NextPage ¶
func (p *ListResiliencyPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResiliencyPoliciesOutput, error)
NextPage retrieves the next ListResiliencyPolicies page.
type ListResiliencyPoliciesPaginatorOptions ¶
type ListResiliencyPoliciesPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResiliencyPoliciesPaginatorOptions is the paginator options for ListResiliencyPolicies
type ListSopRecommendationsAPIClient ¶
type ListSopRecommendationsAPIClient interface {
ListSopRecommendations(context.Context, *ListSopRecommendationsInput, ...func(*Options)) (*ListSopRecommendationsOutput, error)
}
ListSopRecommendationsAPIClient is a client that implements the ListSopRecommendations operation.
type ListSopRecommendationsInput ¶
type ListSopRecommendationsInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListSopRecommendationsOutput ¶
type ListSopRecommendationsOutput struct { // The standard operating procedure (SOP) recommendations for the Resilience Hub // applications. // // This member is required. SopRecommendations []types.SopRecommendation // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSopRecommendationsPaginator ¶
type ListSopRecommendationsPaginator struct {
// contains filtered or unexported fields
}
ListSopRecommendationsPaginator is a paginator for ListSopRecommendations
func NewListSopRecommendationsPaginator ¶
func NewListSopRecommendationsPaginator(client ListSopRecommendationsAPIClient, params *ListSopRecommendationsInput, optFns ...func(*ListSopRecommendationsPaginatorOptions)) *ListSopRecommendationsPaginator
NewListSopRecommendationsPaginator returns a new ListSopRecommendationsPaginator
func (*ListSopRecommendationsPaginator) HasMorePages ¶
func (p *ListSopRecommendationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSopRecommendationsPaginator) NextPage ¶
func (p *ListSopRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSopRecommendationsOutput, error)
NextPage retrieves the next ListSopRecommendations page.
type ListSopRecommendationsPaginatorOptions ¶
type ListSopRecommendationsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListSopRecommendationsPaginatorOptions is the paginator options for ListSopRecommendations
type ListSuggestedResiliencyPoliciesAPIClient ¶
type ListSuggestedResiliencyPoliciesAPIClient interface {
ListSuggestedResiliencyPolicies(context.Context, *ListSuggestedResiliencyPoliciesInput, ...func(*Options)) (*ListSuggestedResiliencyPoliciesOutput, error)
}
ListSuggestedResiliencyPoliciesAPIClient is a client that implements the ListSuggestedResiliencyPolicies operation.
type ListSuggestedResiliencyPoliciesInput ¶
type ListSuggestedResiliencyPoliciesInput struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListSuggestedResiliencyPoliciesOutput ¶
type ListSuggestedResiliencyPoliciesOutput struct { // The suggested resiliency policies for the Resilience Hub applications. // // This member is required. ResiliencyPolicies []types.ResiliencyPolicy // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSuggestedResiliencyPoliciesPaginator ¶
type ListSuggestedResiliencyPoliciesPaginator struct {
// contains filtered or unexported fields
}
ListSuggestedResiliencyPoliciesPaginator is a paginator for ListSuggestedResiliencyPolicies
func NewListSuggestedResiliencyPoliciesPaginator ¶
func NewListSuggestedResiliencyPoliciesPaginator(client ListSuggestedResiliencyPoliciesAPIClient, params *ListSuggestedResiliencyPoliciesInput, optFns ...func(*ListSuggestedResiliencyPoliciesPaginatorOptions)) *ListSuggestedResiliencyPoliciesPaginator
NewListSuggestedResiliencyPoliciesPaginator returns a new ListSuggestedResiliencyPoliciesPaginator
func (*ListSuggestedResiliencyPoliciesPaginator) HasMorePages ¶
func (p *ListSuggestedResiliencyPoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSuggestedResiliencyPoliciesPaginator) NextPage ¶
func (p *ListSuggestedResiliencyPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSuggestedResiliencyPoliciesOutput, error)
NextPage retrieves the next ListSuggestedResiliencyPolicies page.
type ListSuggestedResiliencyPoliciesPaginatorOptions ¶
type ListSuggestedResiliencyPoliciesPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListSuggestedResiliencyPoliciesPaginatorOptions is the paginator options for ListSuggestedResiliencyPolicies
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) for a specific resource in your Resilience Hub // application. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Tags assigned to the resource. A tag is a label that you assign to an Amazon // Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTestRecommendationsAPIClient ¶
type ListTestRecommendationsAPIClient interface {
ListTestRecommendations(context.Context, *ListTestRecommendationsInput, ...func(*Options)) (*ListTestRecommendationsOutput, error)
}
ListTestRecommendationsAPIClient is a client that implements the ListTestRecommendations operation.
type ListTestRecommendationsInput ¶
type ListTestRecommendationsInput struct { // Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: // partition :resiliencehub: region : account :app-assessment/ app-id . For more // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListTestRecommendationsOutput ¶
type ListTestRecommendationsOutput struct { // The test recommendations for the Resilience Hub application. // // This member is required. TestRecommendations []types.TestRecommendation // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTestRecommendationsPaginator ¶
type ListTestRecommendationsPaginator struct {
// contains filtered or unexported fields
}
ListTestRecommendationsPaginator is a paginator for ListTestRecommendations
func NewListTestRecommendationsPaginator ¶
func NewListTestRecommendationsPaginator(client ListTestRecommendationsAPIClient, params *ListTestRecommendationsInput, optFns ...func(*ListTestRecommendationsPaginatorOptions)) *ListTestRecommendationsPaginator
NewListTestRecommendationsPaginator returns a new ListTestRecommendationsPaginator
func (*ListTestRecommendationsPaginator) HasMorePages ¶
func (p *ListTestRecommendationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTestRecommendationsPaginator) NextPage ¶
func (p *ListTestRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTestRecommendationsOutput, error)
NextPage retrieves the next ListTestRecommendations page.
type ListTestRecommendationsPaginatorOptions ¶
type ListTestRecommendationsPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTestRecommendationsPaginatorOptions is the paginator options for ListTestRecommendations
type ListUnsupportedAppVersionResourcesAPIClient ¶
type ListUnsupportedAppVersionResourcesAPIClient interface {
ListUnsupportedAppVersionResources(context.Context, *ListUnsupportedAppVersionResourcesInput, ...func(*Options)) (*ListUnsupportedAppVersionResourcesOutput, error)
}
ListUnsupportedAppVersionResourcesAPIClient is a client that implements the ListUnsupportedAppVersionResources operation.
type ListUnsupportedAppVersionResourcesInput ¶
type ListUnsupportedAppVersionResourcesInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. MaxResults *int32 // Null, or the token from a previous call to get the next set of results. NextToken *string // The identifier for a specific resolution. ResolutionId *string // contains filtered or unexported fields }
type ListUnsupportedAppVersionResourcesOutput ¶
type ListUnsupportedAppVersionResourcesOutput struct { // The identifier for a specific resolution. // // This member is required. ResolutionId *string // The unsupported resources for the application. // // This member is required. UnsupportedResources []types.UnsupportedResource // Token for the next set of results, or null if there are no more results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListUnsupportedAppVersionResourcesPaginator ¶
type ListUnsupportedAppVersionResourcesPaginator struct {
// contains filtered or unexported fields
}
ListUnsupportedAppVersionResourcesPaginator is a paginator for ListUnsupportedAppVersionResources
func NewListUnsupportedAppVersionResourcesPaginator ¶
func NewListUnsupportedAppVersionResourcesPaginator(client ListUnsupportedAppVersionResourcesAPIClient, params *ListUnsupportedAppVersionResourcesInput, optFns ...func(*ListUnsupportedAppVersionResourcesPaginatorOptions)) *ListUnsupportedAppVersionResourcesPaginator
NewListUnsupportedAppVersionResourcesPaginator returns a new ListUnsupportedAppVersionResourcesPaginator
func (*ListUnsupportedAppVersionResourcesPaginator) HasMorePages ¶
func (p *ListUnsupportedAppVersionResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListUnsupportedAppVersionResourcesPaginator) NextPage ¶
func (p *ListUnsupportedAppVersionResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUnsupportedAppVersionResourcesOutput, error)
NextPage retrieves the next ListUnsupportedAppVersionResources page.
type ListUnsupportedAppVersionResourcesPaginatorOptions ¶
type ListUnsupportedAppVersionResourcesPaginatorOptions struct { // Maximum number of results to include in the response. If more results exist // than the specified MaxResults value, a token is included in the response so // that the remaining results can be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListUnsupportedAppVersionResourcesPaginatorOptions is the paginator options for ListUnsupportedAppVersionResources
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PublishAppVersionInput ¶
type PublishAppVersionInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Name of the application version. VersionName *string // contains filtered or unexported fields }
type PublishAppVersionOutput ¶
type PublishAppVersionOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. AppVersion *string // Identifier of the application version. Identifier *int64 // Name of the application version. VersionName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutDraftAppVersionTemplateInput ¶
type PutDraftAppVersionTemplateInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // A JSON string that provides information about your application structure. To // learn more about the appTemplateBody template, see the sample template provided // in the Examples section. // // The appTemplateBody JSON string has the following structure: // // - resources // // The list of logical resources that must be included in the Resilience Hub // application. // // Type: Array // // Don't add the resources that you want to exclude. // // Each resources array item includes the following fields: // // - logicalResourceId // // Logical identifier of the resource. // // Type: Object // // Each logicalResourceId object includes the following fields: // // - identifier // // Identifier of the resource. // // Type: String // // - logicalStackName // // The name of the CloudFormation stack this resource belongs to. // // Type: String // // - resourceGroupName // // The name of the resource group this resource belongs to. // // Type: String // // - terraformSourceName // // The name of the Terraform S3 state file this resource belongs to. // // Type: String // // - eksSourceName // // Name of the Amazon Elastic Kubernetes Service cluster and namespace this // resource belongs to. // // This parameter accepts values in "eks-cluster/namespace" format. // // Type: String // // - type // // The type of resource. // // Type: string // // - name // // The name of the resource. // // Type: String // // - additionalInfo // // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather // than using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // - appComponents // // List of Application Components that this resource belongs to. If an Application // Component is not part of the Resilience Hub application, it will be added. // // Type: Array // // Each appComponents array item includes the following fields: // // - name // // Name of the Application Component. // // Type: String // // - type // // Type of Application Component. For more information about the types of // Application Component, see [Grouping resources in an AppComponent]. // // Type: String // // - resourceNames // // The list of included resources that are assigned to the Application Component. // // Type: Array of strings // // - additionalInfo // // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather // than using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // - excludedResources // // The list of logical resource identifiers to be excluded from the application. // // Type: Array // // Don't add the resources that you want to include. // // Each excludedResources array item includes the following fields: // // - logicalResourceIds // // Logical identifier of the resource. // // Type: Object // // You can configure only one of the following fields: // // - logicalStackName // // - resourceGroupName // // - terraformSourceName // // - eksSourceName // // Each logicalResourceIds object includes the following fields: // // - identifier // // Identifier of the resource. // // Type: String // // - logicalStackName // // The name of the CloudFormation stack this resource belongs to. // // Type: String // // - resourceGroupName // // The name of the resource group this resource belongs to. // // Type: String // // - terraformSourceName // // The name of the Terraform S3 state file this resource belongs to. // // Type: String // // - eksSourceName // // Name of the Amazon Elastic Kubernetes Service cluster and namespace this // resource belongs to. // // This parameter accepts values in "eks-cluster/namespace" format. // // Type: String // // - version // // Resilience Hub application version. // // - additionalInfo // // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather // than using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html // // This member is required. AppTemplateBody *string // contains filtered or unexported fields }
type PutDraftAppVersionTemplateOutput ¶
type PutDraftAppVersionTemplateOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The version of the application. AppVersion *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RemoveDraftAppVersionResourceMappingsInput ¶
type RemoveDraftAppVersionResourceMappingsInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The names of the registered applications you want to remove from the resource // mappings. AppRegistryAppNames []string // The names of the Amazon Elastic Kubernetes Service clusters and namespaces you // want to remove from the resource mappings. // // This parameter accepts values in "eks-cluster/namespace" format. EksSourceNames []string // The names of the CloudFormation stacks you want to remove from the resource // mappings. LogicalStackNames []string // The names of the resource groups you want to remove from the resource mappings. ResourceGroupNames []string // The names of the resources you want to remove from the resource mappings. ResourceNames []string // The names of the Terraform sources you want to remove from the resource // mappings. TerraformSourceNames []string // contains filtered or unexported fields }
type RemoveDraftAppVersionResourceMappingsOutput ¶
type RemoveDraftAppVersionResourceMappingsOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The version of the application. AppVersion *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveAppVersionResourcesInput ¶
type ResolveAppVersionResourcesInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // contains filtered or unexported fields }
type ResolveAppVersionResourcesOutput ¶
type ResolveAppVersionResourcesOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // The identifier for a specific resolution. // // This member is required. ResolutionId *string // Status of the action. // // This member is required. Status types.ResourceResolutionStatusType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartAppAssessmentInput ¶
type StartAppAssessmentInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // The version of the application. // // This member is required. AppVersion *string // The name for the assessment. // // This member is required. AssessmentName *string // Used for an idempotency token. A client token is a unique, case-sensitive // string of up to 64 ASCII characters. You should not reuse the same client token // for other API requests. ClientToken *string // Tags assigned to the resource. A tag is a label that you assign to an Amazon // Web Services resource. Each tag consists of a key/value pair. Tags map[string]string // contains filtered or unexported fields }
type StartAppAssessmentOutput ¶
type StartAppAssessmentOutput struct { // The assessment created. // // This member is required. Assessment *types.AppAssessment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tags to assign to the resource. Each tag consists of a key/value pair. // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAppInput ¶
type UpdateAppInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Assessment execution schedule with 'Daily' or 'Disabled' values. AssessmentSchedule types.AppAssessmentScheduleType // Specifies if the resiliency policy ARN should be cleared. ClearResiliencyPolicyArn *bool // The optional description for an app. Description *string // The list of events you would like to subscribe and get notification for. // Currently, Resilience Hub supports notifications only for Drift detected and // Scheduled assessment failure events. EventSubscriptions []types.EventSubscription // Defines the roles and credentials that Resilience Hub would use while creating // an application, importing its resources, and running an assessment. PermissionModel *types.PermissionModel // Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN // is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General // Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string // contains filtered or unexported fields }
type UpdateAppOutput ¶
type UpdateAppOutput struct { // The specified application, returned as an object with details including // compliance status, creation time, description, resiliency score, and more. // // This member is required. App *types.App // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAppVersionAppComponentInput ¶
type UpdateAppVersionAppComponentInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Identifier of the Application Component. // // This member is required. Id *string // Currently, there is no supported additional information for Application // Components. AdditionalInfo map[string][]string // Name of the Application Component. Name *string // Type of Application Component. For more information about the types of // Application Component, see [Grouping resources in an AppComponent]. // // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html Type *string // contains filtered or unexported fields }
type UpdateAppVersionAppComponentOutput ¶
type UpdateAppVersionAppComponentOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // List of Application Components that belong to this resource. AppComponent *types.AppComponent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAppVersionInput ¶
type UpdateAppVersionInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than // using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter accepts a key-value mapping (in a string format) of // only one failover region and one associated account. // // Key: "failover-regions" // // Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]" // // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html AdditionalInfo map[string][]string // contains filtered or unexported fields }
type UpdateAppVersionOutput ¶
type UpdateAppVersionOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Additional configuration parameters for an Resilience Hub application. If you // want to implement additionalInfo through the Resilience Hub console rather than // using an API call, see [Configure the application configuration parameters]. // // Currently, this parameter supports only failover region and account. // // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html AdditionalInfo map[string][]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAppVersionResourceInput ¶
type UpdateAppVersionResourceInput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Currently, there is no supported additional information for resources. AdditionalInfo map[string][]string // List of Application Components that this resource belongs to. If an Application // Component is not part of the Resilience Hub application, it will be added. AppComponents []string // Amazon Web Services account that owns the physical resource. AwsAccountId *string // Amazon Web Services region that owns the physical resource. AwsRegion *string // Indicates if a resource is excluded from an Resilience Hub application. // // You can exclude only imported resources from an Resilience Hub application. Excluded *bool // Logical identifier of the resource. LogicalResourceId *types.LogicalResourceId // Physical identifier of the resource. PhysicalResourceId *string // Name of the resource. ResourceName *string // Type of resource. ResourceType *string // contains filtered or unexported fields }
type UpdateAppVersionResourceOutput ¶
type UpdateAppVersionResourceOutput struct { // Amazon Resource Name (ARN) of the Resilience Hub application. The format for // this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference // guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // Resilience Hub application version. // // This member is required. AppVersion *string // Defines a physical resource. A physical resource is a resource that exists in // your account. It can be identified using an Amazon Resource Name (ARN) or a // Resilience Hub-native identifier. PhysicalResource *types.PhysicalResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateResiliencyPolicyInput ¶
type UpdateResiliencyPolicyInput struct { // Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN // is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General // Reference guide. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // Specifies a high-level geographical location constraint for where your // resilience policy data can be stored. DataLocationConstraint types.DataLocationConstraint // The type of resiliency policy to be created, including the recovery time // objective (RTO) and recovery point objective (RPO) in seconds. Policy map[string]types.FailurePolicy // The description for the policy. PolicyDescription *string // The name of the policy PolicyName *string // The tier for this resiliency policy, ranging from the highest severity ( // MissionCritical ) to lowest ( NonCritical ). Tier types.ResiliencyPolicyTier // contains filtered or unexported fields }
type UpdateResiliencyPolicyOutput ¶
type UpdateResiliencyPolicyOutput struct { // The type of resiliency policy that was updated, including the recovery time // objective (RTO) and recovery point objective (RPO) in seconds. // // This member is required. Policy *types.ResiliencyPolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_AddDraftAppVersionResourceMappings.go
- api_op_BatchUpdateRecommendationStatus.go
- api_op_CreateApp.go
- api_op_CreateAppVersionAppComponent.go
- api_op_CreateAppVersionResource.go
- api_op_CreateRecommendationTemplate.go
- api_op_CreateResiliencyPolicy.go
- api_op_DeleteApp.go
- api_op_DeleteAppAssessment.go
- api_op_DeleteAppInputSource.go
- api_op_DeleteAppVersionAppComponent.go
- api_op_DeleteAppVersionResource.go
- api_op_DeleteRecommendationTemplate.go
- api_op_DeleteResiliencyPolicy.go
- api_op_DescribeApp.go
- api_op_DescribeAppAssessment.go
- api_op_DescribeAppVersion.go
- api_op_DescribeAppVersionAppComponent.go
- api_op_DescribeAppVersionResource.go
- api_op_DescribeAppVersionResourcesResolutionStatus.go
- api_op_DescribeAppVersionTemplate.go
- api_op_DescribeDraftAppVersionResourcesImportStatus.go
- api_op_DescribeResiliencyPolicy.go
- api_op_ImportResourcesToDraftAppVersion.go
- api_op_ListAlarmRecommendations.go
- api_op_ListAppAssessmentComplianceDrifts.go
- api_op_ListAppAssessmentResourceDrifts.go
- api_op_ListAppAssessments.go
- api_op_ListAppComponentCompliances.go
- api_op_ListAppComponentRecommendations.go
- api_op_ListAppInputSources.go
- api_op_ListAppVersionAppComponents.go
- api_op_ListAppVersionResourceMappings.go
- api_op_ListAppVersionResources.go
- api_op_ListAppVersions.go
- api_op_ListApps.go
- api_op_ListRecommendationTemplates.go
- api_op_ListResiliencyPolicies.go
- api_op_ListSopRecommendations.go
- api_op_ListSuggestedResiliencyPolicies.go
- api_op_ListTagsForResource.go
- api_op_ListTestRecommendations.go
- api_op_ListUnsupportedAppVersionResources.go
- api_op_PublishAppVersion.go
- api_op_PutDraftAppVersionTemplate.go
- api_op_RemoveDraftAppVersionResourceMappings.go
- api_op_ResolveAppVersionResources.go
- api_op_StartAppAssessment.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateApp.go
- api_op_UpdateAppVersion.go
- api_op_UpdateAppVersionAppComponent.go
- api_op_UpdateAppVersionResource.go
- api_op_UpdateResiliencyPolicy.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go