AWS::DataZone::EnvironmentActions
The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::DataZone::EnvironmentActions", "Properties" : { "Description" :
String
, "DomainIdentifier" :String
, "EnvironmentIdentifier" :String
, "Identifier" :String
, "Name" :String
, "Parameters" :AwsConsoleLinkParameters
} }
YAML
Type: AWS::DataZone::EnvironmentActions Properties: Description:
String
DomainIdentifier:String
EnvironmentIdentifier:String
Identifier:String
Name:String
Parameters:AwsConsoleLinkParameters
Properties
Description
Property description not available.
Required: No
Type: String
Maximum:
2048
Update requires: No interruption
DomainIdentifier
-
The Amazon DataZone domain ID of the environment action.
Required: No
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$
Update requires: Replacement
EnvironmentIdentifier
-
The environment ID of the environment action.
Required: No
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36}$
Minimum:
1
Maximum:
36
Update requires: Replacement
Identifier
-
The ID of the environment action.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$
Minimum:
1
Maximum:
36
Update requires: No interruption
Name
-
The name of the environment action.
Required: Yes
Type: String
Pattern:
^[\w -]+$
Minimum:
1
Maximum:
64
Update requires: No interruption
Parameters
Property description not available.
Required: No
Type: AwsConsoleLinkParameters
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns a string containing pipe-separated DomainId
and
EnvironmentActionId
, which uniquely identifies the environment action. For example:
{ "Ref": "MyEnvironmentAction" }
for the resource with the logical ID
MyEnvironmentAction
, Ref
returns
DomainId|EnvironmentActionId
.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
DomainId
-
The Amazon DataZone domain ID of the environment action.
EnvironmentId
-
The environment ID of the environment action.
Id
-
The ID of the environment action.