1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. fis
  5. getExperimentTemplate

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.fis.getExperimentTemplate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Resource schema for AWS::FIS::ExperimentTemplate

    Using getExperimentTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getExperimentTemplate(args: GetExperimentTemplateArgs, opts?: InvokeOptions): Promise<GetExperimentTemplateResult>
    function getExperimentTemplateOutput(args: GetExperimentTemplateOutputArgs, opts?: InvokeOptions): Output<GetExperimentTemplateResult>
    def get_experiment_template(id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetExperimentTemplateResult
    def get_experiment_template_output(id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetExperimentTemplateResult]
    func LookupExperimentTemplate(ctx *Context, args *LookupExperimentTemplateArgs, opts ...InvokeOption) (*LookupExperimentTemplateResult, error)
    func LookupExperimentTemplateOutput(ctx *Context, args *LookupExperimentTemplateOutputArgs, opts ...InvokeOption) LookupExperimentTemplateResultOutput

    > Note: This function is named LookupExperimentTemplate in the Go SDK.

    public static class GetExperimentTemplate 
    {
        public static Task<GetExperimentTemplateResult> InvokeAsync(GetExperimentTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetExperimentTemplateResult> Invoke(GetExperimentTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExperimentTemplateResult> getExperimentTemplate(GetExperimentTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:fis:getExperimentTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the experiment template.
    Id string
    The ID of the experiment template.
    id String
    The ID of the experiment template.
    id string
    The ID of the experiment template.
    id str
    The ID of the experiment template.
    id String
    The ID of the experiment template.

    getExperimentTemplate Result

    The following output properties are available:

    Actions Dictionary<string, Pulumi.AwsNative.Fis.Outputs.ExperimentTemplateAction>
    The actions for the experiment.
    Description string
    The description for the experiment template.
    ExperimentOptions Pulumi.AwsNative.Fis.Outputs.ExperimentTemplateExperimentOptions
    The experiment options for an experiment template.
    ExperimentReportConfiguration Pulumi.AwsNative.Fis.Outputs.ExperimentTemplateExperimentReportConfiguration
    Describes the report configuration for the experiment template.
    Id string
    The ID of the experiment template.
    LogConfiguration Pulumi.AwsNative.Fis.Outputs.ExperimentTemplateLogConfiguration
    The configuration for experiment logging.
    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role.
    StopConditions List<Pulumi.AwsNative.Fis.Outputs.ExperimentTemplateStopCondition>
    The stop conditions for the experiment.
    Targets Dictionary<string, Pulumi.AwsNative.Fis.Outputs.ExperimentTemplateTarget>
    The targets for the experiment.
    Actions map[string]ExperimentTemplateAction
    The actions for the experiment.
    Description string
    The description for the experiment template.
    ExperimentOptions ExperimentTemplateExperimentOptions
    The experiment options for an experiment template.
    ExperimentReportConfiguration ExperimentTemplateExperimentReportConfiguration
    Describes the report configuration for the experiment template.
    Id string
    The ID of the experiment template.
    LogConfiguration ExperimentTemplateLogConfiguration
    The configuration for experiment logging.
    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role.
    StopConditions []ExperimentTemplateStopCondition
    The stop conditions for the experiment.
    Targets map[string]ExperimentTemplateTarget
    The targets for the experiment.
    actions Map<String,ExperimentTemplateAction>
    The actions for the experiment.
    description String
    The description for the experiment template.
    experimentOptions ExperimentTemplateExperimentOptions
    The experiment options for an experiment template.
    experimentReportConfiguration ExperimentTemplateExperimentReportConfiguration
    Describes the report configuration for the experiment template.
    id String
    The ID of the experiment template.
    logConfiguration ExperimentTemplateLogConfiguration
    The configuration for experiment logging.
    roleArn String
    The Amazon Resource Name (ARN) of an IAM role.
    stopConditions List<ExperimentTemplateStopCondition>
    The stop conditions for the experiment.
    targets Map<String,ExperimentTemplateTarget>
    The targets for the experiment.
    actions {[key: string]: ExperimentTemplateAction}
    The actions for the experiment.
    description string
    The description for the experiment template.
    experimentOptions ExperimentTemplateExperimentOptions
    The experiment options for an experiment template.
    experimentReportConfiguration ExperimentTemplateExperimentReportConfiguration
    Describes the report configuration for the experiment template.
    id string
    The ID of the experiment template.
    logConfiguration ExperimentTemplateLogConfiguration
    The configuration for experiment logging.
    roleArn string
    The Amazon Resource Name (ARN) of an IAM role.
    stopConditions ExperimentTemplateStopCondition[]
    The stop conditions for the experiment.
    targets {[key: string]: ExperimentTemplateTarget}
    The targets for the experiment.
    actions Mapping[str, ExperimentTemplateAction]
    The actions for the experiment.
    description str
    The description for the experiment template.
    experiment_options ExperimentTemplateExperimentOptions
    The experiment options for an experiment template.
    experiment_report_configuration ExperimentTemplateExperimentReportConfiguration
    Describes the report configuration for the experiment template.
    id str
    The ID of the experiment template.
    log_configuration ExperimentTemplateLogConfiguration
    The configuration for experiment logging.
    role_arn str
    The Amazon Resource Name (ARN) of an IAM role.
    stop_conditions Sequence[ExperimentTemplateStopCondition]
    The stop conditions for the experiment.
    targets Mapping[str, ExperimentTemplateTarget]
    The targets for the experiment.
    actions Map<Property Map>
    The actions for the experiment.
    description String
    The description for the experiment template.
    experimentOptions Property Map
    The experiment options for an experiment template.
    experimentReportConfiguration Property Map
    Describes the report configuration for the experiment template.
    id String
    The ID of the experiment template.
    logConfiguration Property Map
    The configuration for experiment logging.
    roleArn String
    The Amazon Resource Name (ARN) of an IAM role.
    stopConditions List<Property Map>
    The stop conditions for the experiment.
    targets Map<Property Map>
    The targets for the experiment.

    Supporting Types

    ExperimentTemplateAction

    ActionId string
    The ID of the action.
    Description string
    A description for the action.
    Parameters Dictionary<string, string>
    The parameters for the action, if applicable.
    StartAfter List<string>
    The name of the action that must be completed before the current action starts.
    Targets Dictionary<string, string>
    One or more targets for the action.
    ActionId string
    The ID of the action.
    Description string
    A description for the action.
    Parameters map[string]string
    The parameters for the action, if applicable.
    StartAfter []string
    The name of the action that must be completed before the current action starts.
    Targets map[string]string
    One or more targets for the action.
    actionId String
    The ID of the action.
    description String
    A description for the action.
    parameters Map<String,String>
    The parameters for the action, if applicable.
    startAfter List<String>
    The name of the action that must be completed before the current action starts.
    targets Map<String,String>
    One or more targets for the action.
    actionId string
    The ID of the action.
    description string
    A description for the action.
    parameters {[key: string]: string}
    The parameters for the action, if applicable.
    startAfter string[]
    The name of the action that must be completed before the current action starts.
    targets {[key: string]: string}
    One or more targets for the action.
    action_id str
    The ID of the action.
    description str
    A description for the action.
    parameters Mapping[str, str]
    The parameters for the action, if applicable.
    start_after Sequence[str]
    The name of the action that must be completed before the current action starts.
    targets Mapping[str, str]
    One or more targets for the action.
    actionId String
    The ID of the action.
    description String
    A description for the action.
    parameters Map<String>
    The parameters for the action, if applicable.
    startAfter List<String>
    The name of the action that must be completed before the current action starts.
    targets Map<String>
    One or more targets for the action.

    ExperimentTemplateCloudWatchDashboard

    DashboardIdentifier string
    The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
    DashboardIdentifier string
    The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
    dashboardIdentifier String
    The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
    dashboardIdentifier string
    The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
    dashboard_identifier str
    The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.
    dashboardIdentifier String
    The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report.

    ExperimentTemplateExperimentOptions

    AccountTargeting ExperimentTemplateExperimentOptionsAccountTargeting
    The account targeting setting for the experiment template.
    EmptyTargetResolutionMode ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode
    The target resolution failure mode for the experiment template.
    accountTargeting ExperimentTemplateExperimentOptionsAccountTargeting
    The account targeting setting for the experiment template.
    emptyTargetResolutionMode ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode
    The target resolution failure mode for the experiment template.
    accountTargeting ExperimentTemplateExperimentOptionsAccountTargeting
    The account targeting setting for the experiment template.
    emptyTargetResolutionMode ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode
    The target resolution failure mode for the experiment template.
    account_targeting ExperimentTemplateExperimentOptionsAccountTargeting
    The account targeting setting for the experiment template.
    empty_target_resolution_mode ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode
    The target resolution failure mode for the experiment template.
    accountTargeting "multi-account" | "single-account"
    The account targeting setting for the experiment template.
    emptyTargetResolutionMode "fail" | "skip"
    The target resolution failure mode for the experiment template.

    ExperimentTemplateExperimentOptionsAccountTargeting

    ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode

    ExperimentTemplateExperimentReportConfiguration

    DataSources Pulumi.AwsNative.Fis.Inputs.ExperimentTemplateExperimentReportConfigurationDataSourcesProperties
    The data sources for the experiment report.
    Outputs Pulumi.AwsNative.Fis.Inputs.ExperimentTemplateExperimentReportConfigurationOutputsProperties
    The output destinations of the experiment report.
    PostExperimentDuration string
    The duration after the experiment end time for the data sources to include in the report.
    PreExperimentDuration string
    The duration before the experiment start time for the data sources to include in the report.
    DataSources ExperimentTemplateExperimentReportConfigurationDataSourcesProperties
    The data sources for the experiment report.
    Outputs ExperimentTemplateExperimentReportConfigurationOutputsProperties
    The output destinations of the experiment report.
    PostExperimentDuration string
    The duration after the experiment end time for the data sources to include in the report.
    PreExperimentDuration string
    The duration before the experiment start time for the data sources to include in the report.
    dataSources ExperimentTemplateExperimentReportConfigurationDataSourcesProperties
    The data sources for the experiment report.
    outputs ExperimentTemplateExperimentReportConfigurationOutputsProperties
    The output destinations of the experiment report.
    postExperimentDuration String
    The duration after the experiment end time for the data sources to include in the report.
    preExperimentDuration String
    The duration before the experiment start time for the data sources to include in the report.
    dataSources ExperimentTemplateExperimentReportConfigurationDataSourcesProperties
    The data sources for the experiment report.
    outputs ExperimentTemplateExperimentReportConfigurationOutputsProperties
    The output destinations of the experiment report.
    postExperimentDuration string
    The duration after the experiment end time for the data sources to include in the report.
    preExperimentDuration string
    The duration before the experiment start time for the data sources to include in the report.
    data_sources ExperimentTemplateExperimentReportConfigurationDataSourcesProperties
    The data sources for the experiment report.
    outputs ExperimentTemplateExperimentReportConfigurationOutputsProperties
    The output destinations of the experiment report.
    post_experiment_duration str
    The duration after the experiment end time for the data sources to include in the report.
    pre_experiment_duration str
    The duration before the experiment start time for the data sources to include in the report.
    dataSources Property Map
    The data sources for the experiment report.
    outputs Property Map
    The output destinations of the experiment report.
    postExperimentDuration String
    The duration after the experiment end time for the data sources to include in the report.
    preExperimentDuration String
    The duration before the experiment start time for the data sources to include in the report.

    ExperimentTemplateExperimentReportConfigurationDataSourcesProperties

    ExperimentTemplateExperimentReportConfigurationOutputsProperties

    ExperimentTemplateExperimentReportConfigurationOutputsPropertiesExperimentReportS3ConfigurationProperties

    BucketName string
    Prefix string
    BucketName string
    Prefix string
    bucketName String
    prefix String
    bucketName string
    prefix string
    bucketName String
    prefix String

    ExperimentTemplateLogConfiguration

    LogSchemaVersion int
    The schema version.
    CloudWatchLogsConfiguration ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties
    The configuration for experiment logging to CloudWatch Logs .
    S3Configuration ExperimentTemplateLogConfigurationS3ConfigurationProperties
    The configuration for experiment logging to Amazon S3 .
    logSchemaVersion Integer
    The schema version.
    cloudWatchLogsConfiguration ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties
    The configuration for experiment logging to CloudWatch Logs .
    s3Configuration ExperimentTemplateLogConfigurationS3ConfigurationProperties
    The configuration for experiment logging to Amazon S3 .
    logSchemaVersion number
    The schema version.
    cloudWatchLogsConfiguration ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties
    The configuration for experiment logging to CloudWatch Logs .
    s3Configuration ExperimentTemplateLogConfigurationS3ConfigurationProperties
    The configuration for experiment logging to Amazon S3 .
    log_schema_version int
    The schema version.
    cloud_watch_logs_configuration ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties
    The configuration for experiment logging to CloudWatch Logs .
    s3_configuration ExperimentTemplateLogConfigurationS3ConfigurationProperties
    The configuration for experiment logging to Amazon S3 .
    logSchemaVersion Number
    The schema version.
    cloudWatchLogsConfiguration Property Map
    The configuration for experiment logging to CloudWatch Logs .
    s3Configuration Property Map
    The configuration for experiment logging to Amazon S3 .

    ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties

    ExperimentTemplateLogConfigurationS3ConfigurationProperties

    BucketName string
    Prefix string
    BucketName string
    Prefix string
    bucketName String
    prefix String
    bucketName string
    prefix string
    bucketName String
    prefix String

    ExperimentTemplateStopCondition

    Source string
    Value string
    Source string
    Value string
    source String
    value String
    source string
    value string
    source str
    value str
    source String
    value String

    ExperimentTemplateTarget

    ResourceType string
    The resource type.
    SelectionMode string
    Scopes the identified resources to a specific count or percentage.
    Filters List<Pulumi.AwsNative.Fis.Inputs.ExperimentTemplateTargetFilter>
    The filters to apply to identify target resources using specific attributes.
    Parameters Dictionary<string, string>
    The parameters for the resource type.
    ResourceArns List<string>
    The Amazon Resource Names (ARNs) of the targets.
    ResourceTags Dictionary<string, string>
    The tags for the target resources.
    ResourceType string
    The resource type.
    SelectionMode string
    Scopes the identified resources to a specific count or percentage.
    Filters []ExperimentTemplateTargetFilter
    The filters to apply to identify target resources using specific attributes.
    Parameters map[string]string
    The parameters for the resource type.
    ResourceArns []string
    The Amazon Resource Names (ARNs) of the targets.
    ResourceTags map[string]string
    The tags for the target resources.
    resourceType String
    The resource type.
    selectionMode String
    Scopes the identified resources to a specific count or percentage.
    filters List<ExperimentTemplateTargetFilter>
    The filters to apply to identify target resources using specific attributes.
    parameters Map<String,String>
    The parameters for the resource type.
    resourceArns List<String>
    The Amazon Resource Names (ARNs) of the targets.
    resourceTags Map<String,String>
    The tags for the target resources.
    resourceType string
    The resource type.
    selectionMode string
    Scopes the identified resources to a specific count or percentage.
    filters ExperimentTemplateTargetFilter[]
    The filters to apply to identify target resources using specific attributes.
    parameters {[key: string]: string}
    The parameters for the resource type.
    resourceArns string[]
    The Amazon Resource Names (ARNs) of the targets.
    resourceTags {[key: string]: string}
    The tags for the target resources.
    resource_type str
    The resource type.
    selection_mode str
    Scopes the identified resources to a specific count or percentage.
    filters Sequence[ExperimentTemplateTargetFilter]
    The filters to apply to identify target resources using specific attributes.
    parameters Mapping[str, str]
    The parameters for the resource type.
    resource_arns Sequence[str]
    The Amazon Resource Names (ARNs) of the targets.
    resource_tags Mapping[str, str]
    The tags for the target resources.
    resourceType String
    The resource type.
    selectionMode String
    Scopes the identified resources to a specific count or percentage.
    filters List<Property Map>
    The filters to apply to identify target resources using specific attributes.
    parameters Map<String>
    The parameters for the resource type.
    resourceArns List<String>
    The Amazon Resource Names (ARNs) of the targets.
    resourceTags Map<String>
    The tags for the target resources.

    ExperimentTemplateTargetFilter

    Path string
    Values List<string>
    Path string
    Values []string
    path String
    values List<String>
    path string
    values string[]
    path str
    values Sequence[str]
    path String
    values List<String>

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi