Class AccessConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AccessConfiguration.Builder,
AccessConfiguration>
Access configuration parameters.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessType
The type of authentication used to access content fromHttpConfiguration::BaseUrl
on your source location.final String
The type of authentication used to access content fromHttpConfiguration::BaseUrl
on your source location.static AccessConfiguration.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
AWS Secrets Manager access token configuration parameters.static Class
<? extends AccessConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accessType
The type of authentication used to access content from
HttpConfiguration::BaseUrl
on your source location.S3_SIGV4
- AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.Before you can use
S3_SIGV4
, you must meet these requirements:• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AUTODETECT_SIGV4
- AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.Before you can use
AUTODETECT_SIGV4
with a MediaPackage Version 2 endpoint, you must meet these requirements:• You must grant MediaTailor access to your MediaPackage endpoint by granting
mediatailor.amazonaws.com
principal access in an Origin Access policy on the endpoint.• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
• The caller of the API must have
mediapackagev2:GetObject
IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.Before you can use
AUTODETECT_SIGV4
with an Amazon S3 bucket, you must meet these requirements:• You must grant MediaTailor access to your S3 bucket by granting
mediatailor.amazonaws.com
principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..• The
mediatailor.amazonaws.com
service principal must have permissions to read all top-level manifests referenced by theVodSource
packaging configurations.• The caller of the API must have
s3:GetObject
IAM permissions to read all top level manifests referenced by your MediaTailorVodSource
packaging configurations.If the service returns an enum value that is not available in the current SDK version,
accessType
will returnAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessTypeAsString()
.- Returns:
- The type of authentication used to access content from
HttpConfiguration::BaseUrl
on your source location.S3_SIGV4
- AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.Before you can use
S3_SIGV4
, you must meet these requirements:• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AUTODETECT_SIGV4
- AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.Before you can use
AUTODETECT_SIGV4
with a MediaPackage Version 2 endpoint, you must meet these requirements:• You must grant MediaTailor access to your MediaPackage endpoint by granting
mediatailor.amazonaws.com
principal access in an Origin Access policy on the endpoint.• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
• The caller of the API must have
mediapackagev2:GetObject
IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.Before you can use
AUTODETECT_SIGV4
with an Amazon S3 bucket, you must meet these requirements:• You must grant MediaTailor access to your S3 bucket by granting
mediatailor.amazonaws.com
principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..• The
mediatailor.amazonaws.com
service principal must have permissions to read all top-level manifests referenced by theVodSource
packaging configurations.• The caller of the API must have
s3:GetObject
IAM permissions to read all top level manifests referenced by your MediaTailorVodSource
packaging configurations. - See Also:
-
accessTypeAsString
The type of authentication used to access content from
HttpConfiguration::BaseUrl
on your source location.S3_SIGV4
- AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.Before you can use
S3_SIGV4
, you must meet these requirements:• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AUTODETECT_SIGV4
- AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.Before you can use
AUTODETECT_SIGV4
with a MediaPackage Version 2 endpoint, you must meet these requirements:• You must grant MediaTailor access to your MediaPackage endpoint by granting
mediatailor.amazonaws.com
principal access in an Origin Access policy on the endpoint.• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
• The caller of the API must have
mediapackagev2:GetObject
IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.Before you can use
AUTODETECT_SIGV4
with an Amazon S3 bucket, you must meet these requirements:• You must grant MediaTailor access to your S3 bucket by granting
mediatailor.amazonaws.com
principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..• The
mediatailor.amazonaws.com
service principal must have permissions to read all top-level manifests referenced by theVodSource
packaging configurations.• The caller of the API must have
s3:GetObject
IAM permissions to read all top level manifests referenced by your MediaTailorVodSource
packaging configurations.If the service returns an enum value that is not available in the current SDK version,
accessType
will returnAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessTypeAsString()
.- Returns:
- The type of authentication used to access content from
HttpConfiguration::BaseUrl
on your source location.S3_SIGV4
- AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.Before you can use
S3_SIGV4
, you must meet these requirements:• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AUTODETECT_SIGV4
- AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.Before you can use
AUTODETECT_SIGV4
with a MediaPackage Version 2 endpoint, you must meet these requirements:• You must grant MediaTailor access to your MediaPackage endpoint by granting
mediatailor.amazonaws.com
principal access in an Origin Access policy on the endpoint.• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
• The caller of the API must have
mediapackagev2:GetObject
IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.Before you can use
AUTODETECT_SIGV4
with an Amazon S3 bucket, you must meet these requirements:• You must grant MediaTailor access to your S3 bucket by granting
mediatailor.amazonaws.com
principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..• The
mediatailor.amazonaws.com
service principal must have permissions to read all top-level manifests referenced by theVodSource
packaging configurations.• The caller of the API must have
s3:GetObject
IAM permissions to read all top level manifests referenced by your MediaTailorVodSource
packaging configurations. - See Also:
-
secretsManagerAccessTokenConfiguration
AWS Secrets Manager access token configuration parameters.
- Returns:
- AWS Secrets Manager access token configuration parameters.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AccessConfiguration.Builder,
AccessConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-