Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary

Description

Synopsis

data RouteSummary = RouteSummary' {
- applicationId :: Maybe Text
- arn :: Maybe Text
- createdByAccountId :: Maybe Text
- createdTime :: Maybe POSIX
- environmentId :: Maybe Text
- error :: Maybe ErrorResponse
- includeChildPaths :: Maybe Bool
- lastUpdatedTime :: Maybe POSIX
- methods :: Maybe [HttpMethod]
- ownerAccountId :: Maybe Text
- pathResourceToId :: Maybe (HashMap Text Text)
- routeId :: Maybe Text
- routeType :: Maybe RouteType
- serviceId :: Maybe Text
- sourcePath :: Maybe Text
- state :: Maybe RouteState
- tags :: Maybe (Sensitive (HashMap Text Text))
}
newRouteSummary :: RouteSummary
routeSummary_applicationId :: Lens' RouteSummary (Maybe Text)
routeSummary_arn :: Lens' RouteSummary (Maybe Text)
routeSummary_createdByAccountId :: Lens' RouteSummary (Maybe Text)
routeSummary_createdTime :: Lens' RouteSummary (Maybe UTCTime)
routeSummary_environmentId :: Lens' RouteSummary (Maybe Text)
routeSummary_error :: Lens' RouteSummary (Maybe ErrorResponse)
routeSummary_includeChildPaths :: Lens' RouteSummary (Maybe Bool)
routeSummary_lastUpdatedTime :: Lens' RouteSummary (Maybe UTCTime)
routeSummary_methods :: Lens' RouteSummary (Maybe [HttpMethod])
routeSummary_ownerAccountId :: Lens' RouteSummary (Maybe Text)
routeSummary_pathResourceToId :: Lens' RouteSummary (Maybe (HashMap Text Text))
routeSummary_routeId :: Lens' RouteSummary (Maybe Text)
routeSummary_routeType :: Lens' RouteSummary (Maybe RouteType)
routeSummary_serviceId :: Lens' RouteSummary (Maybe Text)
routeSummary_sourcePath :: Lens' RouteSummary (Maybe Text)
routeSummary_state :: Lens' RouteSummary (Maybe RouteState)
routeSummary_tags :: Lens' RouteSummary (Maybe (HashMap Text Text))

Documentation

data RouteSummary Source #

The summary information for the routes as a response to ListRoutes.

See: newRouteSummary smart constructor.

Constructors

RouteSummary'

Fields

applicationId :: Maybe Text
The unique identifier of the application.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the route.
createdByAccountId :: Maybe Text
The Amazon Web Services account ID of the route creator.
createdTime :: Maybe POSIX
A timestamp that indicates when the route is created.
environmentId :: Maybe Text
The unique identifier of the environment.
error :: Maybe ErrorResponse
Any error associated with the route resource.
includeChildPaths :: Maybe Bool
Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.
lastUpdatedTime :: Maybe POSIX
A timestamp that indicates when the route was last updated.
methods :: Maybe [HttpMethod]
A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
ownerAccountId :: Maybe Text
The Amazon Web Services account ID of the route owner.
pathResourceToId :: Maybe (HashMap Text Text)
A mapping of Amazon API Gateway path resources to resource IDs.
routeId :: Maybe Text
The unique identifier of the route.
routeType :: Maybe RouteType
The route type of the route.
serviceId :: Maybe Text
The unique identifier of the service.
sourcePath :: Maybe Text
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
state :: Maybe RouteState
The current state of the route.
tags :: Maybe (Sensitive (HashMap Text Text))
The tags assigned to the route.

Instances

Instances details

FromJSON RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary Methods parseJSON :: Value -> Parser RouteSummary # parseJSONList :: Value -> Parser [RouteSummary] #
Generic RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary Associated Types type Rep RouteSummary :: Type -> Type # Methods from :: RouteSummary -> Rep RouteSummary x # to :: Rep RouteSummary x -> RouteSummary #
Show RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary Methods showsPrec :: Int -> RouteSummary -> ShowS # show :: RouteSummary -> String # showList :: [RouteSummary] -> ShowS #
NFData RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary Methods rnf :: RouteSummary -> () #
Eq RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary Methods (==) :: RouteSummary -> RouteSummary -> Bool # (/=) :: RouteSummary -> RouteSummary -> Bool #
Hashable RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary Methods hashWithSalt :: Int -> RouteSummary -> Int # hash :: RouteSummary -> Int #
type Rep RouteSummary Source #
Instance details Defined in Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary type Rep RouteSummary = D1 ('MetaData "RouteSummary" "Amazonka.MigrationHubReFactorSpaces.Types.RouteSummary" "amazonka-migration-hub-refactor-spaces-2.0-IgAA0SWWxlS8R7imIzpgpS" 'False) (C1 ('MetaCons "RouteSummary'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdByAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorResponse))) :: (S1 ('MetaSel ('Just "includeChildPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: (((S1 ('MetaSel ('Just "methods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HttpMethod])) :: S1 ('MetaSel ('Just "ownerAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pathResourceToId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "routeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "routeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteType)) :: S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourcePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteState)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))))))))

newRouteSummary :: RouteSummary Source #

Create a value of RouteSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationId:RouteSummary', routeSummary_applicationId - The unique identifier of the application.

$sel:arn:RouteSummary', routeSummary_arn - The Amazon Resource Name (ARN) of the route.

$sel:createdByAccountId:RouteSummary', routeSummary_createdByAccountId - The Amazon Web Services account ID of the route creator.

$sel:createdTime:RouteSummary', routeSummary_createdTime - A timestamp that indicates when the route is created.

$sel:environmentId:RouteSummary', routeSummary_environmentId - The unique identifier of the environment.

$sel:error:RouteSummary', routeSummary_error - Any error associated with the route resource.

$sel:includeChildPaths:RouteSummary', routeSummary_includeChildPaths - Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

$sel:lastUpdatedTime:RouteSummary', routeSummary_lastUpdatedTime - A timestamp that indicates when the route was last updated.

$sel:methods:RouteSummary', routeSummary_methods - A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

$sel:ownerAccountId:RouteSummary', routeSummary_ownerAccountId - The Amazon Web Services account ID of the route owner.

$sel:pathResourceToId:RouteSummary', routeSummary_pathResourceToId - A mapping of Amazon API Gateway path resources to resource IDs.

$sel:routeId:RouteSummary', routeSummary_routeId - The unique identifier of the route.

$sel:routeType:RouteSummary', routeSummary_routeType - The route type of the route.

$sel:serviceId:RouteSummary', routeSummary_serviceId - The unique identifier of the service.

$sel:sourcePath:RouteSummary', routeSummary_sourcePath - The path to use to match traffic. Paths must start with / and are relative to the base of the application.

$sel:state:RouteSummary', routeSummary_state - The current state of the route.

$sel:tags:RouteSummary', routeSummary_tags - The tags assigned to the route.

routeSummary_applicationId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the application.

routeSummary_arn :: Lens' RouteSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the route.

routeSummary_createdByAccountId :: Lens' RouteSummary (Maybe Text) Source #

The Amazon Web Services account ID of the route creator.

routeSummary_createdTime :: Lens' RouteSummary (Maybe UTCTime) Source #

A timestamp that indicates when the route is created.

routeSummary_environmentId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the environment.

routeSummary_error :: Lens' RouteSummary (Maybe ErrorResponse) Source #

Any error associated with the route resource.

routeSummary_includeChildPaths :: Lens' RouteSummary (Maybe Bool) Source #

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

routeSummary_lastUpdatedTime :: Lens' RouteSummary (Maybe UTCTime) Source #

A timestamp that indicates when the route was last updated.

routeSummary_methods :: Lens' RouteSummary (Maybe [HttpMethod]) Source #

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

routeSummary_ownerAccountId :: Lens' RouteSummary (Maybe Text) Source #

The Amazon Web Services account ID of the route owner.

routeSummary_pathResourceToId :: Lens' RouteSummary (Maybe (HashMap Text Text)) Source #

A mapping of Amazon API Gateway path resources to resource IDs.

routeSummary_routeId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the route.

routeSummary_routeType :: Lens' RouteSummary (Maybe RouteType) Source #

The route type of the route.

routeSummary_serviceId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the service.

routeSummary_sourcePath :: Lens' RouteSummary (Maybe Text) Source #

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

routeSummary_state :: Lens' RouteSummary (Maybe RouteState) Source #

The current state of the route.

routeSummary_tags :: Lens' RouteSummary (Maybe (HashMap Text Text)) Source #

The tags assigned to the route.