/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the quicksight-2018-04-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.QuickSight.Model
{
///
/// Container for the parameters to the CreateTemplate operation.
/// Creates a template either from a TemplateDefinition
or from an existing
/// Amazon QuickSight analysis or template. You can use the resulting template to create
/// additional dashboards, templates, or analyses.
///
///
///
/// A template is an entity in Amazon QuickSight that encapsulates the metadata
/// required to create an analysis and that you can use to create s dashboard. A template
/// adds a layer of abstraction by using placeholders to replace the dataset associated
/// with the analysis. You can use templates to create dashboards by replacing dataset
/// placeholders with datasets that follow the same schema that was used to create the
/// source analysis and template.
///
///
public partial class CreateTemplateRequest : AmazonQuickSightRequest
{
private string _awsAccountId;
private TemplateVersionDefinition _definition;
private string _name;
private List _permissions = new List();
private TemplateSourceEntity _sourceEntity;
private List _tags = new List();
private string _templateId;
private string _versionDescription;
///
/// Gets and sets the property AwsAccountId.
///
/// The ID for the Amazon Web Services account that the group is in. You use the ID for
/// the Amazon Web Services account that contains your Amazon QuickSight account.
///
///
[AWSProperty(Required=true, Min=12, Max=12)]
public string AwsAccountId
{
get { return this._awsAccountId; }
set { this._awsAccountId = value; }
}
// Check to see if AwsAccountId property is set
internal bool IsSetAwsAccountId()
{
return this._awsAccountId != null;
}
///
/// Gets and sets the property Definition.
///
/// The definition of a template.
///
///
///
/// A definition is the data model of all features in a Dashboard, Template, or Analysis.
///
///
///
/// Either a SourceEntity
or a Definition
must be provided in
/// order for the request to be valid.
///
///
public TemplateVersionDefinition Definition
{
get { return this._definition; }
set { this._definition = value; }
}
// Check to see if Definition property is set
internal bool IsSetDefinition()
{
return this._definition != null;
}
///
/// Gets and sets the property Name.
///
/// A display name for the template.
///
///
[AWSProperty(Min=1, Max=2048)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property Permissions.
///
/// A list of resource permissions to be set on the template.
///
///
[AWSProperty(Min=1, Max=64)]
public List Permissions
{
get { return this._permissions; }
set { this._permissions = value; }
}
// Check to see if Permissions property is set
internal bool IsSetPermissions()
{
return this._permissions != null && this._permissions.Count > 0;
}
///
/// Gets and sets the property SourceEntity.
///
/// The entity that you are using as a source when you create the template. In SourceEntity
,
/// you specify the type of object you're using as source: SourceTemplate
/// for a template or SourceAnalysis
for an analysis. Both of these require
/// an Amazon Resource Name (ARN). For SourceTemplate
, specify the ARN of
/// the source template. For SourceAnalysis
, specify the ARN of the source
/// analysis. The SourceTemplate
ARN can contain any Amazon Web Services
/// account and any Amazon QuickSight-supported Amazon Web Services Region.
///
///
///
/// Use the DataSetReferences
entity within SourceTemplate
or
/// SourceAnalysis
to list the replacement datasets for the placeholders
/// listed in the original. The schema in each dataset must match its placeholder.
///
///
///
/// Either a SourceEntity
or a Definition
must be provided in
/// order for the request to be valid.
///
///
public TemplateSourceEntity SourceEntity
{
get { return this._sourceEntity; }
set { this._sourceEntity = value; }
}
// Check to see if SourceEntity property is set
internal bool IsSetSourceEntity()
{
return this._sourceEntity != null;
}
///
/// Gets and sets the property Tags.
///
/// Contains a map of the key-value pairs for the resource tag or tags assigned to the
/// resource.
///
///
[AWSProperty(Min=1, Max=200)]
public List Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
///
/// Gets and sets the property TemplateId.
///
/// An ID for the template that you want to create. This template is unique per Amazon
/// Web Services Region; in each Amazon Web Services account.
///
///
[AWSProperty(Required=true, Min=1, Max=512)]
public string TemplateId
{
get { return this._templateId; }
set { this._templateId = value; }
}
// Check to see if TemplateId property is set
internal bool IsSetTemplateId()
{
return this._templateId != null;
}
///
/// Gets and sets the property VersionDescription.
///
/// A description of the current template version being created. This API operation creates
/// the first version of the template. Every time UpdateTemplate
is called,
/// a new version is created. Each version of the template maintains a description of
/// the version in the VersionDescription
field.
///
///
[AWSProperty(Min=1, Max=512)]
public string VersionDescription
{
get { return this._versionDescription; }
set { this._versionDescription = value; }
}
// Check to see if VersionDescription property is set
internal bool IsSetVersionDescription()
{
return this._versionDescription != null;
}
}
}