awscc.finspace_environment¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - finspace:DeleteEnvironment, finspace:GetEnvironment
update¶
Parent base class for filters and actions.
definitions:
DataBundleArn:
pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d*:data-bundle/[0-9A-Za-z_-]{1,128}$
type: string
FederationParameters:
description: Additional parameters to identify Federation mode
properties:
ApplicationCallBackURL:
description: SAML metadata URL to link with the Environment
pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}
type: string
AttributeMap:
description: Attribute map for SAML configuration
type: object
FederationProviderName:
description: Federation provider name to link with the Environment
maxLength: 32
minLength: 1
pattern: '[^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+'
type: string
FederationURN:
description: SAML metadata URL to link with the Environment
pattern: ^[A-Za-z0-9._\-:\/#\+]+{1,255}$
type: string
SamlMetadataDocument:
description: SAML metadata document to link the federation provider to the
Environment
maxLength: 10000000
minLength: 1000
pattern: .*
type: string
SamlMetadataURL:
description: SAML metadata URL to link with the Environment
pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}
type: string
type: object
SuperuserParameters:
description: Parameters of the first Superuser for the FinSpace Environment
properties:
EmailAddress:
description: Email address
maxLength: 128
minLength: 1
pattern: '[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+'
type: string
FirstName:
description: First name
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z0-9]{1,50}$
type: string
LastName:
description: Last name
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z0-9]{1,50}$
type: string
type: object
properties:
Description:
description: Description of the Environment
pattern: ^[a-zA-Z0-9. ]{1,1000}$
type: string
FederationMode:
description: Federation mode used with the Environment
enum:
- LOCAL
- FEDERATED
type: string
FederationParameters:
description: Additional parameters to identify Federation mode
properties:
ApplicationCallBackURL:
description: SAML metadata URL to link with the Environment
pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}
type: string
AttributeMap:
description: Attribute map for SAML configuration
type: object
FederationProviderName:
description: Federation provider name to link with the Environment
maxLength: 32
minLength: 1
pattern: '[^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+'
type: string
FederationURN:
description: SAML metadata URL to link with the Environment
pattern: ^[A-Za-z0-9._\-:\/#\+]+{1,255}$
type: string
SamlMetadataDocument:
description: SAML metadata document to link the federation provider to the
Environment
maxLength: 10000000
minLength: 1000
pattern: .*
type: string
SamlMetadataURL:
description: SAML metadata URL to link with the Environment
pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]{1,1000}
type: string
type: object
Name:
description: Name of the Environment
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]{1,255}$
type: string
type:
enum:
- update
Permissions - finspace:UpdateEnvironment